org.opencypher.tools.g4tree

Class Rule

java.lang.Object

org.opencypher.tools.g4tree.Rule

All Implemented Interfaces:

GrammarItem

public class Rule
extends Object
implements GrammarItem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rule.RuleType

Nested classes/interfaces inherited from interface org.opencypher.tools.g4tree.GrammarItem

GrammarItem.ItemType

Field Summary

Fields inherited from interface org.opencypher.tools.g4tree.GrammarItem

INDENT

Constructor Summary

Constructors

Constructor and Description
Rule(GrammarItem ruleName, GrammarItem rhs, boolean keyWordRule, Rule.RuleType ruleType, String description)
Rule(GrammarItem ruleName, GrammarItem rhs, String description)

Method Summary

Modifier and Type	Method and Description
List<GrammarItem>	getChildren() get the child items as a list.
String	getDescription()
GrammarItem	getRhs()
String	getRuleName()
Rule.RuleType	getRuleType()
String	getStructure(String indent) Reserialise showing the internal structure of the grammar.
GrammarItem.ItemType	getType() what type, in terms of how to process its conversion to main grammar
boolean	isKeywordPart() Could this be part or all of a keyword ? Is either a letter or all of its parts are letters
boolean	isPlural() are there more than one of these items.
GrammarItem	reachThrough() if this item is a wrapper round a single item, get that one.
void	setRuleType(Rule.RuleType ruleType)

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule(GrammarItem ruleName,
            GrammarItem rhs,
            String description)

Rule

public Rule(GrammarItem ruleName,
            GrammarItem rhs,
            boolean keyWordRule,
            Rule.RuleType ruleType,
            String description)

Method Detail

getRuleType

public Rule.RuleType getRuleType()

setRuleType

public void setRuleType(Rule.RuleType ruleType)

getType

public GrammarItem.ItemType getType()

Description copied from interface: GrammarItem

what type, in terms of how to process its conversion to main grammar

Specified by:

getType in interface GrammarItem

Returns:

getRuleName

public String getRuleName()

getDescription

public String getDescription()

getRhs

public GrammarItem getRhs()

getChildren

public List<GrammarItem> getChildren()

Description copied from interface: GrammarItem

get the child items as a list. Terminals will return an empty list, non-lists will return a list of one.

Specified by:

getChildren in interface GrammarItem

Returns:

isPlural

public boolean isPlural()

Description copied from interface: GrammarItem

are there more than one of these items. Some serialisations will require brackets of some kind if there are

Specified by:

isPlural in interface GrammarItem

Returns:

true if there are multiple of these items.

getStructure

public String getStructure(String indent)

Description copied from interface: GrammarItem

Reserialise showing the internal structure of the grammar. This is based on the rules of the "orignal BNF" g4, and may not correspond to how the user thinks of the structre

Specified by:

getStructure in interface GrammarItem

Parameters:

indent - how much to indent each level of the structure

Returns:

a String showing the internals and values in the grammar

reachThrough

public GrammarItem reachThrough()

Description copied from interface: GrammarItem

if this item is a wrapper round a single item, get that one. A wrapper may affect cardinality, optionality etc.

Specified by:

reachThrough in interface GrammarItem

Returns:

the wrapped item, or this item itself it if isn't wrapper.

isKeywordPart

public boolean isKeywordPart()

Description copied from interface: GrammarItem

Could this be part or all of a keyword ? Is either a letter or all of its parts are letters

Specified by:

isKeywordPart in interface GrammarItem

Returns:

true iff this could be part of a keyword