Uses of Interface
org.tentackle.model.Entity

Packages that use Entity

Package	Description
org.tentackle.model	Entity model.
org.tentackle.model.impl	Default model implementation.
org.tentackle.model.migrate	Database migration support.
org.tentackle.model.print	Model pretty printing.

Uses of Entity in org.tentackle.model

Methods in org.tentackle.model that return Entity

Modifier and Type	Method	Description
Entity	EntityFactory.createEntity(Document document, ModelDefaults modelDefaults)	Creates an entity from a model source.
Entity	EntityFactory.createEntity(SourceInfo sourceInfo)	Creates an empty entity.
Entity	Model.getByClassId(int classId)	Gets the entity by its class id.
Entity	Model.getByEntityName(String entityName)	Gets the entity by its name.
Entity	Model.getByTableName(String tableName)	Gets the entity by its table name.
Entity	Model.getByURL(URL url)	Gets the entity by the model file path.
Entity	Attribute.getEmbeddingEntity()	Gets the embedding entity. Please notice that the embedding entity is determined by the specific relation, and Attribute.isEmbedded() just means that the attribute is part of an embeddable entity.
Entity	Relation.getEmbeddingEntity()	Gets the embedding entity. Please notice that the embedding entity is determined by the specific relation path, and Relation.isEmbedded() just means that the relation is part of an embeddable entity.
Entity	Attribute.getEntity()	Gets the entity this attribute belongs to.
Entity	EntityInfo.getEntity()	Gets the entity.
Entity	EntityOptions.getEntity()	Gets the entity this option-set belongs to.
Entity	Index.getEntity()	Gets the entity this index belongs to.
Entity	Relation.getEntity()	Gets the entity this relation belongs to.
Entity	Relation.getForeignEntity()	Gets the related entity.
Entity	ForeignKey.getReferencedEntity()	Gets the referenced entity.
Entity	ForeignKey.getReferencedTableProvidingEntity()	Gets the entity that provides the table for the referenced entity.
Entity	ForeignKey.getReferencingEntity()	Gets the referencing entity.
Entity	ForeignKey.getReferencingTableProvidingEntity()	Gets the entity that provides the table for the referencing entity.
Entity	Entity.getRootEntity()	Returns the single root entity, if there is exactly one, and it is not abstract.
Entity	Entity.getSuperEntity()	Gets the super class entity if inherited.
Entity	Entity.getTableProvidingEntity()	Gets the entity that provides the database table.
Entity	Entity.getTopSuperEntity()	Gets the top most entity of the inheritance tree. Returns this entity if there is no inheritance.

Methods in org.tentackle.model that return types with arguments of type Entity

Modifier and Type	Method	Description
Set<Entity>	Entity.getAllComponents()	Gets all direct and indirect components of this entity.
Collection<Entity>	Model.getAllEntities()	Gets all cached entities.
List<Entity>	Entity.getAllSubEntities()	Gets all sub entities.
Set<Entity>	Entity.getAssociatedEntities()	Gets a set of all entities that are associated to this entity. The kind of association can be a relation, a foreign relation or some hierarchy dependency or a combination of.
Set<Entity>	Entity.getComponents()	Gets the direct components of this entity.
Set<Entity>	Entity.getComponentsIncludingInherited()	Gets the direct and inherited components of this entity.
Set<Entity>	Entity.getEmbeddingEntities()	Gets the embedding entities for this embedded entity.
List<Entity>	Attribute.getEmbeddingPath()	Gets the path of embedding entities. The first entity is non-embedded.
List<Entity>	Relation.getEmbeddingPath()	Gets the path of embedding entities. The first entity is non-embedded.
List<Entity>	Entity.getInheritanceChain(Entity subEntity)	Gets the inheritance chain from this entity down to given sub entity.
List<Entity>	Entity.getLeafEntities()	Gets the list of non-abstract leaf sub entities. If this entity is already non-abstract the list consists of this entity.
Set<Entity>	Entity.getRootEntities()	Returns the root entities. Returns all roots, even abstract ones.
List<Entity>	Entity.getSubEntities()	Gets the direct sub entities.
List<Entity>	Entity.getSuperEntities()	Gets all super entities.

Methods in org.tentackle.model with parameters of type Entity

Modifier and Type	Method	Description
Attribute	EntityFactory.createAttribute(Entity entity, SourceInfo sourceInfo, boolean implicit)	Creates an attribute.
String	Index.createDatabaseIndexName(Entity entity)	Creates the database index name for given entity.
Attribute	Attribute.createEmbedded(Entity embeddingEntity, String pathName, String columnName)	Creates an embedded copy of this attribute.
Relation	Relation.createEmbedded(Entity embeddingEntity, String pathName, String columnPrefixPath)	Creates an embedded copy of this relation.
EntityOptions	EntityFactory.createEntityOptions(Entity entity, SourceInfo sourceInfo)	Creates entity options.
Index	EntityFactory.createIndex(Entity entity, SourceInfo sourceInfo)	Creates an index.
Relation	EntityFactory.createRelation(Entity entity, SourceInfo sourceInfo)	Creates a relation.
String	CodeFactory.createSqlIndex(Backend backend, Entity entity, Index index)	Creates the SQL code to create an index.
String	CodeFactory.createSqlTable(Entity entity, Backend backend)	Creates the table creation sql code.
List<Relation>	Entity.getEmbeddedRelations(Entity embeddingEntity)	Gets the relations of all embedded entities. Due to the restriction of embedded entities, these relations are all non-composite object relations.
EntityInfo	Model.getEntityInfo(Entity entity)	Gets the model information for the given entity.
List<Entity>	Entity.getInheritanceChain(Entity subEntity)	Gets the inheritance chain from this entity down to given sub entity.
List<Relation>	Entity.getRelations(Entity entity, boolean all)	Gets all relations for a given entity type.
String	Index.sqlCreateIndex(Backend backend, Entity entity)	Creates the index creation sql code.
String	NameVerifier.verifyEntityName(Entity entity)	Verifies the Java name of an entity.
String	NameVerifier.verifyTableAlias(Entity entity)	Verifies the table alias of an entity.
String	NameVerifier.verifyTableName(Entity entity)	Verifies the table name of an entity.

Uses of Entity in org.tentackle.model.impl

Classes in org.tentackle.model.impl that implement Entity

Modifier and Type	Class	Description
class	EntityImpl	The entity model implementation.

Methods in org.tentackle.model.impl that return Entity

Modifier and Type	Method	Description
Entity	EntityFactoryImpl.createEntity(Document document, ModelDefaults modelDefaults)
Entity	ModelImpl.getByClassId(int classId)
Entity	ModelImpl.getByEntityName(String entityName)
Entity	ModelImpl.getByTableName(String tableName)
Entity	ModelImpl.getByURL(URL url)
Entity	AttributeImpl.getEmbeddingEntity()
Entity	RelationImpl.getEmbeddingEntity()
Entity	AttributeImpl.getEntity()
Entity	EntityInfoImpl.getEntity()
Entity	EntityOptionsImpl.getEntity()
Entity	IndexImpl.getEntity()
Entity	RelationImpl.getEntity()
Entity	RelationImpl.getForeignEntity()
Entity	ForeignKeyImpl.getReferencedEntity()
Entity	ForeignKeyImpl.getReferencedTableProvidingEntity()
Entity	ForeignKeyImpl.getReferencingEntity()
Entity	ForeignKeyImpl.getReferencingTableProvidingEntity()
Entity	EntityImpl.getRootEntity()
Entity	EntityImpl.getSuperEntity()
Entity	EntityImpl.getTableProvidingEntity()
Entity	EntityImpl.getTopSuperEntity()

Methods in org.tentackle.model.impl that return types with arguments of type Entity

Modifier and Type	Method	Description
Set<Entity>	EntityImpl.getAllComponents()
Collection<Entity>	ModelImpl.getAllEntities()
List<Entity>	EntityImpl.getAllSubEntities()
Set<Entity>	EntityImpl.getAssociatedEntities()
Set<Entity>	EntityImpl.getComponents()
Set<Entity>	EntityImpl.getComponentsIncludingInherited()
Set<Entity>	EntityImpl.getEmbeddingEntities()
List<Entity>	AttributeImpl.getEmbeddingPath()
List<Entity>	RelationImpl.getEmbeddingPath()
List<Entity>	EntityImpl.getInheritanceChain(Entity childEntity)
List<Entity>	EntityImpl.getLeafEntities()
Set<Entity>	EntityImpl.getRootEntities()
List<Entity>	EntityImpl.getSubEntities()
List<Entity>	EntityImpl.getSuperEntities()

Methods in org.tentackle.model.impl with parameters of type Entity

Modifier and Type	Method	Description
protected List<Attribute>	EntityImpl.appendIdSerial(Entity entity, List<Attribute> attributes)	Appends id and serial from another entity.
protected boolean	ModelImpl.applyTableAlias(Map<String,Entity> aliasMap, Entity entity, String alias)	Applies the table alias if unique and valid.
protected void	EntityImpl.collectAssociatedEntities(Set<Entity> associates, Entity entity, Set<Entity> processedEntities)	Recursively collects the associated entities for a given entity.
protected void	EntityImpl.collectLeafEntities(List<Entity> leafs, Entity entity)	Recursively collects the leaf children.
protected void	EntityImpl.collectSubEntities(List<Entity> subEntities, Entity entity)	Recursively collects all sub entities.
AttributeImpl	EntityFactoryImpl.createAttribute(Entity entity, SourceInfo sourceInfo, boolean implicit)
String	IndexImpl.createDatabaseIndexName(Entity entity)
Attribute	AttributeImpl.createEmbedded(Entity embeddingEntity, String pathName, String columnName)
RelationImpl	RelationImpl.createEmbedded(Entity embeddingEntity, String pathName, String columnPrefixPath)
EntityOptionsImpl	EntityFactoryImpl.createEntityOptions(Entity entity, SourceInfo sourceInfo)
IndexImpl	EntityFactoryImpl.createIndex(Entity entity, SourceInfo sourceInfo)
RelationImpl	EntityFactoryImpl.createRelation(Entity entity, SourceInfo sourceInfo)
List<Relation>	EntityImpl.getEmbeddedRelations(Entity embeddingEntity)
EntityInfo	ModelImpl.getEntityInfo(Entity entity)
List<Entity>	EntityImpl.getInheritanceChain(Entity childEntity)
List<Relation>	EntityImpl.getRelations(Entity entity, boolean all)
protected void	EntityImpl.getUniqueDomainKeyImpl(List<Attribute> uniqueDomainKeys, Entity entity)	Adds the unique domain keys recursively for given entity to the list.
protected boolean	NameVerifierImpl.isAllUpperOrLowerCase(String name, Entity entity)	Checks whether the given name is all upper- or all lowercase. The backends are usually not case-sensitive (unless the SQL names are quoted), but it is good style to either use all upper- or all lowercase.
protected boolean	NameVerifierImpl.isNotQuotedOrProvided(String name, Entity entity)	Checks whether the name is quoted.
void	AttributeImpl.parse(Entity entity, AttributeLine line)	Parses an attribute line.
void	IndexImpl.parse(Entity entity)	Parses a configuration line.
void	RelationImpl.parse(Entity entity, RelationLine line)	Parses a relation line.
void	RelationImpl.setForeignEntity(Entity foreignEntity)
void	EntityImpl.setSuperEntity(Entity superEntity)	Sets the super entity.
String	IndexImpl.sqlCreateIndex(Backend backend, Entity entity)
protected void	ModelImpl.updateCompositePath(List<Relation> compositePath, Entity entity)	Updates the composite path.
protected void	ModelImpl.validateComponents(Entity entity, Integrity integrity, Set<ModelError> errors)	Verifies that the integrity is the same within a given composite hierarchy.
protected void	ModelImpl.validateInheritanceHierarchy(Entity entity, InheritanceType inheritanceType, TrackType trackType, Integrity integrity, Set<ModelError> errors)	Verifies that the inheritance, integrity and track type is the same within a given inheritance hierarchy. Notice that concrete classes (the leafs of the hierarchy) must have InheritanceType.NONE defined!
String	NameVerifierImpl.verifyEntityName(Entity entity)
String	NameVerifierImpl.verifyTableAlias(Entity entity)
String	NameVerifierImpl.verifyTableName(Entity entity)

