com.mentata.sg8
Class SG8FilterAttribute

java.lang.Object
  extended bycom.mentata.l3d.L3DAttribute
      extended bycom.mentata.l3d.L3DDnAttribute
          extended bycom.mentata.sg8.SG8DnAttribute
              extended bycom.mentata.sg8.SG8FilterAttribute
All Implemented Interfaces:
Comparator, L3DGenerated, SG8Attribute

public class SG8FilterAttribute
extends SG8DnAttribute
implements L3DGenerated

A filter valued attribute for use with SG8 objects. This attribute type interprets the values of another attribute in the containing object as arguments for LDAP filters used against a defined target class and attribute. HTML values are translated to SG8 retrieve hyperlinks for matching entries.

Since:
0.7
Author:
Jon Roberts

Field Summary
static int CONTAINS
          A contains substring search.
static int ENDS
          An ends with substring search.
static int EQUALS
          An equality search.
static int STARTS
          A starts with substring search.
 
Fields inherited from interface com.mentata.sg8.SG8Attribute
TEXT_RESOURCES
 
Constructor Summary
SG8FilterAttribute(String filter, String object, String target)
          Constructs an empty OR filter attribute with a named target object and attribute.
SG8FilterAttribute(String filter, String object, String target, int search)
          Constructs an empty filter attribute with a named target object and attribute.
SG8FilterAttribute(String filter, String object, String target, int search, char operation)
          Constructs an empty filter attribute with a named target object and attribute.
 
Method Summary
 void generate()
          Generates values by searching the target attribute for the dn of the containing object.
 
Methods inherited from class com.mentata.sg8.SG8DnAttribute
getHTMLValues, getHyperlink, getMailTo, getSeparator, getSG8Object, getSG8Target, getUpdateHTML, isAugmenting, isHTMLExceeded, processUpdateHTML, setAugmenting, setHTMLThreshold, setSeparator
 
Methods inherited from class com.mentata.l3d.L3DDnAttribute
getShortValues, getTargetObject, initialize, isLengthExceeded, same
 
Methods inherited from class com.mentata.l3d.L3DAttribute
addValue, compare, getAttribute, getBind, getContext, getLabel, getLengthThreshold, getName, getObject, getObject, getPrerequisites, getSize, getThreshold, getValues, isBound, isExceeded, isGenerated, isMultivalue, isRequired, removeValue, setGenerated, setLabel, setLengthThreshold, setPrerequisites, setThreshold, setValues
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Comparator
equals
 

Field Detail

EQUALS

public static final int EQUALS
An equality search.

See Also:
Constant Field Values

STARTS

public static final int STARTS
A starts with substring search.

See Also:
Constant Field Values

ENDS

public static final int ENDS
An ends with substring search.

See Also:
Constant Field Values

CONTAINS

public static final int CONTAINS
A contains substring search.

See Also:
Constant Field Values
Constructor Detail

SG8FilterAttribute

public SG8FilterAttribute(String filter,
                          String object,
                          String target)
Constructs an empty OR filter attribute with a named target object and attribute.

Parameters:
filter - the attribute that contains the filter patterns
object - the target SG8 object name
target - the name of the target attribute to filter on

SG8FilterAttribute

public SG8FilterAttribute(String filter,
                          String object,
                          String target,
                          int search)
Constructs an empty filter attribute with a named target object and attribute.

Parameters:
filter - the attribute that contains the filter patterns
object - the target SG8 object name
target - the name of the target attribute to filter on
search - the type of search filter to use

SG8FilterAttribute

public SG8FilterAttribute(String filter,
                          String object,
                          String target,
                          int search,
                          char operation)
Constructs an empty filter attribute with a named target object and attribute.

Parameters:
filter - the attribute that contains the filter patterns
object - the target SG8 object name
target - the name of the target attribute to filter on
search - the type of search filter to use
operation - boolean operator for filter, either '&' or '|'
Method Detail

generate

public void generate()
Generates values by searching the target attribute for the dn of the containing object.

Specified by:
generate in interface L3DGenerated