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

java.lang.Object
  org.apache.directory.api.ldap.model.schema.parsers.AbstractSchemaParser
      org.apache.directory.api.ldap.model.schema.parsers.DitStructureRuleDescriptionSchemaParser

public class DitStructureRuleDescriptionSchemaParser
extends AbstractSchemaParser

A parser for RFC 4512 DIT structure rule descriptons

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.api.ldap.model.schema.parsers.AbstractSchemaParser

lexer, monitor, parser

Constructor Summary

DitStructureRuleDescriptionSchemaParser()
Creates a schema parser instance.

Method Summary

DitStructureRule	parse(String schemaDescription) Parses a DitStructureRule description.
DitStructureRule	parseDITStructureRuleDescription(String ditStructureRuleDescription) Parses a DIT structure rule description according to RFC 4512:

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

isQuirksMode, reset, setParserMonitor, setQuirksMode, updateSchemaName

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(String ditStructureRuleDescription)
                                                  throws 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:

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

parse

public DitStructureRule parse(String schemaDescription)
                       throws ParseException

Parses a DitStructureRule description.

Specified by:

parse in class AbstractSchemaParser

Parameters:

schemaDescription - The DitStructureRule description to parse

Returns:

An instance of DitStructureRule

Throws:

ParseException - If the parsing failed