org.apache.directory.api.dsmlv2

Class AbstractGrammar

java.lang.Object

org.apache.directory.api.dsmlv2.AbstractGrammar

All Implemented Interfaces:

Grammar

Direct Known Subclasses:

Dsmlv2Grammar, Dsmlv2ResponseGrammar

public abstract class AbstractGrammar
extends java.lang.Object
implements Grammar

The abstract Grammar which is the Mother of all the grammars. It contains the transitions table.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name The grammar name
protected java.util.HashMap<Tag,GrammarTransition>[]	transitions Table of transitions.

Constructor Summary

Constructors

Constructor and Description
AbstractGrammar()

Method Summary

Modifier and Type	Method and Description
void	executeAction(Dsmlv2Container container) This method, when called, executes an action on the current data stored in the container.
java.lang.String	getName() Returns the grammar's name
java.lang.Enum<Dsmlv2StatesEnum>[]	getStatesEnum() Gets the states of the current grammar
GrammarTransition	getTransition(java.lang.Enum<Dsmlv2StatesEnum> state, Tag tag) Gets the transition associated with the state and tag
private void	processTag(Dsmlv2Container container, int tagType) Processes the task required in the grammar to the given tag type
void	setName(java.lang.String name) Sets the grammar's name

Methods inherited from class java.lang.Object

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

Field Detail

transitions

protected java.util.HashMap<Tag,GrammarTransition>[] transitions

Table of transitions. It's a two dimension array, the first dimension indexes the states, the second dimension indexes the Tag value, so it is 256 wide.

name

protected java.lang.String name

The grammar name

Constructor Detail

AbstractGrammar

public AbstractGrammar()

Method Detail

getName

public java.lang.String getName()

Returns the grammar's name

Specified by:

getName in interface Grammar

Returns:

The grammar name

setName

public void setName(java.lang.String name)

Sets the grammar's name

Specified by:

setName in interface Grammar

Parameters:

name - the name to set

getTransition

public GrammarTransition getTransition(java.lang.Enum<Dsmlv2StatesEnum> state,
                                       Tag tag)

Gets the transition associated with the state and tag

Parameters:

state - The current state

tag - The current tag

Returns:

A valid transition if any, or null.

getStatesEnum

public java.lang.Enum<Dsmlv2StatesEnum>[] getStatesEnum()

Gets the states of the current grammar

Specified by:

getStatesEnum in interface Grammar

Returns:

Returns the statesEnum.

executeAction

public void executeAction(Dsmlv2Container container)
                   throws org.xmlpull.v1.XmlPullParserException,
                          java.io.IOException

This method, when called, executes an action on the current data stored in the container.

Specified by:

executeAction in interface Grammar

Parameters:

container - the DSML container

Throws:

org.xmlpull.v1.XmlPullParserException - when an unrecoverable error occurs

java.io.IOException - when an IO error occurs

processTag

private void processTag(Dsmlv2Container container,
                        int tagType)
                 throws org.xmlpull.v1.XmlPullParserException

Processes the task required in the grammar to the given tag type

Parameters:

container - the DSML container

tagType - the tag type

Throws:

org.xmlpull.v1.XmlPullParserException - when an error occurs during the parsing