From 22094368c2865dcfb6daf8366425212b721a4657 Mon Sep 17 00:00:00 2001
From: matthew_swift <matthew_swift@localhost>
Date: Thu, 05 Feb 2009 17:42:14 +0000
Subject: [PATCH] Merge ASN1 branch to trunk
---
opends/src/server/org/opends/server/api/ExtensibleIndexer.java | 72 ++++++++++++++++++++++--------------
1 files changed, 44 insertions(+), 28 deletions(-)
diff --git a/opends/src/server/org/opends/server/api/ExtensibleIndexer.java b/opends/src/server/org/opends/server/api/ExtensibleIndexer.java
index 47edcc2..a7c6584 100644
--- a/opends/src/server/org/opends/server/api/ExtensibleIndexer.java
+++ b/opends/src/server/org/opends/server/api/ExtensibleIndexer.java
@@ -26,20 +26,25 @@
*/
package org.opends.server.api;
+
+
import java.util.Map;
import java.util.Set;
+
import org.opends.server.types.AttributeValue;
+
+
/**
- * This class is registered with a Backend and it provides call-
- * backs for indexing attribute values. An index implementation will
- * use this interface to create the keys for an attribute value.
+ * This class is registered with a Backend and it provides call- backs
+ * for indexing attribute values. An index implementation will use
+ * this interface to create the keys for an attribute value.
*/
@org.opends.server.types.PublicAPI(
- stability=org.opends.server.types.StabilityLevel.VOLATILE,
- mayInstantiate=false,
- mayExtend=true,
- mayInvoke=false)
+ stability = org.opends.server.types.StabilityLevel.VOLATILE,
+ mayInstantiate = false,
+ mayExtend = true,
+ mayInvoke = false)
public abstract class ExtensibleIndexer
{
/**
@@ -47,46 +52,57 @@
* appended with the identifier returned from
* {@link #getExtensibleIndexID()} will be used as the index
* database name.
- * @return The name of the index for this indexer.
+ *
+ * @return The name of the index for this indexer.
*/
public abstract String getPreferredIndexName();
+
/**
* Returns an index identifier associated with this indexer. An
- * identifier should be selected based on the matching rule type.
- * A unique identifier will map to a unique index database in
- * the backend implementation. If multiple matching rules
- * need to share the index database, the corresponding indexers
- * should always use the same identifier.
- * @return index ID A String containing the ID associated with
- * this indexer.
+ * identifier should be selected based on the matching rule type. A
+ * unique identifier will map to a unique index database in the
+ * backend implementation. If multiple matching rules need to share
+ * the index database, the corresponding indexers should always use
+ * the same identifier.
+ *
+ * @return index ID A String containing the ID associated with this
+ * indexer.
*/
public abstract String getExtensibleIndexID();
+
/**
* Generates the set of index keys for an attribute.
- * @param value The attribute value for which keys are required.
- * @param keys The set into which the generated keys will be
- * inserted.
+ *
+ * @param value
+ * The attribute value for which keys are required.
+ * @param keys
+ * The set into which the generated keys will be inserted.
*/
public abstract void getKeys(AttributeValue value,
- Set<byte[]> keys);
+ Set<byte[]> keys);
+
/**
* Generates a map of index keys and a boolean flag indicating
* whether the corresponding key will be inserted or deleted.
- * @param value The attribute for which keys are required.
- * @param modifiedKeys A map containing the keys and a boolean.
- * Keys corresponding to the boolean value <code>true
- * </code> should be inserted and <code>false</code>
- * should be deleted.
- * @param insert <code>true</code> if generated keys should
- * be inserted or <code>false</code> otherwise.
+ *
+ * @param value
+ * The attribute for which keys are required.
+ * @param modifiedKeys
+ * A map containing the keys and a boolean. Keys
+ * corresponding to the boolean value <code>true
+ * </code>
+ * should be inserted and <code>false</code> should be
+ * deleted.
+ * @param insert
+ * <code>true</code> if generated keys should be inserted
+ * or <code>false</code> otherwise.
*/
public abstract void getKeys(AttributeValue value,
- Map<byte[], Boolean> modifiedKeys,
- Boolean insert);
+ Map<byte[], Boolean> modifiedKeys, Boolean insert);
}
\ No newline at end of file
--
Gitblit v1.10.0