Package org.opends.server.replication.plugin

Class HistoricalCsnOrderingMatchingRuleImpl

java.lang.Object

org.opends.server.replication.plugin.HistoricalCsnOrderingMatchingRuleImpl

All Implemented Interfaces:

MatchingRuleImpl

public final class HistoricalCsnOrderingMatchingRuleImpl
extends Object
implements MatchingRuleImpl

Matching rule used to establish an order between historical information and index them.

Constructor Summary

Constructors

Constructor	Description
HistoricalCsnOrderingMatchingRuleImpl()

Method Summary

Modifier and Type	Method	Description
Collection<? extends Indexer>	createIndexers(IndexingOptions options)	Returns the indexers for this matching rule.
Assertion	getAssertion(Schema schema, ByteSequence value)	Retrieves the normalized form of the provided assertion value, which is best suited for efficiently performing less than matching operations on that value.
Assertion	getGreaterOrEqualAssertion(Schema schema, ByteSequence value)	Retrieves the normalized form of the provided assertion value, which is best suited for efficiently performing greater than or equal matching operations on that value.
Assertion	getLessOrEqualAssertion(Schema schema, ByteSequence value)	Retrieves the normalized form of the provided assertion value, which is best suited for efficiently performing less than or equal matching operations on that value.
Assertion	getSubstringAssertion(Schema schema, ByteSequence subInitial, List<? extends ByteSequence> subAnyElements, ByteSequence subFinal)	Retrieves the normalized form of the provided assertion substring values, which is best suited for efficiently performing matching operations on that value.
ByteString	normalizeAttributeValue(Schema schema, ByteSequence value)	Retrieves the normalized form of the provided attribute value, which is best suited for efficiently performing matching operations on that value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HistoricalCsnOrderingMatchingRuleImpl

public HistoricalCsnOrderingMatchingRuleImpl()

Method Detail

normalizeAttributeValue

public ByteString normalizeAttributeValue(Schema schema,
                                          ByteSequence value)
                                   throws DecodeException

Description copied from interface: MatchingRuleImpl

Retrieves the normalized form of the provided attribute value, which is best suited for efficiently performing matching operations on that value. Equality and ordering matching rules should return a normalized representation which can be compared with other normalized values using ByteSequence.equals(Object) and ByteSequence.compareTo(ByteSequence).

Specified by:

normalizeAttributeValue in interface MatchingRuleImpl

Parameters:

schema - The schema in which this matching rule is defined.

value - The attribute value to be normalized.

Returns:

The normalized version of the provided attribute value.

Throws:

DecodeException - If an syntax error occurred while parsing the value.

getAssertion

public Assertion getAssertion(Schema schema,
                              ByteSequence value)
                       throws DecodeException

Description copied from interface: MatchingRuleImpl

Retrieves the normalized form of the provided assertion value, which is best suited for efficiently performing less than matching operations on that value. The assertion value is guaranteed to be valid against this matching rule's assertion syntax.

Specified by:

getAssertion in interface MatchingRuleImpl

Parameters:

schema - The schema in which this matching rule is defined.

value - The syntax checked assertion value to be normalized.

Returns:

The normalized version of the provided assertion value.

Throws:

DecodeException - if an syntax error occurred while parsing the value.

getSubstringAssertion

public Assertion getSubstringAssertion(Schema schema,
                                       ByteSequence subInitial,
                                       List<? extends ByteSequence> subAnyElements,
                                       ByteSequence subFinal)
                                throws DecodeException

Description copied from interface: MatchingRuleImpl

Retrieves the normalized form of the provided assertion substring values, which is best suited for efficiently performing matching operations on that value.

Specified by:

getSubstringAssertion in interface MatchingRuleImpl

Parameters:

schema - The schema in which this matching rule is defined.

subInitial - The normalized substring value fragment that should appear at the beginning of the target value.

subAnyElements - The normalized substring value fragments that should appear in the middle of the target value.

subFinal - The normalized substring value fragment that should appear at the end of the target value.

Returns:

The normalized version of the provided assertion value.

Throws:

DecodeException - if an syntax error occurred while parsing the value.

getGreaterOrEqualAssertion

public Assertion getGreaterOrEqualAssertion(Schema schema,
                                            ByteSequence value)
                                     throws DecodeException

Description copied from interface: MatchingRuleImpl

Retrieves the normalized form of the provided assertion value, which is best suited for efficiently performing greater than or equal matching operations on that value. The assertion value is guaranteed to be valid against this matching rule's assertion syntax.

Specified by:

getGreaterOrEqualAssertion in interface MatchingRuleImpl

Parameters:

schema - The schema in which this matching rule is defined.

value - The syntax checked assertion value to be normalized.

Returns:

The normalized version of the provided assertion value.

Throws:

DecodeException - if an syntax error occurred while parsing the value.

getLessOrEqualAssertion

public Assertion getLessOrEqualAssertion(Schema schema,
                                         ByteSequence value)
                                  throws DecodeException

Description copied from interface: MatchingRuleImpl

Retrieves the normalized form of the provided assertion value, which is best suited for efficiently performing less than or equal matching operations on that value. The assertion value is guaranteed to be valid against this matching rule's assertion syntax.

Specified by:

getLessOrEqualAssertion in interface MatchingRuleImpl

Parameters:

schema - The schema in which this matching rule is defined.

value - The syntax checked assertion value to be normalized.

Returns:

The normalized version of the provided assertion value.

Throws:

DecodeException - if an syntax error occurred while parsing the value.

createIndexers

public Collection<? extends Indexer> createIndexers(IndexingOptions options)

Description copied from interface: MatchingRuleImpl

Returns the indexers for this matching rule.

Specified by:

createIndexers in interface MatchingRuleImpl

Parameters:

options - The indexing options

Returns:

a non null collection of indexers for this matching rule.