com.speedment.config.db

Interface Schema

All Superinterfaces:

Document, HasAlias, HasChildren, HasEnabled, HasMainInterface, HasMutator<SchemaMutator<? extends Schema>>, HasName, HasParent<Dbms>

public interface Schema
extends Document, HasParent<Dbms>, HasEnabled, HasName, HasChildren, HasAlias, HasMainInterface, HasMutator<SchemaMutator<? extends Schema>>

A typed Document that represents a schema instance in the database. A Schema is located inside a Dbms and can have multiple Tables as children.

Author:

Emil Forslund

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SCHEMA
static String	TABLES

Fields inherited from interface com.speedment.config.db.trait.HasEnabled

ENABLED, ENABLED_DEFAULT

Fields inherited from interface com.speedment.config.db.trait.HasAlias

ALIAS

Fields inherited from interface com.speedment.config.db.trait.HasName

NAME

Fields inherited from interface com.speedment.config.Document

DOCUMENT_LIST_TYPE

Method Summary

Modifier and Type	Method and Description
default boolean	isDefaultSchema() Returns true if this schema is the default one, else false.
default Class<Schema>	mainInterface() Returns the Class of the interface of this node.
default SchemaMutator<? extends Schema>	mutator() Returns a DocumentMutator for this Document.
Stream<? extends Table>	tables() Creates a stream of tables located in this document.

Methods inherited from interface com.speedment.config.db.trait.HasParent

getParent, getParentOrThrow

Methods inherited from interface com.speedment.config.db.trait.HasEnabled

isEnabled, of, test

Methods inherited from interface com.speedment.config.db.trait.HasChildren

defaultNameFor

Methods inherited from interface com.speedment.config.db.trait.HasAlias

getAlias, getJavaName, of

Methods inherited from interface com.speedment.config.db.trait.HasName

getName

Methods inherited from interface com.speedment.config.Document

ancestors, children, children, childrenByKey, get, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getData, put, stream

Field Detail

DEFAULT_SCHEMA

static final String DEFAULT_SCHEMA

See Also:

Constant Field Values

TABLES

static final String TABLES

See Also:

Constant Field Values

Method Detail

isDefaultSchema

default boolean isDefaultSchema()

Returns true if this schema is the default one, else false. Default value is true.

Returns:

true if default, else false

tables

Stream<? extends Table> tables()

Creates a stream of tables located in this document.

Returns:

tables

mainInterface

default Class<Schema> mainInterface()

Description copied from interface: HasMainInterface

Returns the Class of the interface of this node.

This should not be overridden by implementing classes!

Specified by:

mainInterface in interface HasMainInterface

Returns:

the main interface class

mutator

default SchemaMutator<? extends Schema> mutator()

Description copied from interface: HasMutator

Returns a DocumentMutator for this Document. A DocumentMutator allows a Document to be updated in a type safe way.

Specified by:

mutator in interface HasMutator<SchemaMutator<? extends Schema>>

Returns:

a DocumentMutator for this Document