|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface CqUserDb.SearchFilter
A collection of SearchKey/target-value pairs that collectively define the filter for selecting objects for inclusion in a full-text search. In general, an object must match all of the given keys in the filter to be added to the result set. The only exception to this rule are the CqRecordType keys. If more than one CqRecordType key is present, the object needs only match one of them to be a candidate for the result set--the object would need to match all the other types of keys to actually be selected.
Method Summary | ||
---|---|---|
|
add(CqUserDb.SearchKey<List<U>> key,
U targetItem)
Extends the target value list associated with a SearchKey by a single item. |
|
void |
clear()
Removes all SearchKey entries from this SearchFilter |
|
|
get(CqUserDb.SearchKey<U> key)
Returns the target value currently associated with a given SearchKey |
|
List<Map.Entry<CqUserDb.SearchKey<Object>,Object>> |
getAll()
|
|
List<Map.Entry<CqUserDb.DateLimit,Date>> |
getDateFilters()
|
|
|
getEntries(Class<U> type)
Retrieves SearchKey/target-value pairs of a given target-value type |
|
|
getEntriesByKey(Class<V> keyType)
Retrieves SearchKey/target-value pairs by SearchKey type |
|
List<Map.Entry<CqFieldDefinition,List<String>>> |
getFieldFilters()
|
|
List<Map.Entry<CqRecordType,Boolean>> |
getRecordTypeFilters()
|
|
Map.Entry<CqUserDb.SearchLevel,String> |
getStringFilter()
|
|
List<Map.Entry<CqUserDb.WordMode,List<String>>> |
getWordFilters()
|
|
|
put(CqUserDb.SearchKey<U> key,
U targetValue)
Adds a SearchKey and its target value to the full text search filter. |
Method Detail |
---|
<U> List<U> add(CqUserDb.SearchKey<List<U>> key, U targetItem)
U
- The type of item in a target value list; currently must be
String.key
- The SearchKey whose target value list is to be extended.
The SeachKey does not need to already be in the
SearchFilter. Currently the SearchKey must be a WordMode
enumerator or a CqFieldDefinition proxy.targetItem
- The new item to be added to the target value list
void clear()
<U> U get(CqUserDb.SearchKey<U> key)
U
- The data type used to specify the value against which the
key attribute will be compared. This type must match the
type parameter of the key used and so currently this must
be String, List<String>, Date, or Boolean.key
- A SearchKey object representing the attribute of each
candidate record that the search should filter on.
Currently this may be a SearchLevel enumerator, a
DateLimit enumerator, a WordMode enumerator, a
CqRecordType proxy, or a CqFieldDefinition proxy.
List<Map.Entry<CqUserDb.SearchKey<Object>,Object>> getAll()
List<Map.Entry<CqUserDb.DateLimit,Date>> getDateFilters()
<U> List<Map.Entry<CqUserDb.SearchKey<U>,U>> getEntries(Class<U> type)
U
- The data type used to specify the value against which the
key attribute will be compared. This type must match the
type parameter of a defined SearchKey and so currently
this must be String, List<String>, Date, or Boolean.type
- The Class object for the desired target-value data type.
<V extends CqUserDb.SearchKey<U>,U> List<Map.Entry<V,U>> getEntriesByKey(Class<V> keyType)
U
- The data type used to specify the value against which the
key attribute will be compared. This type must match the
type parameter of a defined SearchKey and so currently
this must be String, List<String>, Date, or Boolean.V
- A subclass of SearchKeykeyType
- The type of keys to retrieve from this search
specification
List<Map.Entry<CqFieldDefinition,List<String>>> getFieldFilters()
List<Map.Entry<CqRecordType,Boolean>> getRecordTypeFilters()
Map.Entry<CqUserDb.SearchLevel,String> getStringFilter()
List<Map.Entry<CqUserDb.WordMode,List<String>>> getWordFilters()
<U> U put(CqUserDb.SearchKey<U> key, U targetValue)
U
- The data type used to specify the target value. This type
must match the type parameter of the key used and so
currently this must be String, List<String>, Date, or
Boolean.key
- A SearchKey<U> object representing the attribute of
each candidate object that the search should filter on.
Currently this may be a SearchLevel enumerator, a
DateLimit enumerator, a WordMode enumerator, a
CqRecordType proxy, or a CqFieldDefinition proxy.targetValue
- An instance of class U that specifies which values
of the key attribute will select or reject a record in the
search. If this value is null (or Boolean.FALSE)
the corresponding SearchKey will be removed from the
search specification.
|
Generated Tue 13-Sep-2011 04:07 PM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |