/*
|
* 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
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* 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.
|
*/
|
package org.opends.server.backends.jeb;
|
|
import static org.opends.server.loggers.Debug.debugException;
|
import com.sleepycat.je.Transaction;
|
import org.opends.server.protocols.asn1.ASN1OctetString;
|
import org.opends.server.types.Attribute;
|
import org.opends.server.types.AttributeValue;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.Entry;
|
import org.opends.server.types.Modification;
|
|
import java.util.Comparator;
|
import java.util.HashSet;
|
import java.util.LinkedHashSet;
|
import java.util.List;
|
import java.util.Set;
|
|
/**
|
* An implementation of an Indexer for attribute substrings.
|
*/
|
public class SubstringIndexer extends Indexer
|
{
|
/**
|
* The fully-qualified name of this class for debugging purposes.
|
*/
|
private static final String CLASS_NAME =
|
"org.opends.server.backends.jeb.SubstringIndexer";
|
|
|
/**
|
* The comparator for index keys generated by this class.
|
*/
|
private static final Comparator<byte[]> comparator =
|
new AttributeIndex.KeyComparator();
|
|
/**
|
* The attribute index configuration for which this instance will
|
* generate index keys.
|
*/
|
private IndexConfig indexConfig;
|
|
/**
|
* Create a new attribute substring indexer for the given index configuration.
|
* @param indexConfig The index configuration for which an indexer is
|
* required.
|
*/
|
public SubstringIndexer(IndexConfig indexConfig)
|
{
|
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.
|
*/
|
public String toString()
|
{
|
return indexConfig.getAttributeType().getNameOrOID() + ".substring";
|
}
|
|
/**
|
* 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 comparator;
|
}
|
|
/**
|
* 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.
|
*/
|
public void indexEntry(Transaction txn, Entry entry,
|
Set<ASN1OctetString> keys)
|
{
|
List<Attribute> attrList =
|
entry.getAttribute(indexConfig.getAttributeType());
|
if (attrList != null)
|
{
|
indexAttribute(attrList, keys);
|
}
|
}
|
|
/**
|
* 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.
|
*/
|
public void replaceEntry(Transaction txn,
|
Entry oldEntry, Entry newEntry,
|
Set<ASN1OctetString> addKeys,
|
Set<ASN1OctetString> delKeys)
|
{
|
List<Attribute> attrList;
|
|
attrList = oldEntry.getAttribute(indexConfig.getAttributeType());
|
Set<ASN1OctetString> oldSet = new HashSet<ASN1OctetString>();
|
indexAttribute(attrList, oldSet);
|
|
attrList = newEntry.getAttribute(indexConfig.getAttributeType());
|
Set<ASN1OctetString> newSet = new HashSet<ASN1OctetString>();
|
indexAttribute(attrList, newSet);
|
|
HashSet<ASN1OctetString> removeSet = new HashSet<ASN1OctetString>(oldSet);
|
removeSet.removeAll(newSet);
|
for (ASN1OctetString k : removeSet)
|
{
|
delKeys.add(k);
|
}
|
|
HashSet<ASN1OctetString> addSet = new HashSet<ASN1OctetString>(newSet);
|
addSet.removeAll(oldSet);
|
for (ASN1OctetString k : addSet)
|
{
|
addKeys.add(k);
|
}
|
}
|
|
|
|
/**
|
* 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.
|
*/
|
public void modifyEntry(Transaction txn, Entry oldEntry, Entry newEntry,
|
List<Modification> mods,
|
Set<ASN1OctetString> addKeys,
|
Set<ASN1OctetString> delKeys)
|
{
|
replaceEntry(txn, oldEntry, newEntry, addKeys, delKeys);
|
}
|
|
|
|
/**
|
* Generate the set of substring index keys for an attribute.
|
* @param attrList The attribute for which substring keys are required.
|
* @param addKeys The set into which the generated keys will be inserted.
|
*/
|
private void indexAttribute(List<Attribute> attrList,
|
Set<ASN1OctetString> addKeys)
|
{
|
if (attrList == null) return;
|
|
for (Attribute attr : attrList)
|
{
|
LinkedHashSet<AttributeValue> values = attr.getValues();
|
for (AttributeValue value : values)
|
{
|
try
|
{
|
byte[] normalizedBytes = value.getNormalizedValue().value();
|
|
substringKeys(normalizedBytes, addKeys);
|
}
|
catch (DirectoryException e)
|
{
|
assert debugException(CLASS_NAME, "indexAttribute", e);
|
}
|
}
|
}
|
}
|
|
/**
|
* Decompose an attribute value into a set of substring index keys.
|
* The ID of the entry containing this value should be inserted
|
* into the list of each of these keys.
|
*
|
* @param value A byte array containing the normalized attribute value
|
* @param set A set into which the keys will be inserted.
|
*/
|
private void substringKeys(byte[] value, Set<ASN1OctetString> set)
|
{
|
int substrLength = indexConfig.getSubstringLength();
|
byte[] keyBytes;
|
|
// Example: The value is ABCDE and the substring length is 3.
|
// We produce the keys ABC BCD CDE DE E
|
// To find values containing a short substring such as DE,
|
// iterate through keys with prefix DE. To find values
|
// containing a longer substring such as BCDE, read keys
|
// BCD and CDE.
|
for (int i = 0, remain = value.length; remain > 0; i++, remain--)
|
{
|
int len = Math.min(substrLength, remain);
|
keyBytes = makeSubstringKey(value, i, len);
|
set.add(new ASN1OctetString(keyBytes));
|
}
|
}
|
|
/**
|
* Makes a byte array representing a substring index key for
|
* one substring of a value.
|
*
|
* @param bytes The byte array containing the value
|
* @param pos The starting position of the substring
|
* @param len The length of the substring
|
* @return A byte array containing a substring key
|
*/
|
private byte[] makeSubstringKey(byte[] bytes, int pos, int len)
|
{
|
byte[] keyBytes = new byte[len];
|
System.arraycopy(bytes, pos, keyBytes, 0, len);
|
return keyBytes;
|
}
|
|
}
|
