org.apache.directory.api.ldap.model.schema.comparators

Class NormalizingComparator

java.lang.Object

org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

org.apache.directory.api.ldap.model.schema.LoadableSchemaObject

org.apache.directory.api.ldap.model.schema.LdapComparator<java.lang.String>

org.apache.directory.api.ldap.model.schema.comparators.NormalizingComparator

All Implemented Interfaces:

java.io.Serializable, java.util.Comparator<java.lang.String>, SchemaObject

Direct Known Subclasses:

DeepTrimCachingNormalizingComparator, DeepTrimToLowerCachingNormalizingComparator

public class NormalizingComparator
extends LdapComparator<java.lang.String>

A comparator which normalizes a value first before using a subordinate comparator to compare them.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private LdapComparator<java.lang.String>	comparator the underlying comparator to use for comparisons
private static org.slf4j.Logger	LOG A logger for this class
private Normalizer	normalizer the Normalizer to normalize values with before comparing
private boolean	onServer
private static long	serialVersionUID The serial version UID

Fields inherited from class org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification

Constructor Summary

Constructors

Constructor and Description
NormalizingComparator(java.lang.String oid, Normalizer normalizer, LdapComparator<java.lang.String> comparator) A comparator which normalizes a value first before comparing them.

Method Summary

Modifier and Type	Method and Description
int	compare(java.lang.String o1, java.lang.String o2) If any normalization attempt fails we compare using the unnormalized object.
void	setOid(java.lang.String oid) A special method used when renaming an SchemaObject: we may have to change it's OID
void	setOnServer() tells that the normalizingComparator should not normalize values which are already normalized on the server

Methods inherited from class org.apache.directory.api.ldap.model.schema.LdapComparator

equals, setSchemaManager, toString

Methods inherited from class org.apache.directory.api.ldap.model.schema.LoadableSchemaObject

copy, getBytecode, getFqcn, isValid, setBytecode, setFqcn

Methods inherited from class org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

addExtension, addExtension, addName, clear, compareOid, copy, getDescription, getExtension, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hasExtension, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setReadOnly, setSchemaName, setSpecification, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

serialVersionUID

private static final long serialVersionUID

The serial version UID

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

A logger for this class

normalizer

private Normalizer normalizer

the Normalizer to normalize values with before comparing

comparator

private LdapComparator<java.lang.String> comparator

the underlying comparator to use for comparisons

onServer

private boolean onServer

Constructor Detail

NormalizingComparator

public NormalizingComparator(java.lang.String oid,
                             Normalizer normalizer,
                             LdapComparator<java.lang.String> comparator)

A comparator which normalizes a value first before comparing them.

Parameters:

normalizer - the Normalizer to normalize values with before comparing

comparator - the underlying comparator to use for comparisons

Method Detail

compare

public int compare(java.lang.String o1,
                   java.lang.String o2)

If any normalization attempt fails we compare using the unnormalized object.

setOid

public void setOid(java.lang.String oid)

A special method used when renaming an SchemaObject: we may have to change it's OID This implementation makes sure we update the oid property of the contained normalizer and comparator.

Specified by:

setOid in interface SchemaObject

Overrides:

setOid in class AbstractSchemaObject

Parameters:

oid - The new OID

setOnServer

public void setOnServer()

tells that the normalizingComparator should not normalize values which are already normalized on the server