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

Class AbstractSchemaParser<T extends SchemaObject>

java.lang.Object

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

Type Parameters:

T - The type of SchemaObject

Direct Known Subclasses:

AttributeTypeDescriptionSchemaParser, DitContentRuleDescriptionSchemaParser, DitStructureRuleDescriptionSchemaParser, LdapComparatorDescriptionSchemaParser, LdapSyntaxDescriptionSchemaParser, MatchingRuleDescriptionSchemaParser, MatchingRuleUseDescriptionSchemaParser, NameFormDescriptionSchemaParser, NormalizerDescriptionSchemaParser, ObjectClassDescriptionSchemaParser, OpenLdapSchemaParser, SyntaxCheckerDescriptionSchemaParser

public abstract class AbstractSchemaParser<T extends SchemaObject>
extends Object

Base class of all schema parsers.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.i18n.I18n	errorCodeOnNull error code used when schema descritpion is null
private org.apache.directory.api.i18n.I18n	errorCodeOnParseException error code used on parse error when position is unknown
private org.apache.directory.api.i18n.I18n	errorCodeOnParseExceptionWithPosition error code used on parse error when position is known
protected ReusableAntlrSchemaLexer	lexer the antlr generated lexer being wrapped
protected static org.slf4j.Logger	LOG The LoggerFactory used by this class
protected ParserMonitor	monitor the monitor to use for this parser
protected ReusableAntlrSchemaParser	parser the antlr generated parser being wrapped
private Class<T>	schemaObjectType the schema object sub-type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSchemaParser(Class<T> schemaObjectType, org.apache.directory.api.i18n.I18n errorCodeOnNull, org.apache.directory.api.i18n.I18n errorCodeOnParseExceptionWithPosition, org.apache.directory.api.i18n.I18n errorCodeOnParseException) Instantiates a new abstract schema parser.

Method Summary

Modifier and Type	Method and Description
protected abstract T	doParse() Parse a SchemaObject description and returns back an instance of SchemaObject.
boolean	isQuirksMode() Checks if quirks mode is enabled.
T	parse(String schemaDescription) Parse a SchemaObject description and returns back an instance of SchemaObject.
protected void	reset(String spec) Initializes the plumbing by creating a pipe and coupling the parser/lexer pair with it.
void	setParserMonitor(ParserMonitor parserMonitor) Sets the parser monitor.
void	setQuirksMode(boolean enabled) Sets the quirks mode.
private void	updateSchemaName(SchemaObject schemaObject) Update the schemaName for the given SchemaObject, accordingly to the X-SCHEMA parameter.
private ParseException	wrapRecognitionException(String schemaDescription, antlr.RecognitionException re)
private ParseException	wrapTokenStreamException(String schemaDescription, antlr.TokenStreamException tse)

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

monitor

protected ParserMonitor monitor

the monitor to use for this parser

parser

protected ReusableAntlrSchemaParser parser

the antlr generated parser being wrapped

lexer

protected ReusableAntlrSchemaLexer lexer

the antlr generated lexer being wrapped

schemaObjectType

private Class<T extends SchemaObject> schemaObjectType

the schema object sub-type

errorCodeOnNull

private org.apache.directory.api.i18n.I18n errorCodeOnNull

error code used when schema descritpion is null

errorCodeOnParseExceptionWithPosition

private org.apache.directory.api.i18n.I18n errorCodeOnParseExceptionWithPosition

error code used on parse error when position is known

errorCodeOnParseException

private org.apache.directory.api.i18n.I18n errorCodeOnParseException

error code used on parse error when position is unknown

Constructor Detail

AbstractSchemaParser

protected AbstractSchemaParser(Class<T> schemaObjectType,
                               org.apache.directory.api.i18n.I18n errorCodeOnNull,
                               org.apache.directory.api.i18n.I18n errorCodeOnParseExceptionWithPosition,
                               org.apache.directory.api.i18n.I18n errorCodeOnParseException)

Instantiates a new abstract schema parser.

Parameters:

schemaObjectType - The Schema object type

errorCodeOnNull - error code used when schema element is null

errorCodeOnParseExceptionWithPosition - error code used on parse error when position is known

errorCodeOnParseException - error code used on parse error when position is unknown

Method Detail

reset

protected void reset(String spec)

Initializes the plumbing by creating a pipe and coupling the parser/lexer pair with it. param spec the specification to be parsed

Parameters:

spec - the spec

setParserMonitor

public void setParserMonitor(ParserMonitor parserMonitor)

Sets the parser monitor.

Parameters:

parserMonitor - the new parser monitor

setQuirksMode

public void setQuirksMode(boolean enabled)

Sets the quirks mode. If enabled the parser accepts non-numeric OIDs and some special characters in descriptions.

Parameters:

enabled - the new quirks mode

isQuirksMode

public boolean isQuirksMode()

Checks if quirks mode is enabled.

Returns:

true, if is quirks mode is enabled

parse

public T parse(String schemaDescription)
        throws ParseException

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

Parameters:

schemaDescription - The SchemaObject description

Returns:

A SchemaObject instance

Throws:

ParseException - If the parsing failed

wrapRecognitionException

private ParseException wrapRecognitionException(String schemaDescription,
                                                antlr.RecognitionException re)

wrapTokenStreamException

private ParseException wrapTokenStreamException(String schemaDescription,
                                                antlr.TokenStreamException tse)

doParse

protected abstract T doParse()
                      throws antlr.RecognitionException,
                             antlr.TokenStreamException

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

Returns:

A SchemaObject instance

Throws:

antlr.RecognitionException - the native antlr exception

antlr.TokenStreamException - the native antlr exception

updateSchemaName

private void updateSchemaName(SchemaObject schemaObject)

Update the schemaName for the given SchemaObject, accordingly to the X-SCHEMA parameter. If not present, default to 'other'

Parameters:

schemaObject - the schema object where the name should be updated