| java.lang.Object
 com.sun.addressbook.ABSearchTerm
All known Subclasses: com.sun.ssoadapter.ab.pim.JPimABSearchTerm, com.sun.addressbook.ldap.LdapABSearchTerm, com.sun.addressbook.wabp.WabpABSearchTerm,
| ABSearchTerm | | abstract public class ABSearchTerm (Code) | | Address Book Filter Search Term represents a search term like "ln=doe".
The search terms can be nested in a tree structure and combined with
an 'and' or an 'or' e.g. "ln=doe & (fn=john | fn=joe)".
|
| Field Summary | |
| final public static int | AND
| | final public static int | NOT
| | final public static int | NO_OP
| | final public static int | OR
| | protected boolean | exact
Default search is carried out as an exact search. | | protected String | name
Name of the attribute to search on. | | protected boolean | not
| | protected int | op
Operator binding the recursive searchTerms in this instance of ABSearchTerm. | | protected ABSearchTerm[] | terms
ABSearchTerm array which stores the recursive ABSearchTerms. | | protected String | value
Value of the attribute to search. |
| Method Summary | |
| abstract public Object | compute()
Abstract method. | | public String | getName()
Get the name of the attribute to search on. | | public int | getOp()
Get the value of the operator binding the recursive searchTerms
Present only in case the ABSearchTerm is not an end node. | | public ABSearchTerm[] | getTerms()
Get the ABSearchTerm array which stores the recursive ABSearchTerms. | | public String | getValue()
Get the value of the attribute to search. | | public boolean | isExact()
Return the value of the exact boolean indicating whether
the search is exact or approximate. | | public void | setExact(boolean exact)
Set the value of the exact boolean indicating whether
the search is exact or approximate. | | public void | setName(String name)
Set the name of the attribute to search on. | | public void | setNot(boolean not)
| | public void | setOp(int op)
Set the value of the operator binding the recursive searchTerms
Present only in case the ABSearchTerm is not an end node. | | public void | setValue(String value)
Set the value of the attribute to search. |
| AND | | final public static int AND(Code) | | |
| NOT | | final public static int NOT(Code) | | |
| NO_OP | | final public static int NO_OP(Code) | | Values for operators
|
| OR | | final public static int OR(Code) | | |
| exact | | protected boolean exact(Code) | | Default search is carried out as an exact search. Can be set to
'contains' search like '*str*' in ldap by setting exact to false.
|
| name | | protected String name(Code) | | Name of the attribute to search on.
|
| not | | protected boolean not(Code) | | Boolean indicating the relationship between name and value
|
| op | | protected int op(Code) | | Operator binding the recursive searchTerms in this instance of ABSearchTerm.
|
| terms | | protected ABSearchTerm[] terms(Code) | | ABSearchTerm array which stores the recursive ABSearchTerms.
|
| value | | protected String value(Code) | | Value of the attribute to search.
|
| ABSearchTerm | | public ABSearchTerm(String name, String value, boolean exact)(Code) | | Initializes the search term object. This constructor indicates this search term
is an end node and does not contain recursive search terms.
Parameters:
name - Name of the attribute to search on.
Parameters:
value - Value of the attribute to search.
Parameters:
exact - Boolean indicating whether search is 'exact'(true) or'contains'(false). |
| ABSearchTerm | | public ABSearchTerm(ABSearchTerm term, int op) throws ABStoreException(Code) | | Initializes the search term object. This constructor is used for the unary
operator NOT on the ABSearchTerm. Usage of this constructor means that ABSearchTerm
is recursive and is not the end node, and it will contain terms, op and not name,
value.
Parameters:
The - recursive ABSearchTerm.
Parameters:
Operator - binding the recursive searchTerms. The value can only be NOT. |
| ABSearchTerm | | public ABSearchTerm(ABSearchTerm[] terms, int op) throws ABStoreException(Code) | | Initializes the search term object. This constructor is used for the binary
operators like AND and OR on the ABSearchTerms array. Usage of this constructor
means that ABSearchTerm is recursive and is not the end node, and it will
contain terms, op and not name, value.
Parameters:
The - recursive ABSearchTerm array.
Parameters:
Operator - binding the recursive searchTerms. The values can be AND or OR. |
| compute | | abstract public Object compute() throws ABStoreException(Code) | | Abstract method. The adapters compute the value of the search term following
the recursive search terms to the end node.
search filter object to base the search on. |
| getName | | public String getName()(Code) | | Get the name of the attribute to search on.
name Name of the attribute to search on. |
| getOp | | public int getOp()(Code) | | Get the value of the operator binding the recursive searchTerms
Present only in case the ABSearchTerm is not an end node.
op - int |
| getTerms | | public ABSearchTerm[] getTerms()(Code) | | Get the ABSearchTerm array which stores the recursive ABSearchTerms.
Present only in case the ABSearchTerm is not an end node.
terms |
| getValue | | public String getValue()(Code) | | Get the value of the attribute to search.
value Value of the attribute to search. |
| isExact | | public boolean isExact()(Code) | | Return the value of the exact boolean indicating whether
the search is exact or approximate.
exact Boolean indicating whether search is exactor contains. |
| setExact | | public void setExact(boolean exact)(Code) | | Set the value of the exact boolean indicating whether
the search is exact or approximate.
Parameters:
exact - Boolean indicating whether search is exactor contains. |
| setName | | public void setName(String name)(Code) | | Set the name of the attribute to search on.
Parameters:
name - Name of the attribute to search on. |
| setNot | | public void setNot(boolean not)(Code) | | Set the value of the not boolean indicating the relationship between name and value
Parameters:
not - Boolean indicating the relationship between name and value |
| setOp | | public void setOp(int op)(Code) | | Set the value of the operator binding the recursive searchTerms
Present only in case the ABSearchTerm is not an end node.
Parameters:
op - - int |
| setValue | | public void setValue(String value)(Code) | | Set the value of the attribute to search.
Parameters:
value - Value of the attribute to search. |
|
|