org.opends.server.schema
Class GuideSyntax

java.lang.Object
  org.opends.server.api.AttributeSyntax<AttributeSyntaxCfg>
      org.opends.server.schema.GuideSyntax

public class GuideSyntax
extends AttributeSyntax<AttributeSyntaxCfg>

This class implements the guide attribute syntax, which may be used to provide criteria for generating search filters for entries, optionally tied to a specified objectclass.

Constructor Summary

GuideSyntax()
Creates a new instance of this syntax.

Method Summary

static boolean	criteriaIsValid(java.lang.String criteria, java.lang.String valueStr, MessageBuilder invalidReason) Determines whether the provided string represents a valid criteria according to the guide syntax.
ApproximateMatchingRule	getApproximateMatchingRule() Retrieves the default approximate matching rule that will be used for attributes with this syntax.
java.lang.String	getDescription() Retrieves a description for this attribute syntax.
EqualityMatchingRule	getEqualityMatchingRule() Retrieves the default equality matching rule that will be used for attributes with this syntax.
java.lang.String	getOID() Retrieves the OID for this attribute syntax.
OrderingMatchingRule	getOrderingMatchingRule() Retrieves the default ordering matching rule that will be used for attributes with this syntax.
SubstringMatchingRule	getSubstringMatchingRule() Retrieves the default substring matching rule that will be used for attributes with this syntax.
java.lang.String	getSyntaxName() Retrieves the common name for this attribute syntax.
void	initializeSyntax(AttributeSyntaxCfg configuration) Initializes this attribute syntax based on the information in the provided configuration entry.
boolean	valueIsAcceptable(ByteString value, MessageBuilder invalidReason) Indicates whether the provided value is acceptable for use in an attribute with this syntax.

Methods inherited from class org.opends.server.api.AttributeSyntax

equals, finalizeSyntax, hashCode, isConfigurationAcceptable, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GuideSyntax

public GuideSyntax()

Creates a new instance of this syntax. Note that the only thing that should be done here is to invoke the default constructor for the superclass. All initialization should be performed in the initializeSyntax method.

Method Detail

initializeSyntax

public void initializeSyntax(AttributeSyntaxCfg configuration)
                      throws ConfigException

Initializes this attribute syntax based on the information in the provided configuration entry.

Specified by:

initializeSyntax in class AttributeSyntax<AttributeSyntaxCfg>

Parameters:

configuration - The configuration to use to initialize this attribute syntax.

Throws:

ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

getSyntaxName

public java.lang.String getSyntaxName()

Retrieves the common name for this attribute syntax.

Specified by:

getSyntaxName in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The common name for this attribute syntax.

getOID

public java.lang.String getOID()

Retrieves the OID for this attribute syntax.

Specified by:

getOID in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The OID for this attribute syntax.

getDescription

public java.lang.String getDescription()

Retrieves a description for this attribute syntax.

Specified by:

getDescription in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

A description for this attribute syntax.

getEqualityMatchingRule

public EqualityMatchingRule getEqualityMatchingRule()

Retrieves the default equality matching rule that will be used for attributes with this syntax.

Specified by:

getEqualityMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The default equality matching rule that will be used for attributes with this syntax, or null if equality matches will not be allowed for this type by default.

getOrderingMatchingRule

public OrderingMatchingRule getOrderingMatchingRule()

Retrieves the default ordering matching rule that will be used for attributes with this syntax.

Specified by:

getOrderingMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The default ordering matching rule that will be used for attributes with this syntax, or null if ordering matches will not be allowed for this type by default.

getSubstringMatchingRule

public SubstringMatchingRule getSubstringMatchingRule()

Retrieves the default substring matching rule that will be used for attributes with this syntax.

Specified by:

getSubstringMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The default substring matching rule that will be used for attributes with this syntax, or null if substring matches will not be allowed for this type by default.

getApproximateMatchingRule

public ApproximateMatchingRule getApproximateMatchingRule()

Retrieves the default approximate matching rule that will be used for attributes with this syntax.

Specified by:

getApproximateMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The default approximate matching rule that will be used for attributes with this syntax, or null if approximate matches will not be allowed for this type by default.

valueIsAcceptable

public boolean valueIsAcceptable(ByteString value,
                                 MessageBuilder invalidReason)

Indicates whether the provided value is acceptable for use in an attribute with this syntax. If it is not, then the reason may be appended to the provided buffer.

Specified by:

valueIsAcceptable in class AttributeSyntax<AttributeSyntaxCfg>

Parameters:

value - The value for which to make the determination.

invalidReason - The buffer to which the invalid reason should be appended.

Returns:

true if the provided value is acceptable for use with this syntax, or false if not.

criteriaIsValid

public static boolean criteriaIsValid(java.lang.String criteria,
                                      java.lang.String valueStr,
                                      MessageBuilder invalidReason)

Determines whether the provided string represents a valid criteria according to the guide syntax.

Parameters:

criteria - The portion of the criteria for which to make the determination.

valueStr - The complete guide value provided by the client.

invalidReason - The buffer to which to append the reason that the criteria is invalid if a problem is found.

Returns:

true if the provided string does contain a valid criteria, or false if not.