Package org.opencypher.grammar

Interface Grammar

public interface Grammar

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Grammar.Builder
static class	Grammar.CharacterSet
static class	Grammar.Option
static class	Grammar.ParserOption
static interface	Grammar.Resolver
static class	Grammar.Term
static class	Grammar.Unresolved

Field Summary

Fields

Modifier and Type	Field	Description
static String	ANNOTATION_XML_NAMESPACE
static String	GENERATOR_XML_NAMESPACE
static String	OPENCYPHER_XML_NAMESPACE
static String	RAILROAD_XML_NAMESPACE
static String	SCOPE_XML_NAMESPACE
static String	XML_NAMESPACE

Method Summary

Modifier and Type	Method	Description
<EX extends Exception> void	accept(ProductionVisitor<EX> visitor)
default boolean	any(Predicate<Production> predicate)
static Grammar.CharacterSet	anyCharacter()
static Grammar.Term	atLeast(int times, Grammar.Term first, Grammar.Term... more)
static Grammar.Term	caseInsensitive(String value)
static Grammar.CharacterSet	charactersOfSet(String name)
static Grammar.Term	epsilon()
static Grammar.Builder	grammar(String language, Grammar.Option... options)
boolean	hasProduction(String name)
String	header()
String	language()
static Grammar.Term	literal(String value)
static Grammar.Term	nonTerminal(String production)
static Grammar.Term	oneOf(Grammar.Term first, Grammar.Term... alternatives)
static Grammar.Term	oneOrMore(Grammar.Term first, Grammar.Term... more)
static Grammar.Term	optional(Grammar.Term first, Grammar.Term... more)
static Grammar	parseXML(InputStream input, Grammar.ParserOption... options)
static Grammar	parseXML(Reader input, Grammar.ParserOption... options)
static Grammar	parseXML(Path input, Grammar.ParserOption... options)
default Production	production(String name)
static Grammar.Term	repeat(int min, int max, Grammar.Term first, Grammar.Term... more)
static Grammar.Term	repeat(int times, Grammar.Term first, Grammar.Term... more)
static Grammar.Term	sequence(Grammar.Term first, Grammar.Term... more)
<P,R,EX extends Exception> R	transform(String production, ProductionTransformation<P,R,EX> xform, P param)
default <P,EX extends Exception> void	transform(ProductionTransformation<P,Void,EX> transformation, P param)
<P,A,R,T,EX extends Exception> T	transform(ProductionTransformation<P,R,EX> transformation, P param, Collector<R,A,T> collector)
static Grammar.Term	zeroOrMore(Grammar.Term first, Grammar.Term... more)

Field Detail

XML_NAMESPACE

static final String XML_NAMESPACE

See Also:

Constant Field Values

SCOPE_XML_NAMESPACE

static final String SCOPE_XML_NAMESPACE

See Also:

Constant Field Values

GENERATOR_XML_NAMESPACE

static final String GENERATOR_XML_NAMESPACE

See Also:

Constant Field Values

RAILROAD_XML_NAMESPACE

static final String RAILROAD_XML_NAMESPACE

See Also:

Constant Field Values

OPENCYPHER_XML_NAMESPACE

static final String OPENCYPHER_XML_NAMESPACE

See Also:

Constant Field Values

ANNOTATION_XML_NAMESPACE

static final String ANNOTATION_XML_NAMESPACE

See Also:

Constant Field Values

Method Detail

parseXML

static Grammar parseXML(Path input,
                        Grammar.ParserOption... options)
                 throws ParserConfigurationException,
                        SAXException,
                        IOException

Throws:

ParserConfigurationException

SAXException

IOException

parseXML

static Grammar parseXML(Reader input,
                        Grammar.ParserOption... options)
                 throws ParserConfigurationException,
                        SAXException,
                        IOException

Throws:

ParserConfigurationException

SAXException

IOException

parseXML

static Grammar parseXML(InputStream input,
                        Grammar.ParserOption... options)
                 throws ParserConfigurationException,
                        SAXException,
                        IOException

Throws:

ParserConfigurationException

SAXException

IOException

language

String language()

header

String header()

accept

<EX extends Exception> void accept(ProductionVisitor<EX> visitor)
                            throws EX extends Exception

Throws:

EX extends Exception

hasProduction

boolean hasProduction(String name)

transform

<P,R,EX extends Exception> R transform(String production,
                                                   ProductionTransformation<P,R,EX> xform,
                                                   P param)
                                            throws EX extends Exception

Throws:

EX extends Exception

transform

default <P,EX extends Exception> void transform(ProductionTransformation<P,Void,EX> transformation,
                                                      P param)
                                               throws EX extends Exception

Throws:

EX extends Exception

transform

<P,A,R,T,EX extends Exception> T transform(ProductionTransformation<P,R,EX> transformation,
                                                                   P param,
                                                                   Collector<R,A,T> collector)
                                                            throws EX extends Exception

Throws:

EX extends Exception

any

default boolean any(Predicate<Production> predicate)

production

default Production production(String name)

grammar

static Grammar.Builder grammar(String language,
                               Grammar.Option... options)

epsilon

static Grammar.Term epsilon()

caseInsensitive

static Grammar.Term caseInsensitive(String value)

literal

static Grammar.Term literal(String value)

charactersOfSet

static Grammar.CharacterSet charactersOfSet(String name)

anyCharacter

static Grammar.CharacterSet anyCharacter()

nonTerminal

static Grammar.Term nonTerminal(String production)

optional

static Grammar.Term optional(Grammar.Term first,
                             Grammar.Term... more)

oneOf

static Grammar.Term oneOf(Grammar.Term first,
                          Grammar.Term... alternatives)

zeroOrMore

static Grammar.Term zeroOrMore(Grammar.Term first,
                               Grammar.Term... more)

oneOrMore

static Grammar.Term oneOrMore(Grammar.Term first,
                              Grammar.Term... more)

atLeast

static Grammar.Term atLeast(int times,
                            Grammar.Term first,
                            Grammar.Term... more)

repeat

static Grammar.Term repeat(int times,
                           Grammar.Term first,
                           Grammar.Term... more)

repeat

static Grammar.Term repeat(int min,
                           int max,
                           Grammar.Term first,
                           Grammar.Term... more)

sequence

static Grammar.Term sequence(Grammar.Term first,
                             Grammar.Term... more)