org.modeshape.schematic

Class Schematic

java.lang.Object

org.modeshape.schematic.DocumentFactory

org.modeshape.schematic.Schematic

public class Schematic
extends DocumentFactory

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_FIELD

Fields inherited from class org.modeshape.schematic.DocumentFactory

DEFAULT_FACTORY

Constructor Summary

Constructors

Constructor and Description
Schematic()

Method Summary

Modifier and Type	Method and Description
static SchemaLibrary	createSchemaLibrary() Create an in-memory schema library.
static SchemaLibrary	createSchemaLibrary(String name) Create an in-memory schema library.
static <T extends SchematicDb> T	getDb(Document document) Returns a DB with the given configuration document Document.
static <T extends SchematicDb> T	getDb(Document document, ClassLoader cl) Returns a DB with the given type and configuration document, by delegating to all the available SchematicDbProvider services.
static <T extends SchematicDb> T	getDb(InputStream configInputStream) Returns a DB with reads the given input stream as a configuration document Document.

Methods inherited from class org.modeshape.schematic.DocumentFactory

newArray, newArray, newArray, newArray, newDocument, newDocument, newDocument, newDocument, newDocument, newDocument

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_FIELD

public static final String TYPE_FIELD

See Also:

Constant Field Values

Constructor Detail

Schematic

public Schematic()

Method Detail

getDb

public static <T extends SchematicDb> T getDb(InputStream configInputStream)
                                       throws ParsingException,
                                              RuntimeException

Returns a DB with reads the given input stream as a configuration document Document. This document is expected to contain a type field to indicate the type of DB.

Throws:

ParsingException - if the given input stream is not a valid JSON document

RuntimeException

See Also:

getDb(Document, ClassLoader)

getDb

public static <T extends SchematicDb> T getDb(Document document)
                                       throws RuntimeException

Returns a DB with the given configuration document Document. This document is expected to contain a type field to indicate the type of DB.

Throws:

RuntimeException

See Also:

getDb(Document, ClassLoader)

getDb

public static <T extends SchematicDb> T getDb(Document document,
                                              ClassLoader cl)
                                       throws RuntimeException

Returns a DB with the given type and configuration document, by delegating to all the available SchematicDbProvider services. This document is expected to contain a type field to indicate the type

Parameters:

document - a Document containing the configuration of a particular DB type; may not be null

cl - a ClassLoader instance to be used when searching for available DB provider.

Returns:

a SchematicDb instance with the given alias, never null

Throws:

RuntimeException - if a DB with the given alias cannot be found or it fails during initialization

createSchemaLibrary

public static SchemaLibrary createSchemaLibrary()

Create an in-memory schema library.

Returns:

the empty, in-memory schema library

createSchemaLibrary

public static SchemaLibrary createSchemaLibrary(String name)

Create an in-memory schema library.

Parameters:

name - the name of the library; may be null if a default name is to be used

Returns:

the empty, in-memory schema library