org.apache.directory.server.xdbm.search.cursor

Class AndCursor<V>

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,String>>

org.apache.directory.server.xdbm.AbstractIndexCursor<V>

org.apache.directory.server.xdbm.search.cursor.AndCursor<V>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<IndexEntry<V,String>>, org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,String>>

public class AndCursor<V>
extends AbstractIndexCursor<V>

A Cursor returning candidates satisfying a logical conjunction expression.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.server.xdbm.AbstractIndexCursor

partitionTxn

Constructor Summary

Constructors

Constructor and Description
AndCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,String>> wrapped, List<Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode>> evaluators) Creates an instance of a AndCursor.

Method Summary

Modifier and Type	Method and Description
void	afterLast()
void	beforeFirst()
void	close()
void	close(Exception cause)
boolean	first()
IndexEntry<V,String>	get()
protected String	getUnsupportedMessage() Gets the message to return for operations that are not supported
boolean	last()
boolean	next(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
boolean	previous(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
String	toString()
String	toString(String tabs)

Methods inherited from class org.apache.directory.server.xdbm.AbstractIndexCursor

after, available, before, next, previous, setAvailable

Methods inherited from class org.apache.directory.api.ldap.model.cursor.AbstractCursor

checkNotClosed, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, iterator, setClosureMonitor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AndCursor

public AndCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                 org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,String>> wrapped,
                 List<Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode>> evaluators)

Creates an instance of a AndCursor. It wraps an index cursor and the list of evaluators associated with all the elements connected by the And.

Parameters:

partitionTxn - The transaction to use

wrapped - The encapsulated IndexCursor

evaluators - The list of evaluators associated with the elements

Method Detail

getUnsupportedMessage

protected String getUnsupportedMessage()

Gets the message to return for operations that are not supported

Specified by:

getUnsupportedMessage in class AbstractIndexCursor<V>

Returns:

The Unsupported message

beforeFirst

public void beforeFirst()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

afterLast

public void afterLast()
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

first

public boolean first()
              throws org.apache.directory.api.ldap.model.exception.LdapException,
                     org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

last

public boolean last()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

previous

public boolean previous(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

next

public boolean next(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

get

public IndexEntry<V,String> get()
                         throws org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.cursor.CursorException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,String>>

Throws:

IOException

close

public void close(Exception cause)
           throws IOException

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,String>>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,String>>

Throws:

IOException

toString

public String toString(String tabs)

Specified by:

toString in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,String>>

Overrides:

toString in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,String>>

See Also:

Object.toString()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()