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

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

public class DITStructureRuleDescriptionSchemaParser
extends AbstractSchemaParser

A parser for RFC 4512 DIT structure rule descriptons

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
DITStructureRuleDescriptionSchemaParser()
          Creates a schema parser instance.
 
Method Summary
 DITStructureRule parse(java.lang.String schemaDescription)
          Parses a DITStructureRule description
 DITStructureRule parseDITStructureRuleDescription(java.lang.String ditStructureRuleDescription)
          Parses a DIT structure 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

DITStructureRuleDescriptionSchemaParser

public DITStructureRuleDescriptionSchemaParser()
Creates a schema parser instance.

Method Detail

parseDITStructureRuleDescription

public DITStructureRule parseDITStructureRuleDescription(java.lang.String ditStructureRuleDescription)
                                                  throws java.text.ParseException
Parses a DIT structure rule description according to RFC 4512:
 DITStructureRuleDescription = LPAREN WSP
   ruleid                     ; rule identifier
   [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
   [ SP "DESC" SP qdstring ]  ; description
   [ SP "OBSOLETE" ]          ; not active
   SP "FORM" SP oid           ; NameForm
   [ SP "SUP" ruleids ]       ; superior rules
   extensions WSP RPAREN      ; extensions

 ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN )
 ruleidlist = ruleid *( SP ruleid )
 ruleid = numbers
 

Parameters:
ditStructureRuleDescription - the DIT structure rule description to be parsed
Returns:
the parsed DITStructureRuleDescription bean
Throws:
java.text.ParseException - if there are any recognition errors (bad syntax)

parse

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

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


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