EntityClass (Fastnate Generator 1.5.0-SNAPSHOT API)

java.lang.Object
- org.fastnate.generator.context.EntityClass<E>

Type Parameters:

E - The described class
```
public class EntityClass<E>
extends Object
```
Describes the DB relevant metadata of an entity class.

Author:

Tobias Liefke

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createPostInsertStatements(E entity, StatementsWriter writer)` Marks an entity as written and creates any pending update / insert statements.
`AccessStyle`	`getAccessStyle()` The type of access that is used for the properties (field access or bean property access).
`List<Property<? super E,?>>`	`getAdditionalProperties()` Properties of this entity, excluding the `idProperty` or properties from `joinedParentClass`.
`List<Property<? super E,?>>`	`getAllProperties()` All properties of this entity, including `idProperty` and properties from `joinedParentClass`.
`List<List<SingularProperty<E,?>>>`	`getAllUniqueProperties()` All available sets of properties that make up an additional unique identifier for the entities.
`Map<String,javax.persistence.AssociationOverride>`	`getAssociationOverrides()` All association overriddes of this class and the parent classes.
`Map<String,javax.persistence.AttributeOverride>`	`getAttributeOverrides()` All attribute overriddes of this class and the parent classes.
`GeneratorContext`	`getContext()` The current context.
`ColumnExpression`	`getDiscriminator()` The SQL expression that is used for the disciminator column of this class.
`GeneratorColumn`	`getDiscriminatorColumn()` The column for `discriminator`.
`Class<E>`	`getEntityClass()` The represented class.
`String`	`getEntityName()` The entity name.
`ColumnExpression`	`getEntityReference(E entity, String idField, boolean whereExpression)` Creates an expression that references the id of an entity of this class.
`Map<Object,GenerationState>`	`getEntityStates()` The states of written entities.
`EntityClass<? super E>`	`getHierarchyRoot()` The description of the entity class that is the root of the current inheritance hierarchy.
`Property<? super E,?>`	`getIdProperty()` The property that contains the id for the entity.
`javax.persistence.InheritanceType`	`getInheritanceType()` The inheritance type of this class.
`EntityClass<? super E>`	`getJoinedParentClass()` The description of the next entity class that has `InheritanceType.JOINED`, if any.
`Class<? super E>`	`getParentEntityClass()` Only used during `build()` to find the joinedParentClass even if that one references our class.
`GeneratorColumn`	`getPrimaryKeyJoinColumn()` The column that contains the id of this entity if `joinedParentClass` is not `null`.
`Map<String,Property<? super E,?>>`	`getProperties()` Mapping from the name of all persistent properties to their description.
`GeneratorTable`	`getTable()` The main table of the entity.
`List<SingularProperty<E,?>>`	`getUniqueProperties()` The properties that make up an additional unique identifier for the entity.
`UniquePropertyQuality`	`getUniquePropertiesQuality()` Indicates the quality of `uniqueProperties`.
`boolean`	`isNew(E entity)` Indicates that the given entity needs to be written.
`void`	`markExistingEntity(E entity)` Marks a entity reference, where we don't know the ID in the database.
`<V> void`	`markPendingUpdates(E pendingEntity, V entityToUpdate, Property<V,?> propertyToUpdate, Object... arguments)` Marks an update that is necessary when an entity is written (in the future).
`E`	`newInstance()` Creates a new entity of the represented `class`.
`void`	`onPropertiesAvailable(Consumer<EntityClass<E>> listener)` Registers a listener that is called as soon as all properties of this class are built.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - createPostInsertStatements
```
public void createPostInsertStatements(E entity,
                                       StatementsWriter writer)
                                throws IOException
```
    Marks an entity as written and creates any pending update / insert statements.
    
    Parameters:
    
    entity - the entity that exists now in the database
    
    writer - the target of the new statements
    
    Throws:
    
    IOException - if the writer throws one
  - getEntityReference
```
public ColumnExpression getEntityReference(E entity,
                                           String idField,
                                           boolean whereExpression)
```
    Creates an expression that references the id of an entity of this class.
    
    Parameters:
    
    entity - the entity
    
    idField - the field that contains the id, only interesting if the id is an EmbeddedProperty
    
    whereExpression - indicates that the reference is used in a "where" statement
    
    Returns:
    
    the expression - either by using the unique properties or the id of the entity
  - isNew
```
public boolean isNew(E entity)
```
    Indicates that the given entity needs to be written.
    
    Parameters:
    
    entity - the entity to check
    
    Returns:
    
    true if the entity was neither written, nor exists in the database
  - markExistingEntity
```
public void markExistingEntity(E entity)
```
    Marks a entity reference, where we don't know the ID in the database.
    
    Parameters:
    
    entity - the entity to mark
  - markPendingUpdates
```
public <V> void markPendingUpdates(E pendingEntity,
                                   V entityToUpdate,
                                   Property<V,?> propertyToUpdate,
                                   Object... arguments)
```
    Marks an update that is necessary when an entity is written (in the future).
    
    Parameters:
    
    pendingEntity - the entity that needs to be written, before the update can take place
    
    entityToUpdate - the entity to update
    
    propertyToUpdate - the property of the entity to update
    
    arguments - additional arguments
  - newInstance
```
public E newInstance()
```
    Creates a new entity of the represented class.
    
    Returns:
    
    the new entity
  - onPropertiesAvailable
```
public void onPropertiesAvailable(Consumer<EntityClass<E>> listener)
```
    Registers a listener that is called as soon as all properties of this class are built. If the properties are already build, the listener is called immediately.
    
    Parameters:
    
    listener - called as soon as all properties are available
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getContext
```
@Generated(value="lombok")
public GeneratorContext getContext()
```
    The current context.
  - getEntityClass
```
@Nonnull
 @Generated(value="lombok")
public Class<E> getEntityClass()
```
    The represented class.
  - getEntityName
```
@Nonnull
 @Generated(value="lombok")
public String getEntityName()
```
    The entity name.
  - getTable
```
@Nonnull
 @Generated(value="lombok")
public GeneratorTable getTable()
```
    The main table of the entity.
  - getAccessStyle
```
@Generated(value="lombok")
public AccessStyle getAccessStyle()
```
    The type of access that is used for the properties (field access or bean property access).
  - getInheritanceType
```
@Generated(value="lombok")
public javax.persistence.InheritanceType getInheritanceType()
```
    The inheritance type of this class. null if no subclass is known and no inhertance is indicated (using one of the inheritance annotations).
  - getParentEntityClass
```
@Generated(value="lombok")
public Class<? super E> getParentEntityClass()
```
    Only used during build() to find the joinedParentClass even if that one references our class.
  - getJoinedParentClass
```
@Generated(value="lombok")
public EntityClass<? super E> getJoinedParentClass()
```
    The description of the next entity class that has InheritanceType.JOINED, if any.
  - getHierarchyRoot
```
@Generated(value="lombok")
public EntityClass<? super E> getHierarchyRoot()
```
    The description of the entity class that is the root of the current inheritance hierarchy.
  - getDiscriminator
```
@Generated(value="lombok")
public ColumnExpression getDiscriminator()
```
    The SQL expression that is used for the disciminator column of this class. null if no discriminator is used
  - getDiscriminatorColumn
```
@Generated(value="lombok")
public GeneratorColumn getDiscriminatorColumn()
```
    The column for discriminator. null if this class does not belong to a table that contains a discriminator column
  - getPrimaryKeyJoinColumn
```
@Generated(value="lombok")
public GeneratorColumn getPrimaryKeyJoinColumn()
```
    The column that contains the id of this entity if joinedParentClass is not null.
  - getIdProperty
```
@Nullable
 @Generated(value="lombok")
public Property<? super E,?> getIdProperty()
```
    The property that contains the id for the entity. If a joinedParentClass exists, this property is the id property of the parent class.
  - getUniqueProperties
```
@Nullable
 @Generated(value="lombok")
public List<SingularProperty<E,?>> getUniqueProperties()
```
    The properties that make up an additional unique identifier for the entity. Depending on GeneratorContext.getUniquePropertyQuality() and GeneratorContext.getMaxUniqueProperties() this might be null, even if there is a set of available unique properties, if the quality is not enough.
  - getUniquePropertiesQuality
```
@Generated(value="lombok")
public UniquePropertyQuality getUniquePropertiesQuality()
```
    Indicates the quality of uniqueProperties.
  - getAllUniqueProperties
```
@Generated(value="lombok")
public List<List<SingularProperty<E,?>>> getAllUniqueProperties()
```
    All available sets of properties that make up an additional unique identifier for the entities.
  - getProperties
```
@Generated(value="lombok")
public Map<String,Property<? super E,?>> getProperties()
```
    Mapping from the name of all persistent properties to their description.
  - getAllProperties
```
@Generated(value="lombok")
public List<Property<? super E,?>> getAllProperties()
```
    All properties of this entity, including idProperty and properties from joinedParentClass.
  - getAdditionalProperties
```
@Generated(value="lombok")
public List<Property<? super E,?>> getAdditionalProperties()
```
    Properties of this entity, excluding the idProperty or properties from joinedParentClass.
  - getEntityStates
```
@Generated(value="lombok")
public Map<Object,GenerationState> getEntityStates()
```
    The states of written entities. Only interesting for pending updates and if the ID is not generated.
  - getAttributeOverrides
```
@Generated(value="lombok")
public Map<String,javax.persistence.AttributeOverride> getAttributeOverrides()
```
    All attribute overriddes of this class and the parent classes.
  - getAssociationOverrides
```
@Generated(value="lombok")
public Map<String,javax.persistence.AssociationOverride> getAssociationOverrides()
```
    All association overriddes of this class and the parent classes.

Class EntityClass<E>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createPostInsertStatements

getEntityReference

isNew

markExistingEntity

markPendingUpdates

newInstance

onPropertiesAvailable

toString

getContext

getEntityClass

getEntityName

getTable

getAccessStyle

getInheritanceType

getParentEntityClass

getJoinedParentClass

getHierarchyRoot

getDiscriminator

getDiscriminatorColumn

getPrimaryKeyJoinColumn

getIdProperty

getUniqueProperties

getUniquePropertiesQuality

getAllUniqueProperties

getProperties

getAllProperties

getAdditionalProperties

getEntityStates

getAttributeOverrides

getAssociationOverrides