org.apache.directory.shared.ldap.schema.parsers
Class MatchingRuleDescriptionSchemaParser

java.lang.Object
  extended by org.apache.directory.shared.ldap.schema.parsers.AbstractSchemaParser
      extended by org.apache.directory.shared.ldap.schema.parsers.MatchingRuleDescriptionSchemaParser

public class MatchingRuleDescriptionSchemaParser
extends AbstractSchemaParser

A parser for RFC 4512 matching rule descriptions.

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Field Summary
protected static org.slf4j.Logger LOG
          The LoggerFactory used by this class
 
Fields inherited from class org.apache.directory.shared.ldap.schema.parsers.AbstractSchemaParser
lexer, monitor, parser
 
Constructor Summary
MatchingRuleDescriptionSchemaParser()
          Creates a schema parser instance.
 
Method Summary
 MatchingRule parse(java.lang.String schemaDescription)
          Parses a MatchingRule description
 MatchingRule parseMatchingRuleDescription(java.lang.String matchingRuleDescription)
          Parses a matching rule description according to RFC 4512:
 
Methods inherited from class org.apache.directory.shared.ldap.schema.parsers.AbstractSchemaParser
isQuirksMode, reset, setParserMonitor, setQuirksMode, setSchemaName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

protected static final org.slf4j.Logger LOG
The LoggerFactory used by this class

Constructor Detail

MatchingRuleDescriptionSchemaParser

public MatchingRuleDescriptionSchemaParser()
Creates a schema parser instance.

Method Detail

parseMatchingRuleDescription

public MatchingRule parseMatchingRuleDescription(java.lang.String matchingRuleDescription)
                                          throws java.text.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:
java.text.ParseException - if there are any recognition errors (bad syntax)

parse

public MatchingRule parse(java.lang.String schemaDescription)
                   throws java.text.ParseException
Parses a MatchingRule description

Specified by:
parse in class AbstractSchemaParser
Parameters:
The - MatchingRule description to parse
Returns:
An instance of MatchingRule
Throws:
java.text.ParseException - If the parsing failed


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.