org.apache.directory.api.ldap.model.schema.parsers

Class MatchingRuleDescriptionSchemaParser

java.lang.Object

org.apache.directory.api.ldap.model.schema.parsers.AbstractSchemaParser<MatchingRule>

org.apache.directory.api.ldap.model.schema.parsers.MatchingRuleDescriptionSchemaParser

public class MatchingRuleDescriptionSchemaParser
extends AbstractSchemaParser<MatchingRule>

A parser for RFC 4512 matching rule descriptions.

Author:

Apache Directory Project

Field Summary

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

lexer, LOG, monitor, parser

Constructor Summary

Constructors

Constructor and Description
MatchingRuleDescriptionSchemaParser() Creates a schema parser instance.

Method Summary

Modifier and Type	Method and Description
protected MatchingRule	doParse() Parse a SchemaObject description and returns back an instance of SchemaObject.
MatchingRule	parseMatchingRuleDescription(String matchingRuleDescription) Parses a matching rule description according to RFC 4512:

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

isQuirksMode, parse, reset, setParserMonitor, setQuirksMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MatchingRuleDescriptionSchemaParser

public MatchingRuleDescriptionSchemaParser()

Creates a schema parser instance.

Method Detail

parseMatchingRuleDescription

public MatchingRule parseMatchingRuleDescription(String matchingRuleDescription)
                                          throws ParseException

Parses a matching rule description according to RFC 4512:

 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
 
 extensions = *( SP xstring SP qdstrings )
 xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 
 

Parameters:

matchingRuleDescription - the matching rule description to be parsed

Returns:

the parsed MatchingRuleDescription bean

Throws:

ParseException - if there are any recognition errors (bad syntax)

doParse

protected MatchingRule doParse()
                        throws antlr.RecognitionException,
                               antlr.TokenStreamException

Parse a SchemaObject description and returns back an instance of SchemaObject.

Specified by:

doParse in class AbstractSchemaParser<MatchingRule>

Returns:

A SchemaObject instance

Throws:

antlr.RecognitionException - the native antlr exception

antlr.TokenStreamException - the native antlr exception