|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.AttributeSyntax<AttributeSyntaxCfg>
org.opends.server.schema.GuideSyntax
public class GuideSyntax
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 |
---|
public GuideSyntax()
initializeSyntax
method.
Method Detail |
---|
public void initializeSyntax(AttributeSyntaxCfg configuration) throws ConfigException
initializeSyntax
in class AttributeSyntax<AttributeSyntaxCfg>
configuration
- The configuration to use to initialize
this attribute syntax.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.public java.lang.String getSyntaxName()
getSyntaxName
in class AttributeSyntax<AttributeSyntaxCfg>
public java.lang.String getOID()
getOID
in class AttributeSyntax<AttributeSyntaxCfg>
public java.lang.String getDescription()
getDescription
in class AttributeSyntax<AttributeSyntaxCfg>
public EqualityMatchingRule getEqualityMatchingRule()
getEqualityMatchingRule
in class AttributeSyntax<AttributeSyntaxCfg>
null
if equality
matches will not be allowed for this type by default.public OrderingMatchingRule getOrderingMatchingRule()
getOrderingMatchingRule
in class AttributeSyntax<AttributeSyntaxCfg>
null
if ordering
matches will not be allowed for this type by default.public SubstringMatchingRule getSubstringMatchingRule()
getSubstringMatchingRule
in class AttributeSyntax<AttributeSyntaxCfg>
null
if substring
matches will not be allowed for this type by default.public ApproximateMatchingRule getApproximateMatchingRule()
getApproximateMatchingRule
in class AttributeSyntax<AttributeSyntaxCfg>
null
if approximate
matches will not be allowed for this type by default.public boolean valueIsAcceptable(ByteString value, MessageBuilder invalidReason)
valueIsAcceptable
in class AttributeSyntax<AttributeSyntaxCfg>
value
- The value for which to make the determination.invalidReason
- The buffer to which the invalid reason should be
appended.
true
if the provided value is acceptable for use with
this syntax, or false
if not.public static boolean criteriaIsValid(java.lang.String criteria, java.lang.String valueStr, MessageBuilder invalidReason)
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.
true
if the provided string does contain a valid
criteria, or false
if not.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |