You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2018/08/13 17:03:38 UTC
[directory-server] branch master updated: Fixed the xdbm-partition
javadoc errors and warnings
This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-server.git
The following commit(s) were added to refs/heads/master by this push:
new 4b2353d Fixed the xdbm-partition javadoc errors and warnings
4b2353d is described below
commit 4b2353d6ff2432814e81ebf39720538eb340ea64
Author: Emmanuel Lécharny <el...@symas.com>
AuthorDate: Mon Aug 13 19:03:31 2018 +0200
Fixed the xdbm-partition javadoc errors and warnings
---
.../impl/btree/AbstractBTreePartition.java | 145 +++++++++------------
.../impl/btree/ForwardIndexComparator.java | 8 +-
.../partition/impl/btree/IndexCursorAdaptor.java | 1 +
.../partition/impl/btree/KeyOnlyComparator.java | 8 +-
.../impl/btree/ReverseIndexComparator.java | 8 +-
.../core/partition/impl/btree/TupleComparator.java | 4 +-
.../directory/server/xdbm/AbstractIndex.java | 5 +-
.../org/apache/directory/server/xdbm/Index.java | 112 ++++++++++++++--
.../apache/directory/server/xdbm/IndexEntry.java | 2 +-
.../directory/server/xdbm/KeyTupleArrayCursor.java | 3 +-
.../directory/server/xdbm/ParentIdAndRdn.java | 3 +-
.../org/apache/directory/server/xdbm/Store.java | 61 ++++++---
.../org/apache/directory/server/xdbm/Table.java | 2 +-
.../directory/server/xdbm/search/Evaluator.java | 5 +-
.../directory/server/xdbm/search/Optimizer.java | 4 +-
.../server/xdbm/search/PartitionSearchResult.java | 8 +-
.../directory/server/xdbm/search/SearchEngine.java | 26 ++--
.../xdbm/search/cursor/AllEntriesCursor.java | 6 +-
.../server/xdbm/search/cursor/AndCursor.java | 3 +-
.../xdbm/search/cursor/ApproximateCursor.java | 8 +-
.../server/xdbm/search/cursor/ChildrenCursor.java | 8 +-
.../xdbm/search/cursor/DescendantCursor.java | 19 ++-
.../server/xdbm/search/cursor/EqualityCursor.java | 5 +-
.../server/xdbm/search/cursor/GreaterEqCursor.java | 7 +-
.../server/xdbm/search/cursor/LessEqCursor.java | 9 ++
.../server/xdbm/search/cursor/NotCursor.java | 11 +-
.../server/xdbm/search/cursor/OrCursor.java | 7 +
.../server/xdbm/search/cursor/PresenceCursor.java | 11 +-
.../server/xdbm/search/cursor/SubstringCursor.java | 9 ++
.../search/evaluator/ApproximateEvaluator.java | 3 +-
.../search/evaluator/BaseLevelScopeEvaluator.java | 12 +-
.../xdbm/search/evaluator/EmptyEvaluator.java | 1 -
.../xdbm/search/evaluator/EqualityEvaluator.java | 8 ++
.../xdbm/search/evaluator/GreaterEqEvaluator.java | 8 ++
.../xdbm/search/evaluator/LeafEvaluator.java | 7 +
.../xdbm/search/evaluator/LessEqEvaluator.java | 8 ++
.../server/xdbm/search/evaluator/NotEvaluator.java | 18 +++
.../search/evaluator/OneLevelScopeEvaluator.java | 10 +-
.../server/xdbm/search/evaluator/OrEvaluator.java | 18 +++
.../search/evaluator/PassThroughEvaluator.java | 3 +-
.../xdbm/search/evaluator/PresenceEvaluator.java | 22 ++++
.../xdbm/search/evaluator/SubstringEvaluator.java | 2 +-
.../search/evaluator/SubtreeScopeEvaluator.java | 37 +++---
.../server/xdbm/search/impl/DefaultOptimizer.java | 3 +-
.../xdbm/search/impl/DefaultSearchEngine.java | 2 +-
.../server/xdbm/search/impl/EvaluatorBuilder.java | 1 -
.../xdbm/search/impl/ScanCountComparator.java | 2 -
47 files changed, 456 insertions(+), 217 deletions(-)
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/AbstractBTreePartition.java b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/AbstractBTreePartition.java
index a3e06ab..a9b00f9 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/AbstractBTreePartition.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/AbstractBTreePartition.java
@@ -330,7 +330,7 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
* Sets the path in which this Partition stores data. This may be an URL to
* a file or directory, or an JDBC URL.
*
- * @param partitionDir the path in which this Partition stores data.
+ * @param partitionPath the path in which this Partition stores data.
*/
@Override
public void setPartitionPath( URI partitionPath )
@@ -363,6 +363,8 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* Sets up the system indices.
+ *
+ * @throws LdapException If the setup failed
*/
@SuppressWarnings("unchecked")
protected void setupSystemIndices() throws LdapException
@@ -451,6 +453,8 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* Sets up the user indices.
+ *
+ * @throws LdapException If the setup failed
*/
protected void setupUserIndices() throws LdapException
{
@@ -501,7 +505,7 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
*
* @param index the index
* @return the converted and initialized index
- * @throws Exception
+ * @throws LdapException If teh conversion failed
*/
protected abstract Index<?, String> convertAndInit( Index<?, String> index ) throws LdapException;
@@ -666,6 +670,16 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
}
+ /**
+ * Dump the RDN index content
+ *
+ * @param partitionTxn The transaction to use
+ * @param id The root ID
+ * @param tabs The space prefix
+ * @throws LdapException If we had an issue while dumping the Rdn index
+ * @throws CursorException If the cursor failed to browse the Rdn Index
+ * @throws IOException If we weren't able to read teh Rdn Index file
+ */
public void dumpRdnIdx( PartitionTxn partitionTxn, String id, String tabs ) throws LdapException, CursorException, IOException
{
// Start with the root
@@ -1035,9 +1049,11 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* Delete the entry associated with a given Id
+ *
+ * @param partitionTxn The transaction to use
* @param id The id of the entry to delete
* @return the deleted entry if found
- * @throws Exception If the deletion failed
+ * @throws LdapException If the deletion failed
*/
@Override
public Entry delete( PartitionTxn partitionTxn, String id ) throws LdapException
@@ -1270,9 +1286,10 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* Get back an entry knowing its UUID
*
+ * @param partitionTxn The transaction to use
* @param id The Entry UUID we want to get back
* @return The found Entry, or null if not found
- * @throws Exception If the lookup failed for any reason (except a not found entry)
+ * @throws LdapException If the lookup failed for any reason (except a not found entry)
*/
@Override
public Entry fetch( PartitionTxn partitionTxn, String id ) throws LdapException
@@ -1299,9 +1316,10 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* Get back an entry knowing its UUID
*
+ * @param partitionTxn The transaction to use
* @param id The Entry UUID we want to get back
* @return The found Entry, or null if not found
- * @throws Exception If the lookup failed for any reason (except a not found entry)
+ * @throws LdapException If the lookup failed for any reason (except a not found entry)
*/
@Override
public Entry fetch( PartitionTxn partitionTxn, String id, Dn dn ) throws LdapException
@@ -1460,6 +1478,7 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
* The entry is not persisted: it is only changed in anticipation for a put
* into the master table.
*
+ * @param partitionTxn The transaction to use
* @param id the primary key of the entry
* @param entry the entry to alter
* @param mods the attribute and values to add
@@ -1569,6 +1588,7 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
* is not persisted: it is only changed in anticipation for a put into the
* master table.
*
+ * @param partitionTxn The transaction to use
* @param id the primary key of the entry
* @param entry the entry to alter
* @param mods the replacement attribute and values
@@ -1712,6 +1732,7 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
* values within the entry where as an attribute w/ values will remove those
* attribute values it contains.
*
+ * @param partitionTxn The transaction to use
* @param id the primary key of the entry
* @param entry the entry to alter
* @param mods the attribute and its values to delete
@@ -2055,66 +2076,6 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
- * Implementation. We have many things to check first to see if the modification is possible :
- * <ul>
- * <li>The new superior must exist</li>
- * <li>The new Dn must not exist</li>
- * </ul>
- * (here, we assume the old entry exists)
- *
- * The next step is to process the RDN, accordingly to the deleteOldRdn flag.
- * {@inheritDoc}
- *
- @Override
- public final synchronized void moveAndRename( Dn oldDn, Dn newSuperiorDn, Rdn newRdn, Entry modifiedEntry,
- boolean deleteOldRdn ) throws Exception
- {
- String oldId = getEntryId( oldDn );
-
- // Check that the new superior exist
- String newSuperiorId = getEntryId( newSuperiorDn );
-
- if ( newSuperiorId == null )
- {
- // This is not allowed : the new superior must exist
- throw new LdapNoSuchObjectException(
- I18n.err( I18n.ERR_256_NO_SUCH_OBJECT, newSuperiorDn ) );
- }
-
- Dn newDn = newSuperiorDn.add( newRdn );
-
- // Now check that the new entry does not exist
- String newId = getEntryId( newDn );
-
- if ( newId != null )
- {
- // This is not allowed : we should not be able to move an entry
- // to an existing position
- throw new LdapEntryAlreadyExistsException(
- I18n.err( I18n.ERR_250_ENTRY_ALREADY_EXISTS, newSuperiorDn.getName() ) );
- }
-
- // First, rename
- // Get the old UUID
- if ( modifiedEntry == null )
- {
- modifiedEntry = master.get( oldId );
- }
-
- rename( oldId, newRdn, deleteOldRdn, modifiedEntry );
- //Rdn oldRdn = oldDn.getRdn();
- moveAndRename( oldDn, oldId, newSuperiorDn, newRdn, modifiedEntry );
-
- entryDnCache.removeAll();
-
- if ( isSyncOnWrite.get() )
- {
- sync();
- }
- }
-
-
- /**
* Moves an entry under a new parent. The operation causes a shift in the
* parent child relationships between the old parent, new parent and the
* child moved. All other descendant entries under the child never change
@@ -2124,14 +2085,15 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
* propagating down through the moved child and its descendants.
*
* @param oldDn the normalized dn of the child to be moved
- * @param childId the id of the child being moved
+ * @param newSuperiorDn the id of the child being moved
* @param newRdn the normalized dn of the new parent for the child
+ * @param modAvas The modified Avas
* @param modifiedEntry the modified entry
- * @throws Exception if something goes wrong
+ * @throws LdapException if something goes wrong
*/
@Override
- public void moveAndRename( PartitionTxn partitionTxn, Dn oldDn, Dn newSuperiorDn, Rdn newRdn, Map<String, List<ModDnAva>> modAvas,
- Entry modifiedEntry ) throws LdapException
+ public void moveAndRename( PartitionTxn partitionTxn, Dn oldDn, Dn newSuperiorDn, Rdn newRdn, Map<String,
+ List<ModDnAva>> modAvas, Entry modifiedEntry ) throws LdapException
{
// Get the child and the new parent to be entries and Ids
Attribute entryIdAt = modifiedEntry.get( SchemaConstants.ENTRY_UUID_AT );
@@ -2244,6 +2206,12 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* Update the index accordingly to the changed Attribute in the old and new RDN
+ *
+ * @param partitionTxn The transaction to use
+ * @param modAvs The modified AVAs
+ * @param entryId The Entry ID
+ * @throws {@link LdapException} If the AVA cannt be processed properly
+ * @throws IndexNotFoundException If teh index is not found
*/
private void processModifiedAvas( PartitionTxn partitionTxn, Map<String, List<ModDnAva>> modAvas, String entryId )
throws LdapException, IndexNotFoundException
@@ -2617,6 +2585,7 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* updates the CSN index
*
+ * @param partitionTxn The transaction to use
* @param entry the entry having entryCSN attribute
* @param id UUID of the entry
* @throws Exception
@@ -2635,9 +2604,10 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* builds the Dn of the entry identified by the given id
*
+ * @param partitionTxn The transaction to use
* @param id the entry's id
* @return the normalized Dn of the entry
- * @throws Exception
+ * @throws LdapException If we can't build the entry Dn
*/
protected Dn buildEntryDn( PartitionTxn partitionTxn, String id ) throws LdapException
{
@@ -2843,6 +2813,10 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* Retrieve the SuffixID
+ *
+ * @param partitionTxn The transaction to use
+ * @return The Suffix ID
+ * @throws LdapException If we weren't able to retrieve the Suffix ID
*/
public String getSuffixId( PartitionTxn partitionTxn ) throws LdapException
{
@@ -3153,14 +3127,16 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
* Adds userIndices for an aliasEntry to be added to the database while checking
* for constrained alias constructs like alias cycles and chaining.
*
+ * @param partitionTxn The transaction to use
* @param aliasDn normalized distinguished name for the alias entry
* @param aliasTarget the user provided aliased entry dn as a string
* @param aliasId the id of alias entry to add
* @throws LdapException if index addition fails, and if the alias is
* not allowed due to chaining or cycle formation.
- * @throws Exception if the wrappedCursor btrees cannot be altered
+ * @throws LdapException if the wrappedCursor btrees cannot be altered
*/
- protected void addAliasIndices( PartitionTxn partitionTxn, String aliasId, Dn aliasDn, Dn aliasTarget ) throws LdapException
+ protected void addAliasIndices( PartitionTxn partitionTxn, String aliasId, Dn aliasDn, Dn aliasTarget )
+ throws LdapException
{
String targetId; // Id of the aliasedObjectName
Dn ancestorDn; // Name of an alias entry relative
@@ -3265,10 +3241,11 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
* Removes the index entries for an alias before the entry is deleted from
* the master table.
*
- * @todo Optimize this by walking the hierarchy index instead of the name
+ * TODO Optimize this by walking the hierarchy index instead of the name
+ *
+ * @param partitionTxn The transaction to use
* @param aliasId the id of the alias entry in the master table
- * @throws LdapException if we cannot parse ldap names
- * @throws Exception if we cannot delete index values in the database
+ * @throws LdapException if we cannot delete index values in the database
*/
protected void dropAliasIndices( PartitionTxn partitionTxn, String aliasId ) throws LdapException
{
@@ -3330,8 +3307,9 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
* one and subtree alias index tuples for old ancestors above the moved base
* that will no longer be ancestors after the move.
*
+ * @param partitionTxn The transaction to use
* @param movedBase the base at which the move occurred - the moved node
- * @throws Exception if system userIndices fail
+ * @throws LdapException if system userIndices fail
*/
protected void dropMovedAliasIndices( PartitionTxn partitionTxn, Dn movedBase ) throws LdapException
{
@@ -3452,9 +3430,10 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
* Create a new Index for a given OID
*
* @param indexOid The Attribute OID
- * @param path The working directory where this indew will be stored
+ * @param path The working directory where this index will be stored
+ * @param withReverse If the Reverse index must be created or not
* @return The created index
- * @throws Exception If the index can't be created
+ * @throws LdapException If the index can't be created
*/
protected abstract Index createSystemIndex( String indexOid, URI path, boolean withReverse ) throws LdapException;
@@ -3613,8 +3592,6 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* {@inheritDoc}
- * @param partitionTxn
- * @return
*/
@Override
public String getContextCsn( PartitionTxn partitionTxn )
@@ -3631,7 +3608,7 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
* Loads the current context CSN present in the context entry of the partition
*
- * @throws LdapException
+ * @param partitionTxn The transaction to use
*/
protected void loadContextCsn( PartitionTxn partitionTxn )
{
@@ -3723,11 +3700,7 @@ public abstract class AbstractBTreePartition extends AbstractPartition implement
/**
- * Return the number of children and subordinates for a given entry
- *
- * @param dn The entry's DN
- * @return The Subordinate instance that contains the values.
- * @throws LdapException If we had an issue while processing the request
+ * {@inheritDoc}
*/
@Override
public Subordinates getSubordinates( PartitionTxn partitionTxn, Entry entry ) throws LdapException
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/ForwardIndexComparator.java b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/ForwardIndexComparator.java
index a32645a..30f4ecf 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/ForwardIndexComparator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/ForwardIndexComparator.java
@@ -72,12 +72,12 @@ public class ForwardIndexComparator<K> implements TupleComparator<K, Long>
/**
* Compares key Object to determine their sorting order returning a
- * value = to, < or > than 0.
+ * value = to, < or > than 0.
*
* @param key1 the first key to compare
* @param key2 the other key to compare to the first
* @return 0 if both are equal, a negative value less than 0 if the first
- * is less than the second, or a postive value if the first is greater than
+ * is less than the second, or a poistive value if the first is greater than
* the second byte array.
*/
public int compareKey( K key1, K key2 )
@@ -88,12 +88,12 @@ public class ForwardIndexComparator<K> implements TupleComparator<K, Long>
/**
* Comparse value Objects to determine their sorting order returning a
- * value = to, < or > than 0.
+ * value = to, < or > than 0.
*
* @param l1 the first Long value to compare
* @param l2 the other Long value to compare to the first
* @return 0 if both are equal, a negative value less than 0 if the first
- * is less than the second, or a postive value if the first is greater than
+ * is less than the second, or a positive value if the first is greater than
* the second Object.
*/
public int compareValue( Long l1, Long l2 )
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/IndexCursorAdaptor.java b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/IndexCursorAdaptor.java
index 4e362b4..9c9bb93 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/IndexCursorAdaptor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/IndexCursorAdaptor.java
@@ -61,6 +61,7 @@ public class IndexCursorAdaptor<K> extends AbstractIndexCursor<K>
* Creates an IndexCursorAdaptor which wraps and adapts a Cursor from a table to
* one which returns an IndexEntry.
*
+ * @param partitionTxn The transaction to use
* @param wrappedCursor the Cursor being adapted
* @param forwardIndex true for a cursor over a forward index, false for
* one over a reverse index
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/KeyOnlyComparator.java b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/KeyOnlyComparator.java
index d919819..9bfa545 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/KeyOnlyComparator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/KeyOnlyComparator.java
@@ -64,12 +64,12 @@ public class KeyOnlyComparator<K, V> implements TupleComparator<K, V>
/**
* Compares key Object to determine their sorting order returning a
- * value = to, < or > than 0.
+ * value = to, < or > than 0.
*
* @param key1 the first key to compare
* @param key2 the other key to compare to the first
* @return 0 if both are equal, a negative value less than 0 if the first
- * is less than the second, or a postive value if the first is greater than
+ * is less than the second, or a positive value if the first is greater than
* the second byte array.
*/
public int compareKey( K key1, K key2 )
@@ -80,12 +80,12 @@ public class KeyOnlyComparator<K, V> implements TupleComparator<K, V>
/**
* Comparse value Objects to determine their sorting order returning a
- * value = to, < or > than 0.
+ * value = to, < or > than 0.
*
* @param value1 the first value to compare
* @param value2 the other value to compare to the first
* @return 0 if both are equal, a negative value less than 0 if the first
- * is less than the second, or a postive value if the first is greater than
+ * is less than the second, or a positive value if the first is greater than
* the second Object.
*/
public int compareValue( V value1, V value2 )
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/ReverseIndexComparator.java b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/ReverseIndexComparator.java
index d84ffbf..65c06bc 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/ReverseIndexComparator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/ReverseIndexComparator.java
@@ -72,12 +72,12 @@ public class ReverseIndexComparator<V> implements TupleComparator<Long, V>
/**
* Compares key Object to determine their sorting order returning a
- * value = to, < or > than 0.
+ * value = to, < or > than 0.
*
* @param l1 the first long key to compare
* @param l2 the other long key to compare to the first
* @return 0 if both are equal, a negative value less than 0 if the first
- * is less than the second, or a postive value if the first is greater than
+ * is less than the second, or a positive value if the first is greater than
* the second byte array.
*/
public int compareKey( Long l1, Long l2 )
@@ -88,12 +88,12 @@ public class ReverseIndexComparator<V> implements TupleComparator<Long, V>
/**
* Comparse value Objects to determine their sorting order returning a
- * value = to, < or > than 0.
+ * value = to, < or > than 0.
*
* @param v1 the first value to compare
* @param v2 the other value to compare to the first
* @return 0 if both are equal, a negative value less than 0 if the first
- * is less than the second, or a postive value if the first is greater than
+ * is less than the second, or a positive value if the first is greater than
* the second Object.
*/
public int compareValue( V v1, V v2 )
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/TupleComparator.java b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/TupleComparator.java
index 6c6faf4..413ed85 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/TupleComparator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/TupleComparator.java
@@ -52,7 +52,7 @@ public interface TupleComparator<K, V> extends Serializable
/**
* Compares key Object to determine their sorting order returning a
- * value = to, < or > than 0.
+ * value = to, < or > than 0.
*
* @param key1 the first key to compare
* @param key2 the other key to compare to the first
@@ -65,7 +65,7 @@ public interface TupleComparator<K, V> extends Serializable
/**
* Comparse value Objects to determine their sorting order returning a
- * value = to, < or > than 0.
+ * value = to, < or > than 0.
*
* @param value1 the first value to compare
* @param value2 the other value to compare to the first
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/AbstractIndex.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/AbstractIndex.java
index 0e16bd2..0252c65 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/AbstractIndex.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/AbstractIndex.java
@@ -55,8 +55,6 @@ public abstract class AbstractIndex<K, E> implements Index<K, E>
/**
* Creates a new instance of AbstractIndex.
- *
- * @param attributeId the attribute ID
*/
protected AbstractIndex()
{
@@ -67,7 +65,7 @@ public abstract class AbstractIndex<K, E> implements Index<K, E>
/**
* Creates a new instance of AbstractIndex.
*
- * @param attributeId the attribute ID
+ * @param withReverse If we should create a reverse index
*/
protected AbstractIndex( boolean withReverse )
{
@@ -79,6 +77,7 @@ public abstract class AbstractIndex<K, E> implements Index<K, E>
* Creates a new instance of AbstractIndex.
*
* @param attributeId the attribute ID
+ * @param withReverse If we should create a reverse index
*/
protected AbstractIndex( String attributeId, boolean withReverse )
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Index.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Index.java
index 21c3421..de73c1e 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Index.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Index.java
@@ -38,7 +38,7 @@ import org.apache.directory.server.core.api.partition.PartitionTxn;
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @param <K> The Indexed value type, used to retrieve an element
- * @param <ID> The unique identifier type in the master table
+ * @param <E> The unique identifier type in the master table
*/
public interface Index<K, E>
{
@@ -116,8 +116,9 @@ public interface Index<K, E>
/**
* Gets the total scan count for this index.
*
+ * @param partitionTxn The transaction to use
* @return the number of key/value pairs in this index
- * @throws Exception on failure to access index db files
+ * @throws LdapException on failure to access index db files
*/
long count( PartitionTxn partitionTxn ) throws LdapException;
@@ -126,9 +127,10 @@ public interface Index<K, E>
* Gets the scan count for the occurrence of a specific attribute value
* within the index.
*
+ * @param partitionTxn The transaction to use
* @param attrVal the value of the attribute to get a scan count for
* @return the number of key/value pairs in this index with the value value
- * @throws Exception on failure to access index db files
+ * @throws LdapException on failure to access index db files
*/
long count( PartitionTxn partitionTxn, K attrVal ) throws LdapException;
@@ -170,7 +172,7 @@ public interface Index<K, E>
* Search for a value using the Reverse table
*
* @param partitionTxn The transaction to use
- * @param attrVal The key to retrieve
+ * @param element The key to retrieve
* @return The found value
* @throws LdapException If the operation failed
*/
@@ -181,9 +183,10 @@ public interface Index<K, E>
* Add an entry into the index, associated with the element E. The added
* value is the key to retrieve the element having the given ID.
*
+ * @param partitionTxn The transaction to use
* @param attrVal The added value
- * @param id The element ID pointed by the added value
- * @throws Exception If the addition can't be done
+ * @param entryId The entry ID pointed by the added value
+ * @throws LdapException If the addition can't be done
*/
void add( PartitionTxn partitionTxn, K attrVal, E entryId ) throws LdapException;
@@ -212,52 +215,141 @@ public interface Index<K, E>
* iterate through all those values to remove entryId from the associated
* list of entryIds.
*
+ * @param partitionTxn The transaction to use
* @param entryId The master table entryId to remove
- * @throws Exception
+ * @throws LdapException if we can't drop the element from the index
*/
void drop( PartitionTxn partitionTxn, E entryId ) throws LdapException;
/**
- * Remove the pair <K,ID> from the index for the given value and id.
+ * Remove the pair <K,ID> from the index for the given value and id.
*
+ * @param partitionTxn The transaction to use
* @param attrVal The value we want to remove from the index
- * @param id The associated ID
- * @throws Exception If the removal can't be done
+ * @param entryId The associated ID
+ * @throws LdapException If the removal can't be done
*/
void drop( PartitionTxn partitionTxn, K attrVal, E entryId ) throws LdapException;
+ /**
+ * Builds a Cursor on the Reverse index
+ *
+ * @param partitionTxn The transaction to use
+ * @return The created Cursor
+ * @throws LdapException If the cursor can't be created
+ */
Cursor<IndexEntry<K, E>> reverseCursor( PartitionTxn partitionTxn ) throws LdapException;
+ /**
+ * Builds a Cursor on the Forward index
+ *
+ * @param partitionTxn The transaction to use
+ * @return The created Cursor
+ * @throws LdapException If the cursor can't be created
+ */
Cursor<IndexEntry<K, E>> forwardCursor( PartitionTxn partitionTxn ) throws LdapException;
+ /**
+ * Builds a Cursor on the Reverse index, starting at a specific entry Id
+ *
+ * @param partitionTxn The transaction to use
+ * @param entryId The entry ID to start from
+ * @return The created Cursor
+ * @throws LdapException If the cursor can't be created
+ */
Cursor<IndexEntry<K, E>> reverseCursor( PartitionTxn partitionTxn, E entryId ) throws LdapException;
+ /**
+ * Builds a Cursor on the Forward index, starting at a specific key
+ *
+ * @param partitionTxn The transaction to use
+ * @param key The key to start from
+ * @return The created Cursor
+ * @throws LdapException If the cursor can't be created
+ */
Cursor<IndexEntry<K, E>> forwardCursor( PartitionTxn partitionTxn, K key ) throws LdapException;
+ /**
+ * Builds a Cursor on the Reverse index, starting at a specific entry Id
+ *
+ * @param partitionTxn The transaction to use
+ * @param entryId The entry ID to start from
+ * @return The created Cursor
+ * @throws LdapException If the cursor can't be created
+ */
Cursor<K> reverseValueCursor( PartitionTxn partitionTxn, E entryId ) throws LdapException;
+ /**
+ * Builds a Cursor on the Forward index, starting at a specific key
+ *
+ * @param partitionTxn The transaction to use
+ * @param key The key to start from
+ * @return The created Cursor
+ * @throws LdapException If the cursor can't be created
+ */
Cursor<E> forwardValueCursor( PartitionTxn partitionTxn, K key ) throws LdapException;
+ /**
+ * Try to move forward in the index
+ *
+ * @param partitionTxn The transaction to use
+ * @param attrVal The key we want to start with
+ * @return <tt>true</tt> if we can move forward
+ * @throws LdapException If we had an issue moving forward
+ */
boolean forward( PartitionTxn partitionTxn, K attrVal ) throws LdapException;
+ /**
+ * Try to move forward in the index
+ *
+ * @param partitionTxn The transaction to use
+ * @param attrVal The key we want to start with
+ * @param entryId The entry ID to start from
+ * @return <tt>true</tt> if we can move forward
+ * @throws LdapException If we had an issue moving forward
+ */
boolean forward( PartitionTxn partitionTxn, K attrVal, E entryId ) throws LdapException;
+ /**
+ * Try to move backward in the index
+ *
+ * @param partitionTxn The transaction to use
+ * @param entryId The entry we want to start with
+ * @return <tt>true</tt> if we can move backward
+ * @throws LdapException If we had an issue moving backward
+ */
boolean reverse( PartitionTxn partitionTxn, E entryId ) throws LdapException;
+ /**
+ * Try to move backward in the index
+ *
+ * @param partitionTxn The transaction to use
+ * @param entryId The entry ID to start from
+ * @param attrVal The key we want to start with
+ * @return <tt>true</tt> if we can move backward
+ * @throws LdapException If we had an issue moving backward
+ */
boolean reverse( PartitionTxn partitionTxn, E entryId, K attrVal ) throws LdapException;
+ /**
+ * Close and index
+ *
+ * @param partitionTxn The transaction to use
+ * @throws LdapException If we weren't able to close the index
+ * @throws IOException If we had an issue with the index file
+ */
void close( PartitionTxn partitionTxn ) throws LdapException, IOException;
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/IndexEntry.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/IndexEntry.java
index dedf540..c65c010 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/IndexEntry.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/IndexEntry.java
@@ -29,7 +29,7 @@ import org.apache.directory.api.ldap.model.entry.Entry;
* indexed Entry if one has already been loaded.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
- * @param <V> The key stored in the Tuple, associated key for the object
+ * @param <K> The key stored in the Tuple, associated key for the object
* @param <ID> The ID of the object
*/
public class IndexEntry<K, ID>
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/KeyTupleArrayCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/KeyTupleArrayCursor.java
index dc6022c..d445a3f 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/KeyTupleArrayCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/KeyTupleArrayCursor.java
@@ -132,7 +132,8 @@ public class KeyTupleArrayCursor<K, V> extends AbstractCursor<Tuple<K, V>>
* considered at all.
*
* @param element the valueTuple who's value is used to position this Cursor
- * @throws Exception if there are failures to position the Cursor
+ * @throws LdapException if there are failures to position the Cursor
+ * @throws CursorException if there are failures to position the Cursor
*/
public void before( Tuple<K, V> element ) throws LdapException, CursorException
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/ParentIdAndRdn.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/ParentIdAndRdn.java
index 7a5fad1..7cfe576 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/ParentIdAndRdn.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/ParentIdAndRdn.java
@@ -345,7 +345,8 @@ public class ParentIdAndRdn implements Externalizable, Comparable<ParentIdAndRdn
/**
* Sets the number of descendants this entry has
- * @param nbChildren The number of descendants
+ *
+ * @param nbDescendants The number of descendants
*/
public void setNbDescendants( int nbDescendants )
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Store.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Store.java
index 37a6826..f11c217 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Store.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Store.java
@@ -115,7 +115,7 @@ public interface Store
/**
* Sets the partition path (working directory) for the store.
*
- * @param partitionDir the new partition path
+ * @param partitionPath the new partition path
*/
void setPartitionPath( URI partitionPath );
@@ -197,6 +197,10 @@ public interface Store
/**
* Retrieve the SuffixID
+ *
+ * @param partitionTxn The transaction to use
+ * @return The suddix ID
+ * @throws LdapException If we can't get the suffix ID
*/
String getSuffixId( PartitionTxn partitionTxn ) throws LdapException;
@@ -220,33 +224,35 @@ public interface Store
/**
- * An iterator build on top of the User's index
+ * @return An iterator build on top of the User's index
*/
Iterator<String> getUserIndices();
/**
- * An iterator build on top of the System's index
+ * @return An iterator build on top of the System's index
*/
Iterator<String> getSystemIndices();
/**
* Tells if an index is already present in the User's <strong>or</strong> System's index list
- * @param id The index we are looking for
+ *
+ * @param attributeType The attributeType we are looking for
* @return <code>true</code> if the index is already present in the
* User's <strong>or</strong> System's index list
- * @throws Exception If something went wrong
+ * @throws LdapException If something went wrong
*/
boolean hasIndexOn( AttributeType attributeType ) throws LdapException;
/**
* Tells if an index is already present in the User's index list
+ *
* @param attributeType The attributeType index we are looking for
* @return <code>true</code> if the index is already present in the
* User's index list
- * @throws Exception If something went wrong
+ * @throws LdapException If something went wrong
*/
boolean hasUserIndexOn( AttributeType attributeType ) throws LdapException;
@@ -256,7 +262,7 @@ public interface Store
* @param attributeType The index we are looking for
* @return <code>true</code> if the index is already present in the
* System's index list
- * @throws Exception If something went wrong
+ * @throws LdapException If something went wrong
*/
boolean hasSystemIndexOn( AttributeType attributeType ) throws LdapException;
@@ -292,8 +298,11 @@ public interface Store
/**
* Gets the entry's id. Returns <code>null</code> if the Dn doesn't exist in this store.
* Note that the Dn must be normalized!
+ *
+ * @param partitionTxn The transaction to use
* @param dn the normalized entry Dn
* @return the entry's id, or <code>null</code> if the Dn doesn't exists
+ * @throws LdapException If we can't get the entry ID
*/
String getEntryId( PartitionTxn partitionTxn, Dn dn ) throws LdapException;
@@ -301,8 +310,10 @@ public interface Store
/**
* Gets the Entry's Dn identified by the given id.
*
+ * @param partitionTxn The transaction to use
* @param id the entry's id
* @return the entry's Dn
+ * @throws LdapException If we can't get the entry Dn
*/
Dn getEntryDn( PartitionTxn partitionTxn, String id ) throws LdapException;
@@ -311,9 +322,10 @@ public interface Store
* Gets the UUID of an entry's parent using the child entry's UUID.
* Note that the suffix entry returns 0, which does not map to any entry.
*
+ * @param partitionTxn The transaction to use
* @param childId the UUID of the entry
* @return the id of the parent entry or zero if the suffix entry UUID is used
- * @throws Exception on failures to access the underlying store
+ * @throws LdapException on failures to access the underlying store
*/
String getParentId( PartitionTxn partitionTxn, String childId ) throws LdapException;
@@ -321,8 +333,9 @@ public interface Store
/**
* Gets the total count of entries within this store.
*
+ * @param partitionTxn The transaction to use
* @return the total count of entries within this store
- * @throws Exception on failures to access the underlying store
+ * @throws LdapException on failures to access the underlying store
*/
long count( PartitionTxn partitionTxn ) throws LdapException;
@@ -330,9 +343,10 @@ public interface Store
/**
* Delete an entry from the store
*
+ * @param partitionTxn The transaction to use
* @param id The Entry UUID we want to delete
* @return the deleted entry if found
- * @throws Exception If the deletion failed for any reason
+ * @throws LdapException If the deletion failed for any reason
*/
Entry delete( PartitionTxn partitionTxn, String id ) throws LdapException;
@@ -340,9 +354,10 @@ public interface Store
/**
* Get back an entry knowing its UUID
*
+ * @param partitionTxn The transaction to use
* @param id The Entry UUID we want to get back
* @return The found Entry, or null if not found
- * @throws Exception If the lookup failed for any reason (except a not found entry)
+ * @throws LdapException If the lookup failed for any reason (except a not found entry)
*/
Entry fetch( PartitionTxn partitionTxn, String id ) throws LdapException;
@@ -350,10 +365,11 @@ public interface Store
/**
* Get back an entry knowing its UUID
*
+ * @param partitionTxn The transaction to use
* @param id The Entry UUID we want to get back
* @param dn The entry DN when we have it
* @return The found Entry, or null if not found
- * @throws Exception If the lookup failed for any reason (except a not found entry)
+ * @throws LdapException If the lookup failed for any reason (except a not found entry)
*/
Entry fetch( PartitionTxn partitionTxn, String id, Dn dn ) throws LdapException;
@@ -361,9 +377,10 @@ public interface Store
/**
* Gets the count of immediate children of the given entry UUID.
*
+ * @param partitionTxn The transaction to use
* @param id the entry UUID
* @return the child count
- * @throws Exception on failures to access the underlying store
+ * @throws LdapException on failures to access the underlying store
*/
long getChildCount( PartitionTxn partitionTxn, String id ) throws LdapException;
@@ -371,10 +388,11 @@ public interface Store
/**
* Modify an entry applying the given list of modifications.
*
+ * @param partitionTxn The transaction to use
* @param dn The Entry's Dn
* @param mods The list of modifications
* @return The modified entry
- * @throws Exception If the modification failed
+ * @throws LdapException If the modification failed
*/
Entry modify( PartitionTxn partitionTxn, Dn dn, Modification... mods ) throws LdapException;
@@ -390,11 +408,12 @@ public interface Store
* changed. The change propagates down the subtree rooted at the
* distinguished name specified.
*
+ * @param partitionTxn The transaction to use
* @param dn the normalized distinguished name of the entry to alter
* @param newRdn the new Rdn to set
* @param deleteOldRdn whether or not to remove the old Rdn attr/val
* @param entry the modified entry
- * @throws Exception if there are any errors propagating the name changes
+ * @throws LdapException if there are any errors propagating the name changes
*/
void rename( PartitionTxn partitionTxn, Dn dn, Rdn newRdn, boolean deleteOldRdn, Entry entry ) throws LdapException;
@@ -403,12 +422,13 @@ public interface Store
* Move and Rename operation. The entry is moved from one part of the DIT to another part of
* the DIT. Its RDN is also changed in the process.
*
+ * @param partitionTxn The transaction to use
* @param oldDn The previous DN
* @param newSuperiorDn The previous parent's DN
- * @param newDn The new DN
+ * @param newRdn The new DN
* @param modAvas The changed Attributes caused by the renaming (added and removed attributes)
- * @param entry the entry to move
- * @throws Exception If the modification failed
+ * @param modifiedEntry the entry to move
+ * @throws LdapException If the modification failed
*/
void moveAndRename( PartitionTxn partitionTxn, Dn oldDn, Dn newSuperiorDn, Rdn newRdn, Map<String, List<ModDnAva>> modAvas,
Entry modifiedEntry ) throws LdapException;
@@ -438,11 +458,12 @@ public interface Store
* <li>The moved entry must not inherit from a referral (already checked)
* </ul>
*
+ * @param partitionTxn The transaction to use
* @param oldDn The previous entry Dn
* @param newSuperior The new superior Dn
* @param newDn The new Dn
* @param entry The entry to move
- * @throws Exception If the move failed
+ * @throws LdapException If the move failed
*/
void move( PartitionTxn partitionTxn, Dn oldDn, Dn newSuperior, Dn newDn, Entry entry ) throws LdapException;
@@ -462,7 +483,7 @@ public interface Store
/**
* @return the Alias cache
- * @return
+ * @return The cache
*/
Cache getAliasCache();
}
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Table.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Table.java
index 5e47540..2f436d1 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Table.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Table.java
@@ -255,7 +255,7 @@ public interface Table<K, V>
* to a specific key. This Cursor is naturally limited to return only
* the tuples for the same key.
*
- * @param transaction The transaction we are running in
+ * @param partitionTxn The transaction we are running in
* @param key the duplicate key to return the Tuples of
* @return a Cursor over Tuples containing the same key
* @throws LdapException if there are failures accessing underlying stores
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/Evaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/Evaluator.java
index 3acba50..7a90753 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/Evaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/Evaluator.java
@@ -61,9 +61,10 @@ public interface Evaluator<N extends ExprNode>
* then need not access the store to retreive the entry if they need to
* access it's attributes.
*
+ * @param partitionTxn The transaction to use
* @param entry the index record of the entry to evaluate
* @return true if filter selects the candidate false otherwise
- * @throws Exception if there are faults during evaluation
+ * @throws LdapException if there are faults during evaluation
*/
boolean evaluate( PartitionTxn partitionTxn, IndexEntry<?, String> entry ) throws LdapException;
@@ -74,7 +75,7 @@ public interface Evaluator<N extends ExprNode>
*
* @param entry the candidate entry
* @return true if filter selects the candidate false otherwise
- * @throws Exception if there are faults during evaluation
+ * @throws LdapException if there are faults during evaluation
*/
boolean evaluate( Entry entry ) throws LdapException;
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/Optimizer.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/Optimizer.java
index 8b64182..32346e0 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/Optimizer.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/Optimizer.java
@@ -40,8 +40,10 @@ public interface Optimizer
/**
* Annotates the expression node tree for optimized traversal metrics.
*
+ * @param partitionTxn The transaction to use
* @param node the root of the expression node tree
- * @throws Exception if there are failures while optimizing
+ * @return The computed value for this node
+ * @throws LdapException if there are failures while optimizing
*/
Long annotate( PartitionTxn partitionTxn, ExprNode node ) throws LdapException;
}
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/PartitionSearchResult.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/PartitionSearchResult.java
index f2caf28..2f46dcc 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/PartitionSearchResult.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/PartitionSearchResult.java
@@ -59,6 +59,8 @@ public class PartitionSearchResult
/**
* Create a PartitionSearchResult instance
+ *
+ * @param schemaManager The SchemaManager instance
*/
public PartitionSearchResult( SchemaManager schemaManager )
{
@@ -76,11 +78,11 @@ public class PartitionSearchResult
/**
- * @param resultSet the resultSet to set
+ * @param set the resultSet to set
*/
public void setResultSet( Set<IndexEntry<String, String>> set )
{
- resultSet = new SetCursor<IndexEntry<String, String>>( set );
+ resultSet = new SetCursor<>( set );
}
@@ -94,7 +96,7 @@ public class PartitionSearchResult
/**
- * @param candidateSet the candidateSet to set
+ * @param set the candidateSet to set
*/
public void setCandidateSet( Set<String> set )
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/SearchEngine.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/SearchEngine.java
index d9cea09..0a33127 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/SearchEngine.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/SearchEngine.java
@@ -37,27 +37,31 @@ import org.apache.directory.server.core.api.partition.PartitionTxn;
public interface SearchEngine
{
/**
- * @todo put this in the right place
+ * TODO put this in the right place
* The alias dereferencing mode key for JNDI providers
*/
String ALIASMODE_KEY = JndiPropertyConstants.JNDI_LDAP_DAP_DEREF_ALIASES;
+
/**
- * @todo put this in the right place
+ * TODO put this in the right place
* The alias dereferencing mode value for JNDI providers
*/
String ALWAYS = "always";
+
/**
- * @todo put this in the right place
+ * TODO put this in the right place
* The alias dereferencing mode value for JNDI providers
*/
String NEVER = "never";
+
/**
- * @todo put this in the right place
+ * TODO put this in the right place
* The alias dereferencing mode value for JNDI providers
*/
String FINDING = "finding";
+
/**
- * @todo put this in the right place
+ * TODO put this in the right place
* The alias dereferencing mode value for JNDI providers
*/
String SEARCHING = "searching";
@@ -75,21 +79,23 @@ public interface SearchEngine
* Conducts a search on a database. It returns a set of UUID we found for the
* given filter.
*
- * @param The SchemaManager instance
+ * @param partitionTxn The transaction to use
+ * @param schemaManager The SchemaManager instance
* @param searchContext the search context
* @return A set of UUID representing the full result, up to he sizeLimit
- * @throws Exception if the search fails
+ * @throws LdapException if the search fails
*/
- PartitionSearchResult computeResult( PartitionTxn partitionTxn, SchemaManager schemaManager, SearchOperationContext searchContext )
- throws LdapException;
+ PartitionSearchResult computeResult( PartitionTxn partitionTxn, SchemaManager schemaManager,
+ SearchOperationContext searchContext ) throws LdapException;
/**
* Builds an Evaluator for a filter expression.
*
+ * @param partitionTxn The transaction to use
* @param filter the filter root AST node
* @return true if the filter passes the entry, false otherwise
- * @throws Exception if something goes wrong while accessing the db
+ * @throws LdapException if something goes wrong while accessing the db
*/
Evaluator<? extends ExprNode> evaluator( PartitionTxn partitionTxn, ExprNode filter ) throws LdapException;
}
\ No newline at end of file
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/AllEntriesCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/AllEntriesCursor.java
index a49ef64..139238f 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/AllEntriesCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/AllEntriesCursor.java
@@ -66,8 +66,10 @@ public class AllEntriesCursor extends AbstractIndexCursor<String>
/**
* Creates a new instance of AllEntriesCursor
- * @param store
- * @throws Exception
+ *
+ * @param partitionTxn The transaction to use
+ * @param store The Store instance
+ * @throws LdapException If we weren't able to create an instance of AllEntriesCursor
*/
public AllEntriesCursor( PartitionTxn partitionTxn, Store store ) throws LdapException
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/AndCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/AndCursor.java
index 1b7506a..d702d93 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/AndCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/AndCursor.java
@@ -68,8 +68,9 @@ public class AndCursor<V> extends AbstractIndexCursor<V>
* 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.
*
+ * @param partitionTxn The transaction to use
* @param wrapped The encapsulated IndexCursor
- * @param evaluators The list of evaluators associated wth the elements
+ * @param evaluators The list of evaluators associated with the elements
*/
public AndCursor( PartitionTxn partitionTxn, Cursor<IndexEntry<V, String>> wrapped,
List<Evaluator<? extends ExprNode>> evaluators )
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/ApproximateCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/ApproximateCursor.java
index 24deaa1..77775fc 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/ApproximateCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/ApproximateCursor.java
@@ -75,12 +75,16 @@ public class ApproximateCursor<V> extends AbstractIndexCursor<V>
/**
* Creates a new instance of ApproximateCursor
+ *
+ * @param partitionTxn The transaction to use
* @param store The Store we want to build a cursor on
* @param approximateEvaluator The evaluator
- * @throws Exception If the creation failed
+ * @throws LdapException If the creation failed
+ * @throws IndexNotFoundException If the index was not found
*/
@SuppressWarnings("unchecked")
- public ApproximateCursor( PartitionTxn partitionTxn, Store store, ApproximateEvaluator<V> approximateEvaluator ) throws LdapException, IndexNotFoundException
+ public ApproximateCursor( PartitionTxn partitionTxn, Store store, ApproximateEvaluator<V> approximateEvaluator )
+ throws LdapException, IndexNotFoundException
{
if ( IS_DEBUG )
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/ChildrenCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/ChildrenCursor.java
index b1334af..e3e3af6 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/ChildrenCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/ChildrenCursor.java
@@ -66,11 +66,13 @@ public class ChildrenCursor extends AbstractIndexCursor<String>
/**
* Creates a Cursor over entries satisfying one level scope criteria.
*
+ * @param partitionTxn The transaction to use
* @param db the entry store
- * @param evaluator an IndexEntry (candidate) evaluator
- * @throws Exception on db access failures
+ * @param parentId The parent ID
+ * @param cursor The wrapped cursor
*/
- public ChildrenCursor( PartitionTxn partitionTxn, Store db, String parentId, Cursor<IndexEntry<ParentIdAndRdn, String>> cursor )
+ public ChildrenCursor( PartitionTxn partitionTxn, Store db, String parentId,
+ Cursor<IndexEntry<ParentIdAndRdn, String>> cursor )
{
this.parentId = parentId;
this.cursor = cursor;
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/DescendantCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/DescendantCursor.java
index 91dcf62..91950d8 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/DescendantCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/DescendantCursor.java
@@ -87,11 +87,14 @@ public class DescendantCursor extends AbstractIndexCursor<String>
/**
* Creates a Cursor over entries satisfying one level scope criteria.
*
+ * @param partitionTxn The transaction to use
* @param db the entry store
- * @param evaluator an IndexEntry (candidate) evaluator
- * @throws Exception on db access failures
+ * @param baseId The base ID
+ * @param parentId The parent ID
+ * @param cursor The wrapped cursor
*/
- public DescendantCursor( PartitionTxn partitionTxn, Store db, String baseId, String parentId, Cursor<IndexEntry<ParentIdAndRdn, String>> cursor )
+ public DescendantCursor( PartitionTxn partitionTxn, Store db, String baseId, String parentId,
+ Cursor<IndexEntry<ParentIdAndRdn, String>> cursor )
{
this( partitionTxn, db, baseId, parentId, cursor, TOP_LEVEL );
}
@@ -100,11 +103,15 @@ public class DescendantCursor extends AbstractIndexCursor<String>
/**
* Creates a Cursor over entries satisfying one level scope criteria.
*
+ * @param partitionTxn The transaction to use
* @param db the entry store
- * @param evaluator an IndexEntry (candidate) evaluator
- * @throws Exception on db access failures
+ * @param baseId The base ID
+ * @param parentId The parent ID
+ * @param cursor The wrapped cursor
+ * @param topLevel If we are at the top level
*/
- public DescendantCursor( PartitionTxn partitionTxn, Store db, String baseId, String parentId, Cursor<IndexEntry<ParentIdAndRdn, String>> cursor, boolean topLevel )
+ public DescendantCursor( PartitionTxn partitionTxn, Store db, String baseId, String parentId,
+ Cursor<IndexEntry<ParentIdAndRdn, String>> cursor, boolean topLevel )
{
this.db = db;
currentParentId = parentId;
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/EqualityCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/EqualityCursor.java
index 9157172..92d605f 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/EqualityCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/EqualityCursor.java
@@ -73,9 +73,12 @@ public class EqualityCursor<V> extends AbstractIndexCursor<V>
/**
* Creates a new instance of an EqualityCursor
+ *
+ * @param partitionTxn The transaction to use
* @param store The store
* @param equalityEvaluator The EqualityEvaluator
- * @throws Exception If the creation failed
+ * @throws LdapException If the creation failed
+ * @throws IndexNotFoundException If the index was not found
*/
@SuppressWarnings("unchecked")
public EqualityCursor( PartitionTxn partitionTxn, Store store, EqualityEvaluator<V> equalityEvaluator )
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/GreaterEqCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/GreaterEqCursor.java
index e360159..9ec5078 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/GreaterEqCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/GreaterEqCursor.java
@@ -78,9 +78,12 @@ public class GreaterEqCursor<V> extends AbstractIndexCursor<V>
/**
* Creates a new instance of an GreaterEqCursor
+ *
+ * @param partitionTxn The transaction to use
* @param store The store
- * @param equalityEvaluator The GreaterEqEvaluator
- * @throws Exception If the creation failed
+ * @param greaterEqEvaluator The GreaterEqEvaluator
+ * @throws LdapException If the creation failed
+ * @throws IndexNotFoundException If the index was not found
*/
@SuppressWarnings("unchecked")
public GreaterEqCursor( PartitionTxn partitionTxn, Store store, GreaterEqEvaluator<V> greaterEqEvaluator )
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/LessEqCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/LessEqCursor.java
index a1087a0..b8272d7 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/LessEqCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/LessEqCursor.java
@@ -76,6 +76,15 @@ public class LessEqCursor<V> extends AbstractIndexCursor<V>
private IndexEntry<String, String> uuidCandidate;
+ /**
+ * Creates a new instance of an LessEqCursor
+ *
+ * @param partitionTxn The transaction to use
+ * @param store The store
+ * @param lessEqEvaluator The LessEqEvaluator
+ * @throws LdapException If the creation failed
+ * @throws IndexNotFoundException If the index was not found
+ */
@SuppressWarnings("unchecked")
public LessEqCursor( PartitionTxn partitionTxn, Store store, LessEqEvaluator<V> lessEqEvaluator )
throws LdapException, IndexNotFoundException
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/NotCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/NotCursor.java
index 80ffc68..fa335dc 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/NotCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/NotCursor.java
@@ -55,7 +55,16 @@ public class NotCursor<V> extends AbstractIndexCursor<V>
private final Evaluator<? extends ExprNode> childEvaluator;
- public NotCursor( PartitionTxn partitionTxn, Store store, Evaluator<? extends ExprNode> childEvaluator ) throws LdapException
+ /**
+ * Creates a new instance of an NotCursor
+ *
+ * @param partitionTxn The transaction to use
+ * @param store The store
+ * @param childEvaluator The inner evaluator
+ * @throws LdapException If the creation failed
+ */
+ public NotCursor( PartitionTxn partitionTxn, Store store, Evaluator<? extends ExprNode> childEvaluator )
+ throws LdapException
{
if ( IS_DEBUG )
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/OrCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/OrCursor.java
index e5294a0..0c0cbe6 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/OrCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/OrCursor.java
@@ -64,6 +64,13 @@ public class OrCursor<V> extends AbstractIndexCursor<V>
private IndexEntry<V, String> prefetched;
+ /**
+ * Creates a new instance of an OrCursor
+ *
+ * @param partitionTxn The transaction to use
+ * @param cursors The encapsulated Cursors
+ * @param evaluators The list of evaluators associated with the elements
+ */
// TODO - do same evaluator fail fast optimization that we do in AndCursor
public OrCursor( PartitionTxn partitionTxn, List<Cursor<IndexEntry<V, String>>> cursors,
List<Evaluator<? extends ExprNode>> evaluators )
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/PresenceCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/PresenceCursor.java
index 8dd4ed1..63c9386 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/PresenceCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/PresenceCursor.java
@@ -60,7 +60,16 @@ public class PresenceCursor extends AbstractIndexCursor<String>
private IndexEntry<String, String> prefetched;
- public PresenceCursor( PartitionTxn partitionTxn, Store store, PresenceEvaluator presenceEvaluator ) throws LdapException
+ /**
+ * Creates a new instance of an PresenceCursor
+ *
+ * @param partitionTxn The transaction to use
+ * @param store The store
+ * @param presenceEvaluator The Presence evaluator
+ * @throws LdapException If the cursor can't be created
+ */
+ public PresenceCursor( PartitionTxn partitionTxn, Store store, PresenceEvaluator presenceEvaluator )
+ throws LdapException
{
if ( IS_DEBUG )
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/SubstringCursor.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/SubstringCursor.java
index 6464d2a..b6d4477 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/SubstringCursor.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/cursor/SubstringCursor.java
@@ -60,6 +60,15 @@ public class SubstringCursor extends AbstractIndexCursor<String>
private final IndexEntry<String, String> indexEntry = new IndexEntry<>();
+ /**
+ * Creates a new instance of an SubstringCursor
+ *
+ * @param partitionTxn The transaction to use
+ * @param store The store
+ * @param substringEvaluator The SubstringEvaluator
+ * @throws LdapException If the creation failed
+ * @throws IndexNotFoundException If the index was not found
+ */
@SuppressWarnings("unchecked")
public SubstringCursor( PartitionTxn partitionTxn, Store store, final SubstringEvaluator substringEvaluator )
throws LdapException, IndexNotFoundException
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/ApproximateEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/ApproximateEvaluator.java
index 0e998fb..cdca842 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/ApproximateEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/ApproximateEvaluator.java
@@ -49,10 +49,11 @@ public class ApproximateEvaluator<T> extends LeafEvaluator<T>
{
/**
* Creates a new ApproximateEvaluator
+ *
* @param node The ApproximateNode
* @param db The Store
* @param schemaManager The SchemaManager
- * @throws Exception If the creation failed
+ * @throws LdapException If the creation failed
*/
public ApproximateEvaluator( ApproximateNode<T> node, Store db, SchemaManager schemaManager )
throws LdapException
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/BaseLevelScopeEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/BaseLevelScopeEvaluator.java
index 0dbde7e..7726c55 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/BaseLevelScopeEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/BaseLevelScopeEvaluator.java
@@ -53,9 +53,8 @@ public class BaseLevelScopeEvaluator<E> implements Evaluator<ScopeNode>
/**
* Creates a one level scope node Evaluator for search expressions.
*
- * @param node the scope node
* @param db the database used to evaluate scope node
- * @throws Exception on db access failure
+ * @param node the scope node
*/
public BaseLevelScopeEvaluator( Store db, ScopeNode node )
{
@@ -83,14 +82,9 @@ public class BaseLevelScopeEvaluator<E> implements Evaluator<ScopeNode>
/**
- * Asserts whether or not a candidate has one level scope while taking
- * alias dereferencing into account.
- *
- * @param candidate the candidate to assert
- * @return true if the candidate is within one level scope
- * @throws Exception if db lookups fail
- * @see org.apache.directory.server.xdbm.search.Evaluator#evaluate(IndexEntry)
+ * {@inheritDoc}
*/
+ @Override
public boolean evaluate( PartitionTxn partitionTxn, IndexEntry<?, String> indexEntry ) throws LdapException
{
Entry entry = indexEntry.getEntry();
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/EmptyEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/EmptyEvaluator.java
index f9f50a2..824dcdd 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/EmptyEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/EmptyEvaluator.java
@@ -37,7 +37,6 @@ public class EmptyEvaluator implements Evaluator<UndefinedNode>
{
/**
* Create a new instance of the PassThroughEvaluator
- * @throws Exception
*/
public EmptyEvaluator()
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/EqualityEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/EqualityEvaluator.java
index 445acf9..e334a7a 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/EqualityEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/EqualityEvaluator.java
@@ -47,6 +47,14 @@ import org.apache.directory.server.xdbm.Store;
*/
public class EqualityEvaluator<T> extends LeafEvaluator<T>
{
+ /**
+ * Creates a new EqualityEvaluator
+ *
+ * @param node The EqualityNode
+ * @param db The Store
+ * @param schemaManager The SchemaManager
+ * @throws LdapException If the creation failed
+ */
@SuppressWarnings("unchecked")
public EqualityEvaluator( EqualityNode<T> node, Store db, SchemaManager schemaManager )
throws LdapException
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/GreaterEqEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/GreaterEqEvaluator.java
index 3b90981..543ffca 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/GreaterEqEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/GreaterEqEvaluator.java
@@ -47,6 +47,14 @@ import org.apache.directory.server.xdbm.Store;
*/
public class GreaterEqEvaluator<T> extends LeafEvaluator<T>
{
+ /**
+ * Creates a new GreaterEqEvaluator
+ *
+ * @param node The GreaterEqNode
+ * @param db The Store
+ * @param schemaManager The SchemaManager
+ * @throws LdapException If the creation failed
+ */
@SuppressWarnings("unchecked")
public GreaterEqEvaluator( GreaterEqNode<T> node, Store db, SchemaManager schemaManager )
throws LdapException
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/LeafEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/LeafEvaluator.java
index 6bf1619..4d140e5 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/LeafEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/LeafEvaluator.java
@@ -61,6 +61,13 @@ public abstract class LeafEvaluator<T> implements Evaluator<SimpleNode<T>>
protected Index<T, String> idx;
+ /**
+ * Creates a new LeafEvaluator
+ *
+ * @param node The LeafNode
+ * @param db The Store
+ * @param schemaManager The SchemaManager
+ */
public LeafEvaluator( SimpleNode<T> node, Store db, SchemaManager schemaManager )
{
this.db = db;
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/LessEqEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/LessEqEvaluator.java
index 8a924d1..f28a101 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/LessEqEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/LessEqEvaluator.java
@@ -48,6 +48,14 @@ import org.apache.directory.server.xdbm.Store;
*/
public class LessEqEvaluator<T> extends LeafEvaluator<T>
{
+ /**
+ * Creates a new LessEqEvaluator
+ *
+ * @param node The LessEqNode
+ * @param db The Store
+ * @param schemaManager The SchemaManager
+ * @throws LdapException If the creation failed
+ */
@SuppressWarnings("unchecked")
public LessEqEvaluator( LessEqNode<T> node, Store db, SchemaManager schemaManager )
throws LdapException
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/NotEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/NotEvaluator.java
index 33efcaa..b051a64 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/NotEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/NotEvaluator.java
@@ -43,6 +43,12 @@ public class NotEvaluator implements Evaluator<NotNode>
private final Evaluator<? extends ExprNode> childEvaluator;
+ /**
+ * Creates a new NotEvaluator
+ *
+ * @param node The NotNode
+ * @param childEvaluator The included evaluator
+ */
public NotEvaluator( NotNode node, Evaluator<? extends ExprNode> childEvaluator )
{
this.node = node;
@@ -50,18 +56,30 @@ public class NotEvaluator implements Evaluator<NotNode>
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public boolean evaluate( Entry entry ) throws LdapException
{
return !childEvaluator.evaluate( entry );
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public boolean evaluate( PartitionTxn partitionTxn, IndexEntry<?, String> indexEntry ) throws LdapException
{
return !childEvaluator.evaluate( partitionTxn, indexEntry );
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public NotNode getExpression()
{
return node;
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/OneLevelScopeEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/OneLevelScopeEvaluator.java
index 3d7414b..3d33986 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/OneLevelScopeEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/OneLevelScopeEvaluator.java
@@ -57,7 +57,6 @@ public class OneLevelScopeEvaluator<E> implements Evaluator<ScopeNode>
*
* @param node the scope node
* @param db the database used to evaluate scope node
- * @throws Exception on db access failure
*/
public OneLevelScopeEvaluator( Store db, ScopeNode node )
{
@@ -90,14 +89,9 @@ public class OneLevelScopeEvaluator<E> implements Evaluator<ScopeNode>
/**
- * Asserts whether or not a candidate has one level scope while taking
- * alias dereferencing into account.
- *
- * @param candidate the candidate to assert
- * @return true if the candidate is within one level scope
- * @throws Exception if db lookups fail
- * @see org.apache.directory.server.xdbm.search.Evaluator#evaluate(IndexEntry)
+ * {@inheritDoc}
*/
+ @Override
public boolean evaluate( PartitionTxn partitionTxn, IndexEntry<?, String> indexEntry ) throws LdapException
{
ParentIdAndRdn parent = db.getRdnIndex().reverseLookup( partitionTxn, indexEntry.getId() );
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/OrEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/OrEvaluator.java
index 887a6d8..eafb0cc 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/OrEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/OrEvaluator.java
@@ -48,6 +48,12 @@ public class OrEvaluator implements Evaluator<OrNode>
private final OrNode node;
+ /**
+ * Creates a new OrEvaluator
+ *
+ * @param node The OrNode
+ * @param evaluators The inner evaluators
+ */
public OrEvaluator( OrNode node, List<Evaluator<? extends ExprNode>> evaluators )
{
this.node = node;
@@ -79,6 +85,10 @@ public class OrEvaluator implements Evaluator<OrNode>
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public boolean evaluate( PartitionTxn partitionTxn, IndexEntry<?, String> indexEntry ) throws LdapException
{
for ( Evaluator<?> evaluator : evaluators )
@@ -93,6 +103,10 @@ public class OrEvaluator implements Evaluator<OrNode>
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public boolean evaluate( Entry entry ) throws LdapException
{
for ( Evaluator<?> evaluator : evaluators )
@@ -107,6 +121,10 @@ public class OrEvaluator implements Evaluator<OrNode>
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public OrNode getExpression()
{
return node;
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/PassThroughEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/PassThroughEvaluator.java
index 8590b28..f537c2f 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/PassThroughEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/PassThroughEvaluator.java
@@ -42,7 +42,8 @@ public class PassThroughEvaluator implements Evaluator<UndefinedNode>
/**
* Create a new instance of the PassThroughEvaluator
- * @throws Exception
+ *
+ * @param db The Store instance
*/
public PassThroughEvaluator( Store db )
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/PresenceEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/PresenceEvaluator.java
index 24c995e..984cf26 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/PresenceEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/PresenceEvaluator.java
@@ -56,6 +56,13 @@ public class PresenceEvaluator implements Evaluator<PresenceNode>
private final SchemaManager schemaManager;
+ /**
+ * Creates a new PresenceEvaluator
+ *
+ * @param node The PresenceNode
+ * @param db The Store
+ * @param schemaManager The SchemaManager
+ */
public PresenceEvaluator( PresenceNode node, Store db, SchemaManager schemaManager )
{
this.db = db;
@@ -65,18 +72,29 @@ public class PresenceEvaluator implements Evaluator<PresenceNode>
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public PresenceNode getExpression()
{
return node;
}
+ /**
+ * @return the attributeType
+ */
public AttributeType getAttributeType()
{
return attributeType;
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
// TODO - determine if comparator and index entry should have the Value
// wrapper or the raw normalized value
public boolean evaluate( PartitionTxn partitionTxn, IndexEntry<?, String> indexEntry ) throws LdapException
@@ -101,6 +119,10 @@ public class PresenceEvaluator implements Evaluator<PresenceNode>
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
// TODO - determine if comaparator and index entry should have the Value
// wrapper or the raw normalized value
public boolean evaluate( Entry entry ) throws LdapException
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/SubstringEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/SubstringEvaluator.java
index c9e6e18..82f7b7b 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/SubstringEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/SubstringEvaluator.java
@@ -71,7 +71,7 @@ public class SubstringEvaluator implements Evaluator<SubstringNode>
* @param node the substring expression node
* @param db the database this evaluator uses
* @param schemaManager the schema manager
- * @throws Exception if there are failures accessing resources and the db
+ * @throws LdapException if there are failures accessing resources and the db
*/
public SubstringEvaluator( SubstringNode node, Store db, SchemaManager schemaManager ) throws LdapException
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/SubtreeScopeEvaluator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/SubtreeScopeEvaluator.java
index 28d2bfa..3ef79d3 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/SubtreeScopeEvaluator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/evaluator/SubtreeScopeEvaluator.java
@@ -72,9 +72,10 @@ public class SubtreeScopeEvaluator implements Evaluator<ScopeNode>
/**
* Creates a subtree scope node evaluator for search expressions.
*
- * @param node the scope node
+ * @param partitionTxn The transaction to use
* @param db the database used to evaluate scope node
- * @throws Exception on db access failure
+ * @param node the scope node
+ * @throws LdapException on db access failure
*/
public SubtreeScopeEvaluator( PartitionTxn partitionTxn, Store db, ScopeNode node ) throws LdapException
{
@@ -128,15 +129,9 @@ public class SubtreeScopeEvaluator implements Evaluator<ScopeNode>
/**
- * Asserts whether or not a candidate has sub level scope while taking
- * alias dereferencing into account.
- *
- * @param candidate the entry tested to see if it is in subtree scope
- * @return true if the candidate is within one level scope whether or not
- * alias dereferencing is enabled.
- * @throws Exception if the index lookups fail.
- * @see Evaluator#evaluate(org.apache.directory.server.xdbm.IndexEntry)
+ * {@inheritDoc}
*/
+ @Override
public boolean evaluate( PartitionTxn partitionTxn, IndexEntry<?, String> indexEntry ) throws LdapException
{
String id = indexEntry.getId();
@@ -190,7 +185,7 @@ public class SubtreeScopeEvaluator implements Evaluator<ScopeNode>
return false;
}
-}
+ }
else if ( null != db.getAliasIndex().reverseLookup( partitionTxn, id ) )
{
return false;
@@ -223,33 +218,37 @@ public class SubtreeScopeEvaluator implements Evaluator<ScopeNode>
/**
- * Asserts whether or not a candidate has sub level scope while taking
- * alias dereferencing into account.
- *
- * @param candidate the entry tested to see if it is in subtree scope
- * @return true if the candidate is within one level scope whether or not
- * alias dereferencing is enabled.
- * @throws Exception if the index lookups fail.
- * @see Evaluator#evaluate(org.apache.directory.server.xdbm.IndexEntry)
+ * {@inheritDoc}
*/
+ @Override
public boolean evaluate( Entry candidate ) throws LdapException
{
throw new UnsupportedOperationException( I18n.err( I18n.ERR_721 ) );
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public ScopeNode getExpression()
{
return node;
}
+ /**
+ * @return The base ID
+ */
public String getBaseId()
{
return baseId;
}
+ /**
+ * @return <tt>true</tt> if dereferencing
+ */
public boolean isDereferencing()
{
return dereferencing;
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/DefaultOptimizer.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/DefaultOptimizer.java
index aefbc03..5c36489 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/DefaultOptimizer.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/DefaultOptimizer.java
@@ -111,8 +111,9 @@ public class DefaultOptimizer implements Optimizer
* index on the attribute does not exist an IndexNotFoundException will be
* thrown.
*
- * @see org.apache.directory.server.xdbm.search.Optimizer#annotate(ExprNode)
+ * {@inheritDoc}
*/
+ @Override
@SuppressWarnings("unchecked")
public Long annotate( PartitionTxn partitionTxn, ExprNode node ) throws LdapException
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/DefaultSearchEngine.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/DefaultSearchEngine.java
index 81f8160..acf0806 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/DefaultSearchEngine.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/DefaultSearchEngine.java
@@ -303,7 +303,7 @@ public class DefaultSearchEngine implements SearchEngine
/**
- * @see SearchEngine#evaluator(ExprNode)
+ * {@inheritDoc}
*/
@Override
public Evaluator<? extends ExprNode> evaluator( PartitionTxn partitionTxn, ExprNode filter ) throws LdapException
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/EvaluatorBuilder.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/EvaluatorBuilder.java
index c6f6f30..1df6f34 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/EvaluatorBuilder.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/EvaluatorBuilder.java
@@ -74,7 +74,6 @@ public class EvaluatorBuilder
*
* @param db the database this evaluator operates upon
* @param schemaManager the schema manager
- * @throws Exception failure to access db or lookup schema in registries
*/
public EvaluatorBuilder( Store db, SchemaManager schemaManager )
{
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/ScanCountComparator.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/ScanCountComparator.java
index e14ac9e..f9d5579 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/ScanCountComparator.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/search/impl/ScanCountComparator.java
@@ -29,8 +29,6 @@ import org.apache.directory.server.xdbm.search.Evaluator;
* A helper class used to compare scan counts.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
- *
- * @param <ID> The type of element
*/
public class ScanCountComparator implements Comparator<Evaluator<?>>
{