|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.server.core.filtering.BaseEntryFilteringCursor
public class BaseEntryFilteringCursor
A Cursor which uses a list of filters to selectively return entries and/or modify the contents of entries. Uses lazy pre-fetching on positioning operations which means adding filters after creation will not miss candidate entries.
Constructor Summary | |
---|---|
BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped,
SearchingOperationContext operationContext)
Creates a new entry filtering Cursor over an existing Cursor using a no filter initially: more can be added later after creation. |
|
BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped,
SearchingOperationContext operationContext,
EntryFilter filter)
Creates a new entry filtering Cursor over an existing Cursor using a single filter initially: more can be added later after creation. |
|
BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped,
SearchingOperationContext operationContext,
java.util.List<EntryFilter> filters)
Creates a new entry filtering Cursor over an existing Cursor using a list of filters initially: more can be added later after creation. |
Method Summary | |
---|---|
boolean |
addEntryFilter(EntryFilter filter)
Adds an entry filter to this BaseEntryFilteringCursor at the very end of the filter list. |
void |
after(ClonedServerEntry element)
|
void |
afterLast()
|
boolean |
available()
|
void |
before(ClonedServerEntry element)
|
void |
beforeFirst()
|
void |
close()
|
void |
close(java.lang.Exception reason)
|
boolean |
first()
|
ClonedServerEntry |
get()
|
java.util.List<EntryFilter> |
getEntryFilters()
Gets an unmodifiable list of EntryFilters applied. |
SearchingOperationContext |
getOperationContext()
|
boolean |
isAbandoned()
Gets whether or not this BaseEntryFilteringCursor has been abandoned. |
boolean |
isClosed()
|
boolean |
isElementReused()
|
java.util.Iterator<ClonedServerEntry> |
iterator()
|
boolean |
last()
|
boolean |
next()
|
boolean |
previous()
|
boolean |
removeEntryFilter(EntryFilter filter)
Removes an entry filter to this BaseEntryFilteringCursor at the very end of the filter list. |
void |
setAbandoned(boolean abandoned)
Sets whether this BaseEntryFilteringCursor has been abandoned. |
void |
setClosureMonitor(org.apache.directory.shared.ldap.cursor.ClosureMonitor monitor)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped, SearchingOperationContext operationContext, EntryFilter filter)
wrapped
- the underlying wrapped Cursor whose entries are filteredsearchControls
- the controls of search that created this Cursorinvocation
- the search operation invocation creating this Cursorfilter
- a single filter to be usedpublic BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped, SearchingOperationContext operationContext)
wrapped
- the underlying wrapped Cursor whose entries are filteredsearchControls
- the controls of search that created this Cursorinvocation
- the search operation invocation creating this Cursorfilter
- a single filter to be usedpublic BaseEntryFilteringCursor(org.apache.directory.shared.ldap.cursor.Cursor<org.apache.directory.shared.ldap.entry.ServerEntry> wrapped, SearchingOperationContext operationContext, java.util.List<EntryFilter> filters)
wrapped
- the underlying wrapped Cursor whose entries are filteredoperationContext
- the operation context that created this Cursorinvocation
- the search operation invocation creating this Cursorfilters
- a list of filters to be usedMethod Detail |
---|
public boolean isAbandoned()
EntryFilteringCursor
isAbandoned
in interface EntryFilteringCursor
public void setAbandoned(boolean abandoned)
EntryFilteringCursor
setAbandoned
in interface EntryFilteringCursor
abandoned
- true if abandoned, false if notpublic boolean addEntryFilter(EntryFilter filter)
EntryFilteringCursor
addEntryFilter
in interface EntryFilteringCursor
filter
- a filter to apply to the entries
List.add(Object)
public boolean removeEntryFilter(EntryFilter filter)
EntryFilteringCursor
removeEntryFilter
in interface EntryFilteringCursor
filter
- a filter to remove from the filter list
List.remove(Object)
public java.util.List<EntryFilter> getEntryFilters()
EntryFilteringCursor
getEntryFilters
in interface EntryFilteringCursor
public SearchingOperationContext getOperationContext()
getOperationContext
in interface EntryFilteringCursor
public void after(ClonedServerEntry element) throws java.lang.Exception
after
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public void afterLast() throws java.lang.Exception
afterLast
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean available()
available
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
public void before(ClonedServerEntry element) throws java.lang.Exception
before
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public void beforeFirst() throws java.lang.Exception
beforeFirst
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public void close() throws java.lang.Exception
close
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public void close(java.lang.Exception reason) throws java.lang.Exception
close
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public final void setClosureMonitor(org.apache.directory.shared.ldap.cursor.ClosureMonitor monitor)
setClosureMonitor
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
public boolean first() throws java.lang.Exception
first
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public ClonedServerEntry get() throws java.lang.Exception
get
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean isClosed() throws java.lang.Exception
isClosed
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean isElementReused()
isElementReused
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
public boolean last() throws java.lang.Exception
last
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean next() throws java.lang.Exception
next
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public boolean previous() throws java.lang.Exception
previous
in interface org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>
java.lang.Exception
public java.util.Iterator<ClonedServerEntry> iterator()
iterator
in interface java.lang.Iterable<ClonedServerEntry>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |