|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.MatchingRule<OrderingMatchingRuleCfg>
org.opends.server.api.OrderingMatchingRule
org.opends.server.schema.OctetStringOrderingMatchingRule
public class OctetStringOrderingMatchingRule
This class defines the octetStringOrderingMatch matching rule defined in X.520. This will be the default ordering matching rule for the binary and octet string syntaxes.
Constructor Summary | |
---|---|
OctetStringOrderingMatchingRule()
Creates a new instance of this octetStringOrderingMatch matching rule. |
Method Summary | |
---|---|
int |
compare(byte[] b1,
byte[] b2)
Compares the contents of the provided byte arrays to determine their relative order. |
int |
compareValues(ByteString value1,
ByteString value2)
Compares the first value to the second and returns a value that indicates their relative order. |
java.lang.String |
getDescription()
Retrieves the description for this matching rule. |
java.lang.String |
getName()
Retrieves the common name for this matching rule. |
java.lang.String |
getOID()
Retrieves the OID for this matching rule. |
java.lang.String |
getSyntaxOID()
Retrieves the OID of the syntax with which this matching rule is associated. |
void |
initializeMatchingRule(OrderingMatchingRuleCfg configuration)
Initializes this matching rule based on the information in the provided configuration entry. |
ByteString |
normalizeValue(ByteString value)
Retrieves the normalized form of the provided value, which is best suited for efficiently performing matching operations on that value. |
Methods inherited from class org.opends.server.api.OrderingMatchingRule |
---|
valuesMatch |
Methods inherited from class org.opends.server.api.MatchingRule |
---|
equals, finalizeMatchingRule, getNameOrOID, hashCode, isConfigurationAcceptable, isObsolete, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Comparator |
---|
equals |
Constructor Detail |
---|
public OctetStringOrderingMatchingRule()
Method Detail |
---|
public void initializeMatchingRule(OrderingMatchingRuleCfg configuration) throws ConfigException, InitializationException
initializeMatchingRule
in class MatchingRule<OrderingMatchingRuleCfg>
configuration
- The configuration to use to intialize this
matching rule.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.
InitializationException
- If a problem that is not
configuration-related occurs
during initialization.public java.lang.String getName()
getName
in class MatchingRule<OrderingMatchingRuleCfg>
null
if
it does not have a name.public java.lang.String getOID()
getOID
in class MatchingRule<OrderingMatchingRuleCfg>
public java.lang.String getDescription()
getDescription
in class MatchingRule<OrderingMatchingRuleCfg>
null
if
there is none.public java.lang.String getSyntaxOID()
getSyntaxOID
in class MatchingRule<OrderingMatchingRuleCfg>
public ByteString normalizeValue(ByteString value) throws DirectoryException
normalizeValue
in class MatchingRule<OrderingMatchingRuleCfg>
value
- The value to be normalized.
DirectoryException
- If the provided value is invalid according to
the associated attribute syntax.public int compareValues(ByteString value1, ByteString value2)
compareValues
in class OrderingMatchingRule
value1
- The normalized form of the first value to compare.value2
- The normalized form of the second value to compare.
value1
should come before
value2
in ascending order, a positive integer if
value1
should come after value2
in
ascending order, or zero if there is no difference between the
values with regard to ordering.public int compare(byte[] b1, byte[] b2)
b1
- The first byte array to use in the comparison.b2
- The second byte array to use in the comparison.
b1
should come before
b2
in ascending order, a positive integer if
b1
should come after b2
in ascending
order, or zero if there is no difference between the values with
regard to ordering.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |