org.apache.directory.api.ldap.model.schema
Class MutableMatchingRule

java.lang.Object
  org.apache.directory.api.ldap.model.schema.AbstractSchemaObject
      org.apache.directory.api.ldap.model.schema.MatchingRule
          org.apache.directory.api.ldap.model.schema.MutableMatchingRule

All Implemented Interfaces:

Serializable, SchemaObject

public class MutableMatchingRule
extends MatchingRule

A matchingRule definition. MatchingRules associate a comparator and a normalizer, forming the basic tools necessary to assert actions against attribute values. MatchingRules are associated with a specific Syntax for the purpose of resolving a normalized form and for comparisons.

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.
 

Author:

Apache Directory Project

See Also:

RFC 2252 Section 4.5, ldapbis [MODELS], DescriptionUtils#getDescription(MutableMatchingRule), Serialized Form

Field Summary

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

ldapComparator, ldapSyntax, ldapSyntaxOid, normalizer

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

MutableMatchingRule(String oid)
Creates a new instance of MatchingRule.

Method Summary

void	clear() Clear the current SchemaObject : remove all the references to other objects, and all the Maps.
void	setLdapComparator(LdapComparator<?> ldapComparator) Sets the LdapComparator
void	setNormalizer(Normalizer normalizer) Sets the Normalizer
void	setSyntax(LdapSyntax ldapSyntax) Sets the Syntax
void	setSyntaxOid(String oid) Sets the Syntax's OID
String	toString()
void	updateLdapComparator(LdapComparator<?> ldapComparator) Update the associated Comparator, even if the SchemaObject is readOnly
void	updateNormalizer(Normalizer normalizer) Update the associated Normalizer, even if the SchemaObject is readOnly
void	updateSyntax(LdapSyntax ldapSyntax) Update the associated Syntax, even if the SchemaObject is readOnly

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

copy, equals, getLdapComparator, getNormalizer, getSyntax, getSyntaxOid

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

addExtension, addExtension, addName, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

MutableMatchingRule

public MutableMatchingRule(String oid)

Creates a new instance of MatchingRule.

Parameters:

oid - The MatchingRule OID

Method Detail

setSyntaxOid

public void setSyntaxOid(String oid)

Sets the Syntax's OID

Parameters:

oid - The Syntax's OID

setSyntax

public void setSyntax(LdapSyntax ldapSyntax)

Sets the Syntax

Parameters:

ldapSyntax - The Syntax

updateSyntax

public void updateSyntax(LdapSyntax ldapSyntax)

Update the associated Syntax, even if the SchemaObject is readOnly

Parameters:

ldapSyntax - The Syntax

setLdapComparator

public void setLdapComparator(LdapComparator<?> ldapComparator)

Sets the LdapComparator

Parameters:

ldapComparator - The LdapComparator

updateLdapComparator

public void updateLdapComparator(LdapComparator<?> ldapComparator)

Update the associated Comparator, even if the SchemaObject is readOnly

Parameters:

ldapComparator - The LdapComparator

setNormalizer

public void setNormalizer(Normalizer normalizer)

Sets the Normalizer

Parameters:

normalizer - The Normalizer

updateNormalizer

public void updateNormalizer(Normalizer normalizer)

Update the associated Normalizer, even if the SchemaObject is readOnly

Parameters:

normalizer - The Normalizer

toString

public String toString()

Overrides:

toString in class MatchingRule

See Also:

Object.toString()

clear

public void clear()

Clear the current SchemaObject : remove all the references to other objects, and all the Maps.

Specified by:

clear in interface SchemaObject

Overrides:

clear in class AbstractSchemaObject