|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.server.core.enumeration.SearchResultFilteringEnumeration
public class SearchResultFilteringEnumeration
A enumeration decorator which filters database search results as they are being enumerated back to the client caller.
SearchResultFilter
Constructor Summary | |
---|---|
SearchResultFilteringEnumeration(javax.naming.NamingEnumeration decorated,
javax.naming.directory.SearchControls searchControls,
Invocation invocation,
java.util.List filters)
Creates a new database result filtering enumeration to decorate an underlying enumeration. |
|
SearchResultFilteringEnumeration(javax.naming.NamingEnumeration decorated,
javax.naming.directory.SearchControls searchControls,
Invocation invocation,
SearchResultFilter filter)
Creates a new database result filtering enumeration to decorate an underlying enumeration. |
Method Summary | |
---|---|
boolean |
addResultFilter(SearchResultFilter filter)
Adds a database search result filter to this filtering enumeration at the very end of the filter list. |
void |
close()
|
java.util.List |
getFilters()
Gets an unmodifiable list of filters. |
boolean |
hasMore()
|
boolean |
hasMoreElements()
|
java.lang.Object |
next()
|
java.lang.Object |
nextElement()
|
boolean |
removeResultFilter(SearchResultFilter filter)
Removes a database search result filter from the filter list of this filtering enumeration. |
void |
requestAbandoned(org.apache.directory.shared.ldap.message.AbandonableRequest req)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SearchResultFilteringEnumeration(javax.naming.NamingEnumeration decorated, javax.naming.directory.SearchControls searchControls, Invocation invocation, SearchResultFilter filter) throws javax.naming.NamingException
decorated
- the underlying decorated enumerationsearchControls
- the search controls associated with the search
creating this enumerationinvocation
- the invocation representing the seach that created this enumeration
javax.naming.NamingException
public SearchResultFilteringEnumeration(javax.naming.NamingEnumeration decorated, javax.naming.directory.SearchControls searchControls, Invocation invocation, java.util.List filters) throws javax.naming.NamingException
decorated
- the underlying decorated enumerationsearchControls
- the search controls associated with the search
creating this enumerationinvocation
- the invocation representing the seach that created this enumeration
javax.naming.NamingException
Method Detail |
---|
public boolean addResultFilter(SearchResultFilter filter)
filter
- a filter to apply to the results
List.add(Object)
public boolean removeResultFilter(SearchResultFilter filter)
filter
- a filter to remove from the filter list
List.remove(Object)
public java.util.List getFilters()
Collections.unmodifiableList(List)
public void close() throws javax.naming.NamingException
close
in interface javax.naming.NamingEnumeration
javax.naming.NamingException
public boolean hasMore()
hasMore
in interface javax.naming.NamingEnumeration
public java.lang.Object next() throws javax.naming.NamingException
next
in interface javax.naming.NamingEnumeration
javax.naming.NamingException
public boolean hasMoreElements()
hasMoreElements
in interface java.util.Enumeration
public java.lang.Object nextElement()
nextElement
in interface java.util.Enumeration
public void requestAbandoned(org.apache.directory.shared.ldap.message.AbandonableRequest req)
requestAbandoned
in interface org.apache.directory.shared.ldap.message.AbandonListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |