com.speedment.runtime.config

Interface ForeignKeyColumn

All Superinterfaces:

Document, HasColumn, HasId, HasMainInterface, HasMutator<ForeignKeyColumnMutator<? extends ForeignKeyColumn>>, HasName, HasOrdinalPosition, HasParent<ForeignKey>

public interface ForeignKeyColumn
extends Document, HasParent<ForeignKey>, HasId, HasName, HasOrdinalPosition, HasColumn, HasMainInterface, HasMutator<ForeignKeyColumnMutator<? extends ForeignKeyColumn>>

A typed Document that represents the column referenced by a foreign key instance in the database. A ForeignKeyColumn is located inside a ForeignKey.

Since:

2.0.0

Author:

Emil Forslund

Field Summary

Fields

Modifier and Type	Field and Description
static String	FOREIGN_COLUMN_NAME
static String	FOREIGN_DATABASE_NAME
static String	FOREIGN_SCHEMA_NAME
static String	FOREIGN_TABLE_NAME

Fields inherited from interface com.speedment.runtime.config.trait.HasOrdinalPosition

COMPARATOR, ORDINAL_POSITION

Fields inherited from interface com.speedment.runtime.config.trait.HasId

ID

Method Summary

Modifier and Type	Method and Description
default Optional<? extends Column>	findForeignColumn() A helper method for accessing the foreign Column referenced by this key.
default Optional<? extends Table>	findForeignTable() A helper method for accessing the foreign Table referenced by this key.
default String	getForeignColumnName() Returns the name of the foreign table referenced by this column.
default String	getForeignDatabaseName() Returns the name of the foreign database referenced by this column.
default String	getForeignSchemaName() Returns the name of the foreign schema(depends on DBMS type) referenced by this column.
default String	getForeignTableName() Returns the name of the foreign column referenced by this column.
default Class<ForeignKeyColumn>	mainInterface() Returns the Class of the interface of this node.
default ForeignKeyColumnMutator<? extends ForeignKeyColumn>	mutator() Returns a DocumentMutator for this Document.

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

getParent, getParentOrThrow

Methods inherited from interface com.speedment.runtime.config.trait.HasOrdinalPosition

getOrdinalPosition, of

Methods inherited from interface com.speedment.runtime.config.trait.HasColumn

findColumn, of

Methods inherited from interface com.speedment.runtime.config.trait.HasId

getId

Methods inherited from interface com.speedment.runtime.config.Document

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

Field Detail

FOREIGN_TABLE_NAME

static final String FOREIGN_TABLE_NAME

See Also:

Constant Field Values

FOREIGN_COLUMN_NAME

static final String FOREIGN_COLUMN_NAME

See Also:

Constant Field Values

FOREIGN_DATABASE_NAME

static final String FOREIGN_DATABASE_NAME

See Also:

Constant Field Values

FOREIGN_SCHEMA_NAME

static final String FOREIGN_SCHEMA_NAME

See Also:

Constant Field Values

Method Detail

getForeignDatabaseName

default String getForeignDatabaseName()

Returns the name of the foreign database referenced by this column.

Returns:

the name of the foreign database

getForeignSchemaName

default String getForeignSchemaName()

Returns the name of the foreign schema(depends on DBMS type) referenced by this column.

Returns:

the name of the foreign schema

getForeignTableName

default String getForeignTableName()

Returns the name of the foreign column referenced by this column.

Returns:

the name of the foreign column

getForeignColumnName

default String getForeignColumnName()

Returns the name of the foreign table referenced by this column.

Returns:

the name of the foreign table

findForeignTable

default Optional<? extends Table> findForeignTable()

A helper method for accessing the foreign Table referenced by this key.

Returns:

the foreign Table referenced by this

findForeignColumn

default Optional<? extends Column> findForeignColumn()

A helper method for accessing the foreign Column referenced by this key.

Returns:

the foreign Column referenced by this

mainInterface

default Class<ForeignKeyColumn> 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 ForeignKeyColumnMutator<? extends ForeignKeyColumn> 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<ForeignKeyColumnMutator<? extends ForeignKeyColumn>>

Returns:

a DocumentMutator for this Document