org.modeshape.sequencer.ddl
Class DdlParsers

java.lang.Object
  org.modeshape.sequencer.ddl.DdlParsers

@Immutable
public class DdlParsers
extends Object

A set of parsers capable of understanding DDL file content. This class can be used directly to create an AstNode tree representing nodes and properties for DDL statement components.

You can also provide an input or parent AstNode node as the starting point for your tree.

The parser is based on the SQL-92 and extended by specific dialects. These dialect-specific parsers provide db-specific parsing of db-specific statements of statement extensions, features or properties.

Field Summary

static List<DdlParser>

BUILTIN_PARSERS

Constructor Summary

DdlParsers()
Create an instance that uses all of the built-in parsers.

DdlParsers(List<DdlParser> parsers)
Create an instance that uses the supplied parsers, in order.

Method Summary

AstNode	parse(String ddl, String fileName) Parse the supplied DDL content and return the root node of the AST representation.
AstNode	parseUsing(String ddl, String parserId)

Methods inherited from class java.lang.Object

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

Field Detail

BUILTIN_PARSERS

public static final List<DdlParser> BUILTIN_PARSERS

Constructor Detail

DdlParsers

public DdlParsers()

Create an instance that uses all of the built-in parsers.

DdlParsers

public DdlParsers(List<DdlParser> parsers)

Create an instance that uses the supplied parsers, in order.

Parameters:

parsers - the list of parsers; may be empty or null if the built-in parsers should be used

Method Detail

parseUsing

public AstNode parseUsing(String ddl,
                          String parserId)
                   throws ParsingException

Parameters:

ddl - the DDL being parsed (cannot be null or empty)

parserId - the identifier of the parser to use (can be null or empty if best matched parser should be used)

Returns:

the root tree AstNode

Throws:

ParsingException - if there is an error parsing the supplied DDL content

IllegalArgumentException - if a parser with the specified identifier cannot be found

parse

public AstNode parse(String ddl,
                     String fileName)
              throws ParsingException

Parse the supplied DDL content and return the root node of the AST representation.

Parameters:

ddl - content string; may not be null

fileName - the approximate name of the file containing the DDL content; may be null if this is not known

Returns:

the root tree AstNode

Throws:

ParsingException - if there is an error parsing the supplied DDL content