Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

java.lang.Object

is.codion.framework.model.AbstractEntityModel<M,E,T>

Type Parameters:

M - the type of EntityModel used for detail models

E - the type of EntityEditModel used by this EntityModel

T - the type of EntityTableModel used by this EntityModel

All Implemented Interfaces:

EntityModel<M,E,T>

Direct Known Subclasses:

SwingEntityModel

public abstract class AbstractEntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>
extends Object
implements EntityModel<M,E,T>

An abstract EntityModel implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.framework.model.EntityModel

EntityModel.DetailModels<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityModel(E editModel)	Instantiates a new AbstractEntityModel, without a table model
protected	AbstractEntityModel(T tableModel)	Instantiates a new AbstractEntityModel

Method Summary

Modifier and Type	Method	Description
final EntityConnection	connection()	Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.
final EntityConnectionProvider	connectionProvider()
final boolean	containsTableModel()
final EntityModel.DetailModels<M,E,T>	detailModels()
final E	editModel()
final Entities	entities()
final EntityDefinition	entityDefinition()
final EntityType	entityType()
final <B extends ForeignKeyModelLink.Builder<M, E, T, B>> ForeignKeyModelLink.Builder<M,E,T,B>	link(M model)
final T	tableModel()
final String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEntityModel

protected AbstractEntityModel(E editModel)

Instantiates a new AbstractEntityModel, without a table model

Parameters:

editModel - the edit model

AbstractEntityModel

protected AbstractEntityModel(T tableModel)

Instantiates a new AbstractEntityModel

Parameters:

tableModel - the table model

Method Details

toString

public final String toString()

Overrides:

toString in class Object

Returns:

a String representation of this EntityModel, returns the model class name by default

entityType

public final EntityType entityType()

Specified by:

entityType in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the type of the entity this entity model is based on

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the connection provider used by this entity model

connection

public final EntityConnection connection()

Description copied from interface: EntityModel

Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.

Specified by:

connection in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the connection used by this entity model

entities

public final Entities entities()

Specified by:

entities in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the underlying domain entities

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

entityDefinition in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the definition of the underlying entity

editModel

public final E editModel()

Specified by:

editModel in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the EntityEditModel instance used by this EntityModel

tableModel

public final T tableModel()

Specified by:

tableModel in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the EntityTableModel

containsTableModel

public final boolean containsTableModel()

Specified by:

containsTableModel in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

true if this EntityModel contains a EntityTableModel

link

public final <B extends ForeignKeyModelLink.Builder<M,
E,
T,
B>>
ForeignKeyModelLink.Builder<M,E,T,B> link(M model)

Specified by:

link in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Type Parameters:

B - the builder type

Parameters:

model - the model to link to

Returns:

a ForeignKeyModelLink.Builder, based on a fitting foreign key

detailModels

public final EntityModel.DetailModels<M,E,T> detailModels()

Specified by:

detailModels in interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the detail models