Method parameters in org.tentackle.model.impl with type arguments of type Entity

Modifier and Type	Method	Description
protected boolean	ModelImpl.applyTableAlias(Map<String,Entity> aliasMap, Entity entity, String alias)	Applies the table alias if unique and valid.
protected void	EntityImpl.collectAssociatedEntities(Set<Entity> associates, Entity entity, Set<Entity> processedEntities)	Recursively collects the associated entities for a given entity.
protected void	EntityImpl.collectLeafEntities(List<Entity> leafs, Entity entity)	Recursively collects the leaf children.
protected void	EntityImpl.collectSubEntities(List<Entity> subEntities, Entity entity)	Recursively collects all sub entities.

Constructors in org.tentackle.model.impl with parameters of type Entity

Modifier	Constructor	Description
	AttributeImpl(EntityFactoryImpl factory, Entity entity, SourceInfo sourceInfo, boolean implicit)	Creates an attribute.
	AttributeImpl(EntityFactoryImpl factory, Entity entity, SourceInfo sourceInfo, boolean implicit, AttributeOptionsImpl options)	Creates an attribute.
	EntityInfoImpl(Entity entity, URL url, String modelSource, ModelDefaults defaults)	Creates a model entity.
	EntityOptionsImpl(EntityFactory factory, Entity entity, SourceInfo sourceInfo)	Creates entity options.
	ForeignKeyImpl(Entity referencingEntity, Attribute referencingAttribute, Entity referencedEntity, Attribute referencedAttribute, boolean composite)	Creates a foreign key.
	IndexImpl(EntityFactoryImpl factory, Entity entity, SourceInfo sourceInfo)	Creates an index.
	RelationImpl(Entity entity, SourceInfo sourceInfo)	Creates a relation.

Uses of Entity in org.tentackle.model.migrate

Methods in org.tentackle.model.migrate that return Entity

Modifier and Type	Method	Description
Entity	ColumnMigrator.getEntity()	Gets the migrated entity.
Entity	IndexMigrator.getEntity()	Gets the migrated entity.
Entity	TableMigrator.getEntity()	Gets the model's entity.

Constructors in org.tentackle.model.migrate with parameters of type Entity

Modifier	Constructor	Description
	ColumnMigrator(Entity entity, Attribute attribute, Backend backend, Collection<ColumnMetaData> columns)	Creates a column migrator.
	ColumnMigrator(Entity entity, Attribute attribute, Backend backend, ColumnMetaData... columns)	Creates a column migrator.
	IndexMigrator(Entity entity, Index index, Backend backend, IndexMetaData indexMetaData)	Creates a migrator.
	TableMigrator(Entity entity, Collection<ForeignKey> foreignKeys, Backend backend, TableMetaData table)	Creates a table migrator.

Uses of Entity in org.tentackle.model.print

Constructors in org.tentackle.model.print with parameters of type Entity

Modifier	Constructor	Description
	AttributeSectionPrinter(Entity entity, PrintConfiguration configuration)	Creates a section printer.
	EntityPrinter(Entity entity, PrintConfiguration configuration)	Creates an entity printer.
	GlobalOptionsPrinter(Entity entity, PrintConfiguration configuration)	Creates the printer.