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

Constructors

Constructor and Description
GuideSyntax() Creates a new instance of this syntax.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	criteriaIsValid(String criteria, String valueStr, LocalizableMessageBuilder invalidReason) Determines whether the provided string represents a valid criteria according to the guide syntax.
String	getDescription() Retrieves a description for this attribute syntax.
String	getName() Retrieves the common name for this attribute syntax.
String	getOID() Retrieves the OID for this attribute syntax.
org.forgerock.opendj.ldap.schema.Syntax	getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema) Returns the SDK Syntax equivalent to this syntax.

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

equals, finalizeSyntax, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, hashCode, initializeSyntax, isBEREncodingRequired, isConfigurationAcceptable, isHumanReadable, toString, toString, valueIsAcceptable

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

getSDKSyntax

public org.forgerock.opendj.ldap.schema.Syntax getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema)

Returns the SDK Syntax equivalent to this syntax.

This method allow smooth migration to SDK syntax. It will disappear once the the migration to SDK schema is complete, together with this class and all its implementation.

Specified by:

getSDKSyntax in class AttributeSyntax<AttributeSyntaxCfg>

Parameters:

schema - Schema to use to retrieve the syntax

Returns:

the equivalent SDK syntax.

getName

public String getName()

Retrieves the common name for this attribute syntax.

Specified by:

getName in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The common name for this attribute syntax.

getOID

public 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 String getDescription()

Retrieves a description for this attribute syntax.

Specified by:

getDescription in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

A description for this attribute syntax.

criteriaIsValid

public static boolean criteriaIsValid(String criteria,
                      String valueStr,
                      LocalizableMessageBuilder 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.