OrderingIndexer.java revision b4851fc75ef4634840dcbadec085d586d36b434d
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying * information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Portions Copyright 2006 Sun Microsystems, Inc.
*/
/**
* An implementation of an Indexer for attribute ordering.
*/
public class OrderingIndexer extends Indexer
{
/**
* The fully-qualified name of this class for debugging purposes.
*/
private static final String CLASS_NAME =
"org.opends.server.backends.jeb.OrderingIndexer";
/**
* The attribute index configuration for which this instance will
* generate index keys.
*/
private IndexConfig indexConfig;
/**
* The attribute type ordering matching rule which is also the
* comparator for the index keys generated by this class.
*/
private OrderingMatchingRule orderingRule;
/**
* Create a new attribute ordering indexer for the given index configuration.
* @param indexConfig The index configuration for which an indexer is
* required.
*/
{
this.indexConfig = indexConfig;
}
/**
* Get a string representation of this object. The returned value is
* used to name an index created using this object.
* @return A string representation of this object.
*/
{
}
/**
* Get the comparator that must be used to compare index keys
* generated by this class.
*
* @return A byte array comparator.
*/
public Comparator<byte[]> getComparator()
{
return orderingRule;
}
/**
* Generate the set of index keys for an entry.
*
* @param txn A database transaction to be used if the database need to be
* accessed in the course of generating the index keys.
* @param entry The entry.
* @param keys The set into which the generated keys will be inserted.
*/
{
{
}
}
/**
* Generate the set of index keys to be added and the set of index keys
* to be deleted for an entry that has been replaced.
*
* @param txn A database transaction to be used if the database need to be
* accessed in the course of generating the index keys.
* @param oldEntry The original entry contents.
* @param newEntry The new entry contents.
* @param addKeys The set into which the keys to be added will be inserted.
* @param delKeys The set into which the keys to be deleted will be inserted.
*/
{
for (ASN1OctetString k : removeSet)
{
}
for (ASN1OctetString k : addSet)
{
}
}
/**
* Generate the set of index keys to be added and the set of index keys
* to be deleted for an entry that was modified.
*
* @param txn A database transaction to be used if the database need to be
* accessed in the course of generating the index keys.
* @param oldEntry The original entry contents.
* @param newEntry The new entry contents.
* @param mods The set of modifications that were applied to the entry.
* @param addKeys The set into which the keys to be added will be inserted.
* @param delKeys The set into which the keys to be deleted will be inserted.
* @throws DatabaseException If an error occurs in the JE database.
*/
throws DatabaseException
{
// Pick out the modifications that apply to this indexed attribute
/**
* FIXME unusual modifications can insert spurious index values
* The following sequence of modifications will insert A into the
* index, yet A is not a resulting value for the attribute.
*
* add: cn
* cn: A
* -
* replace: cn
* cn: B
* -
*
*/
{
{
switch (mod.getModificationType())
{
case REPLACE:
case INCREMENT:
if (beforeList != null)
{
{
{
}
}
}
break;
case ADD:
break;
case DELETE:
{
if (beforeList != null)
{
{
{
}
}
}
}
else
{
}
break;
}
}
}
}
/**
* Generate the set of index keys for a set of attribute values.
* @param values The set of attribute values to be indexed.
* @param keys The set into which the keys will be inserted.
*/
{
{
try
{
byte[] keyBytes =
}
catch (DirectoryException e)
{
}
}
}
/**
* Generate the set of index keys for an attribute.
* @param attrList The attribute to be indexed.
* @param keys The set into which the keys will be inserted.
*/
{
{
}
}
}