public class MatchingRule extends AbstractSchemaObject
According to ldapbis [MODELS]:
4.1.3. Matching Rules Matching rules are used by servers to compare attribute values against assertion values when performing Search and Compare operations. They are also used to identify the value to be added or deleted when modifying entries, and are used when comparing a purported distinguished name with the name of an entry. A matching rule specifies the syntax of the assertion value. Each matching rule is identified by an object identifier (OID) and, optionally, one or more short names (descriptors). Matching rule definitions are written according to the ABNF: MatchingRuleDescription = LPAREN WSP numericoid ; object identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active SP "SYNTAX" SP numericoid ; assertion syntax extensions WSP RPAREN ; extensions where: [numericoid] is object identifier assigned to this matching rule; NAME [qdescrs] are short names (descriptors) identifying this matching rule; DESC [qdstring] is a short descriptive string; OBSOLETE indicates this matching rule is not active; SYNTAX identifies the assertion syntax by object identifier; and [extensions] describe extensions.
DescriptionUtils#getDescription(MatchingRule)
,
Serialized FormModifier and Type | Field and Description |
---|---|
protected LdapComparator<? super Object> |
ldapComparator
The associated Comparator
|
protected LdapSyntax |
ldapSyntax
The associated LdapSyntax
|
protected String |
ldapSyntaxOid
The associated LdapSyntax OID
|
protected Normalizer |
normalizer
The associated Normalizer
|
static long |
serialVersionUID
The mandatory serialVersionUID
|
description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification
Constructor and Description |
---|
MatchingRule(String oid)
Creates a new instance of MatchingRule.
|
Modifier and Type | Method and Description |
---|---|
MatchingRule |
copy()
Copy an MatchingRule
|
boolean |
equals(Object o) |
LdapComparator<? super Object> |
getLdapComparator()
Gets the LdapComparator enabling the use of this MatchingRule for ORDERING
and sorted indexing.
|
Normalizer |
getNormalizer()
Gets the Normalizer enabling the use of this MatchingRule for EQUALITY
matching and indexing.
|
LdapSyntax |
getSyntax()
Gets the LdapSyntax used by this MatchingRule.
|
String |
getSyntaxOid()
Gets the LdapSyntax OID used by this MatchingRule.
|
String |
toString() |
addExtension, addExtension, addName, clear, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setSchemaName, setSpecification, unlock
public static final long serialVersionUID
protected LdapComparator<? super Object> ldapComparator
protected Normalizer normalizer
protected LdapSyntax ldapSyntax
protected String ldapSyntaxOid
public MatchingRule(String oid)
oid
- The MatchingRule OIDpublic LdapSyntax getSyntax()
public String getSyntaxOid()
public LdapComparator<? super Object> getLdapComparator()
public Normalizer getNormalizer()
public String toString()
toString
in class Object
Object.toString()
public MatchingRule copy()
copy
in interface SchemaObject
copy
in class AbstractSchemaObject
public boolean equals(Object o)
SchemaObject
equals
in interface SchemaObject
equals
in class AbstractSchemaObject
Object#equals()
Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.