com.speedment.code

Interface Translator<DOC extends Document & HasMainInterface,T>

Type Parameters:

DOC - the Document type to use

T - the codegen type to make (Class, Interface or Enum)

All Superinterfaces:

Supplier<File>

All Known Subinterfaces:

JavaClassTranslator<DOC,T>

public interface Translator<DOC extends Document & HasMainInterface,T>
extends Supplier<File>

Something that can translate a Document into something else. This interface is implemented to generate more files from the same database structure.

Since:

2.3

Author:

pemi

See Also:

Document

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Translator.Builder<T> A general interface for all builder implementations used by this Translator.
static class	Translator.Phase The make process is divided into three phases; Translator.Phase.PRE_MAKE, Translator.Phase.MAKE and Translator.Phase.POST_MAKE, as specified by this enum.

Method Summary

Modifier and Type	Method and Description
default Optional<Column>	column() Return this node or any ancestral node that is a Column.
default Stream<? extends Column>	columns() Returns a stream over all enabled columns in the node tree.
default Optional<Dbms>	dbms() Return this node or any ancestral node that is a Dbms.
default Stream<? extends ForeignKey>	foreignKeys() Returns a stream over all enabled foreign keys in the node tree.
default Meta<File,String>	generate() Generates code for the Document contained in this Translator.
default HasAlias	getAliasDocument() The document being translated wrapped in a HasAlias.
Generator	getCodeGenerator() Returns the CodeGen Generator used by this Translator.
DOC	getDocument() The document being translated.
default <E extends Document> Optional<E>	getDocument(Class<E> clazz) Returns this node or one of the ancestor nodes if it matches the specified Class.
default Stream<? extends Index>	indexes() Returns a stream over all enabled indexes in the node tree.
boolean	isInGeneratedPackage() Returns true if the file generated by this Translator should be located in a .generated. package.
Stream<BiConsumer<File,Translator.Builder<T>>>	listeners() Returns a Stream of the listeners currently part of the make process of this Translator.
void	onMake(BiConsumer<File,Translator.Builder<T>> action) Append an additional action that should be executed as part of the make process of this translator.
default void	onMake(Consumer<Translator.Builder<T>> action) Append an additional action that should be executed as part of the make process of this translator.
default Stream<? extends PrimaryKeyColumn>	primaryKeyColumns() Returns a stream over all enabled primary key columns in the node tree.
default Optional<Project>	project() Return this node or any ancestral node that is a Project.
default Optional<Schema>	schema() Return this node or any ancestral node that is a Schema.
default Optional<Table>	table() Return this node or any ancestral node that is a Table.
default String	toCode() Generates and returns the code translated from the contained Document by this Translator.

Methods inherited from interface java.util.function.Supplier

get

Method Detail

project

default Optional<Project> project()

Return this node or any ancestral node that is a Project. If no such node exists, an IllegalStateException is thrown.

Returns:

the project node

dbms

default Optional<Dbms> dbms()

Return this node or any ancestral node that is a Dbms. If no such node exists, an IllegalStateException is thrown.

Returns:

the dbms node

schema

default Optional<Schema> schema()

Return this node or any ancestral node that is a Schema. If no such node exists, an IllegalStateException is thrown.

Returns:

the schema node

table

default Optional<Table> table()

Return this node or any ancestral node that is a Table. If no such node exists, an IllegalStateException is thrown.

Returns:

the table node

column

default Optional<Column> column()

Return this node or any ancestral node that is a Column. If no such node exists, an IllegalStateException is thrown.

Returns:

the column node

columns

default Stream<? extends Column> columns()

Returns a stream over all enabled columns in the node tree. Disabled nodes will be ignored.

Returns:

the enabled columns

See Also:

Column, HasEnabled.isEnabled()

indexes

default Stream<? extends Index> indexes()

Returns a stream over all enabled indexes in the node tree. Disabled nodes will be ignored.

Returns:

the enabled indexes

See Also:

Index, HasEnabled.isEnabled()

foreignKeys

default Stream<? extends ForeignKey> foreignKeys()

Returns a stream over all enabled foreign keys in the node tree. Disabled nodes will be ignored.

Returns:

the enabled foreign keys

See Also:

ForeignKey, HasEnabled.isEnabled()

primaryKeyColumns

default Stream<? extends PrimaryKeyColumn> primaryKeyColumns()

Returns a stream over all enabled primary key columns in the node tree. Disabled nodes will be ignored.

Returns:

the enabled primary key columns

See Also:

PrimaryKeyColumn, HasEnabled.isEnabled()

getDocument

DOC getDocument()

The document being translated.

Returns:

the document

getDocument

default <E extends Document> Optional<E> getDocument(Class<E> clazz)

Returns this node or one of the ancestor nodes if it matches the specified Class. If no such node exists, an IllegalStateException is thrown.

Type Parameters:

E - the type of the class to match

Parameters:

clazz - the class to match

Returns:

the node found

getAliasDocument

default HasAlias getAliasDocument()

The document being translated wrapped in a HasAlias.

Returns:

the document

generate

default Meta<File,String> generate()

Generates code for the Document contained in this Translator.

Returns:

the generated meta info

toCode

default String toCode()

Generates and returns the code translated from the contained Document by this Translator.

Returns:

the generated code

isInGeneratedPackage

boolean isInGeneratedPackage()

Returns true if the file generated by this Translator should be located in a .generated. package. Files located in such a package will be overwritten each time the generator runs.

Returns:

true if located in .generated., else false

getCodeGenerator

Generator getCodeGenerator()

Returns the CodeGen Generator used by this Translator. This can be used to add dependencies to the runtime or to install new views.

Returns:

the Generator used

onMake

default void onMake(Consumer<Translator.Builder<T>> action)

Append an additional action that should be executed as part of the make process of this translator. This method is useful for adding additional methods, fields or internal classes based on the configuration model.

If the action requires additional Import statements to be added to the generated file, the onMake(BiConsumer) method should be used instead.

Parameters:

action - the action to perform

See Also:

onMake(BiConsumer)

onMake

void onMake(BiConsumer<File,Translator.Builder<T>> action)

Append an additional action that should be executed as part of the make process of this translator. This method is useful for adding additional methods, fields or internal classes based on the configuration model.

This method allows the action to affect both the Translator.Builder and the file where the class or interface will be located. This should be used if the specified action require additional Import statements to be added to the file.

Parameters:

action - the action to perform

See Also:

onMake(BiConsumer)

listeners

Stream<BiConsumer<File,Translator.Builder<T>>> listeners()

Returns a Stream of the listeners currently part of the make process of this Translator.

Returns:

Stream of all listeners