Entity (Hibernate JavaDocs)

java.lang.Object
- org.hibernate.jpamodelgen.xml.jaxb.Entity

```
public class Entity
extends Object
```
Defines the settings and mappings for an entity. Is allowed to be sparsely populated and used in conjunction with the annotations. Alternatively, the metadata-complete attribute can be used to indicate that no annotations on the entity class (and its fields or properties) are to be processed. If this is the case then the defaulting rules for the entity and its subelements will be recursively applied.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AccessType`	`access`
`protected List<AssociationOverride>`	`associationOverride`
`protected List<AttributeOverride>`	`attributeOverride`
`protected Attributes`	`attributes`
`protected Boolean`	`cacheable`
`protected String`	`clazz`
`protected List<Convert>`	`convert`
`protected String`	`description`
`protected DiscriminatorColumn`	`discriminatorColumn`
`protected String`	`discriminatorValue`
`protected EntityListeners`	`entityListeners`
`protected EmptyType`	`excludeDefaultListeners`
`protected EmptyType`	`excludeSuperclassListeners`
`protected IdClass`	`idClass`
`protected Inheritance`	`inheritance`
`protected Boolean`	`metadataComplete`
`protected String`	`name`
`protected List<NamedEntityGraph>`	`namedEntityGraph`
`protected List<NamedNativeQuery>`	`namedNativeQuery`
`protected List<NamedQuery>`	`namedQuery`
`protected List<NamedStoredProcedureQuery>`	`namedStoredProcedureQuery`
`protected PostLoad`	`postLoad`
`protected PostPersist`	`postPersist`
`protected PostRemove`	`postRemove`
`protected PostUpdate`	`postUpdate`
`protected PrePersist`	`prePersist`
`protected PreRemove`	`preRemove`
`protected PreUpdate`	`preUpdate`
`protected ForeignKey`	`primaryKeyForeignKey`
`protected List<PrimaryKeyJoinColumn>`	`primaryKeyJoinColumn`
`protected List<SecondaryTable>`	`secondaryTable`
`protected SequenceGenerator`	`sequenceGenerator`
`protected List<SqlResultSetMapping>`	`sqlResultSetMapping`
`protected Table`	`table`
`protected TableGenerator`	`tableGenerator`

Constructor Summary

Constructors
Constructor and Description

Entity()

Constructors
Constructor and Description
`Entity()`

Method Summary

Methods
Modifier and Type	Method and Description
`AccessType`	`getAccess()` Gets the value of the access property.
`List<AssociationOverride>`	`getAssociationOverride()` Gets the value of the associationOverride property.
`List<AttributeOverride>`	`getAttributeOverride()` Gets the value of the attributeOverride property.
`Attributes`	`getAttributes()` Gets the value of the attributes property.
`String`	`getClazz()` Gets the value of the clazz property.
`List<Convert>`	`getConvert()` Gets the value of the convert property.
`String`	`getDescription()` Gets the value of the description property.
`DiscriminatorColumn`	`getDiscriminatorColumn()` Gets the value of the discriminatorColumn property.
`String`	`getDiscriminatorValue()` Gets the value of the discriminatorValue property.
`EntityListeners`	`getEntityListeners()` Gets the value of the entityListeners property.
`EmptyType`	`getExcludeDefaultListeners()` Gets the value of the excludeDefaultListeners property.
`EmptyType`	`getExcludeSuperclassListeners()` Gets the value of the excludeSuperclassListeners property.
`IdClass`	`getIdClass()` Gets the value of the idClass property.
`Inheritance`	`getInheritance()` Gets the value of the inheritance property.
`String`	`getName()` Gets the value of the name property.
`List<NamedEntityGraph>`	`getNamedEntityGraph()` Gets the value of the namedEntityGraph property.
`List<NamedNativeQuery>`	`getNamedNativeQuery()` Gets the value of the namedNativeQuery property.
`List<NamedQuery>`	`getNamedQuery()` Gets the value of the namedQuery property.
`List<NamedStoredProcedureQuery>`	`getNamedStoredProcedureQuery()` Gets the value of the namedStoredProcedureQuery property.
`PostLoad`	`getPostLoad()` Gets the value of the postLoad property.
`PostPersist`	`getPostPersist()` Gets the value of the postPersist property.
`PostRemove`	`getPostRemove()` Gets the value of the postRemove property.
`PostUpdate`	`getPostUpdate()` Gets the value of the postUpdate property.
`PrePersist`	`getPrePersist()` Gets the value of the prePersist property.
`PreRemove`	`getPreRemove()` Gets the value of the preRemove property.
`PreUpdate`	`getPreUpdate()` Gets the value of the preUpdate property.
`ForeignKey`	`getPrimaryKeyForeignKey()` Gets the value of the primaryKeyForeignKey property.
`List<PrimaryKeyJoinColumn>`	`getPrimaryKeyJoinColumn()` Gets the value of the primaryKeyJoinColumn property.
`List<SecondaryTable>`	`getSecondaryTable()` Gets the value of the secondaryTable property.
`SequenceGenerator`	`getSequenceGenerator()` Gets the value of the sequenceGenerator property.
`List<SqlResultSetMapping>`	`getSqlResultSetMapping()` Gets the value of the sqlResultSetMapping property.
`Table`	`getTable()` Gets the value of the table property.
`TableGenerator`	`getTableGenerator()` Gets the value of the tableGenerator property.
`Boolean`	`isCacheable()` Gets the value of the cacheable property.
`Boolean`	`isMetadataComplete()` Gets the value of the metadataComplete property.
`void`	`setAccess(AccessType value)` Sets the value of the access property.
`void`	`setAttributes(Attributes value)` Sets the value of the attributes property.
`void`	`setCacheable(Boolean value)` Sets the value of the cacheable property.
`void`	`setClazz(String value)` Sets the value of the clazz property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setDiscriminatorColumn(DiscriminatorColumn value)` Sets the value of the discriminatorColumn property.
`void`	`setDiscriminatorValue(String value)` Sets the value of the discriminatorValue property.
`void`	`setEntityListeners(EntityListeners value)` Sets the value of the entityListeners property.
`void`	`setExcludeDefaultListeners(EmptyType value)` Sets the value of the excludeDefaultListeners property.
`void`	`setExcludeSuperclassListeners(EmptyType value)` Sets the value of the excludeSuperclassListeners property.
`void`	`setIdClass(IdClass value)` Sets the value of the idClass property.
`void`	`setInheritance(Inheritance value)` Sets the value of the inheritance property.
`void`	`setMetadataComplete(Boolean value)` Sets the value of the metadataComplete property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setPostLoad(PostLoad value)` Sets the value of the postLoad property.
`void`	`setPostPersist(PostPersist value)` Sets the value of the postPersist property.
`void`	`setPostRemove(PostRemove value)` Sets the value of the postRemove property.
`void`	`setPostUpdate(PostUpdate value)` Sets the value of the postUpdate property.
`void`	`setPrePersist(PrePersist value)` Sets the value of the prePersist property.
`void`	`setPreRemove(PreRemove value)` Sets the value of the preRemove property.
`void`	`setPreUpdate(PreUpdate value)` Sets the value of the preUpdate property.
`void`	`setPrimaryKeyForeignKey(ForeignKey value)` Sets the value of the primaryKeyForeignKey property.
`void`	`setSequenceGenerator(SequenceGenerator value)` Sets the value of the sequenceGenerator property.
`void`	`setTable(Table value)` Sets the value of the table property.
`void`	`setTableGenerator(TableGenerator value)` Sets the value of the tableGenerator property.

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

- Field Detail
  - description
```
protected String description
```
  - table
```
protected Table table
```
  - secondaryTable
```
protected List<SecondaryTable> secondaryTable
```
  - primaryKeyJoinColumn
```
protected List<PrimaryKeyJoinColumn> primaryKeyJoinColumn
```
  - primaryKeyForeignKey
```
protected ForeignKey primaryKeyForeignKey
```
  - idClass
```
protected IdClass idClass
```
  - inheritance
```
protected Inheritance inheritance
```
  - discriminatorValue
```
protected String discriminatorValue
```
  - discriminatorColumn
```
protected DiscriminatorColumn discriminatorColumn
```
  - sequenceGenerator
```
protected SequenceGenerator sequenceGenerator
```
  - tableGenerator
```
protected TableGenerator tableGenerator
```
  - namedQuery
```
protected List<NamedQuery> namedQuery
```
  - namedNativeQuery
```
protected List<NamedNativeQuery> namedNativeQuery
```
  - namedStoredProcedureQuery
```
protected List<NamedStoredProcedureQuery> namedStoredProcedureQuery
```
  - sqlResultSetMapping
```
protected List<SqlResultSetMapping> sqlResultSetMapping
```
  - excludeDefaultListeners
```
protected EmptyType excludeDefaultListeners
```
  - excludeSuperclassListeners
```
protected EmptyType excludeSuperclassListeners
```
  - entityListeners
```
protected EntityListeners entityListeners
```
  - prePersist
```
protected PrePersist prePersist
```
  - postPersist
```
protected PostPersist postPersist
```
  - preRemove
```
protected PreRemove preRemove
```
  - postRemove
```
protected PostRemove postRemove
```
  - preUpdate
```
protected PreUpdate preUpdate
```
  - postUpdate
```
protected PostUpdate postUpdate
```
  - postLoad
```
protected PostLoad postLoad
```
  - attributeOverride
```
protected List<AttributeOverride> attributeOverride
```
  - associationOverride
```
protected List<AssociationOverride> associationOverride
```
  - convert
```
protected List<Convert> convert
```
  - namedEntityGraph
```
protected List<NamedEntityGraph> namedEntityGraph
```
  - attributes
```
protected Attributes attributes
```
  - name
```
protected String name
```
  - clazz
```
protected String clazz
```
  - access
```
protected AccessType access
```
  - cacheable
```
protected Boolean cacheable
```
  - metadataComplete
```
protected Boolean metadataComplete
```
- Constructor Detail
  - Entity
```
public Entity()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    value - allowed object is String
  - getTable
```
public Table getTable()
```
    Gets the value of the table property.
    
    Returns:
    possible object is Table
  - setTable
```
public void setTable(Table value)
```
    Sets the value of the table property.
    
    Parameters:
    value - allowed object is Table
  - getSecondaryTable
```
public List<SecondaryTable> getSecondaryTable()
```
    Gets the value of the secondaryTable property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the secondaryTable property.
    For example, to add a new item, do as follows:
```
    getSecondaryTable().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SecondaryTable
  - getPrimaryKeyJoinColumn
```
public List<PrimaryKeyJoinColumn> getPrimaryKeyJoinColumn()
```
    Gets the value of the primaryKeyJoinColumn property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the primaryKeyJoinColumn property.
    For example, to add a new item, do as follows:
```
    getPrimaryKeyJoinColumn().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list PrimaryKeyJoinColumn
  - getPrimaryKeyForeignKey
```
public ForeignKey getPrimaryKeyForeignKey()
```
    Gets the value of the primaryKeyForeignKey property.
    
    Returns:
    possible object is ForeignKey
  - setPrimaryKeyForeignKey
```
public void setPrimaryKeyForeignKey(ForeignKey value)
```
    Sets the value of the primaryKeyForeignKey property.
    
    Parameters:
    value - allowed object is ForeignKey
  - getIdClass
```
public IdClass getIdClass()
```
    Gets the value of the idClass property.
    
    Returns:
    possible object is IdClass
  - setIdClass
```
public void setIdClass(IdClass value)
```
    Sets the value of the idClass property.
    
    Parameters:
    value - allowed object is IdClass
  - getInheritance
```
public Inheritance getInheritance()
```
    Gets the value of the inheritance property.
    
    Returns:
    possible object is Inheritance
  - setInheritance
```
public void setInheritance(Inheritance value)
```
    Sets the value of the inheritance property.
    
    Parameters:
    value - allowed object is Inheritance
  - getDiscriminatorValue
```
public String getDiscriminatorValue()
```
    Gets the value of the discriminatorValue property.
    
    Returns:
    possible object is String
  - setDiscriminatorValue
```
public void setDiscriminatorValue(String value)
```
    Sets the value of the discriminatorValue property.
    
    Parameters:
    value - allowed object is String
  - getDiscriminatorColumn
```
public DiscriminatorColumn getDiscriminatorColumn()
```
    Gets the value of the discriminatorColumn property.
    
    Returns:
    possible object is DiscriminatorColumn
  - setDiscriminatorColumn
```
public void setDiscriminatorColumn(DiscriminatorColumn value)
```
    Sets the value of the discriminatorColumn property.
    
    Parameters:
    value - allowed object is DiscriminatorColumn
  - getSequenceGenerator
```
public SequenceGenerator getSequenceGenerator()
```
    Gets the value of the sequenceGenerator property.
    
    Returns:
    possible object is SequenceGenerator
  - setSequenceGenerator
```
public void setSequenceGenerator(SequenceGenerator value)
```
    Sets the value of the sequenceGenerator property.
    
    Parameters:
    value - allowed object is SequenceGenerator
  - getTableGenerator
```
public TableGenerator getTableGenerator()
```
    Gets the value of the tableGenerator property.
    
    Returns:
    possible object is TableGenerator
  - setTableGenerator
```
public void setTableGenerator(TableGenerator value)
```
    Sets the value of the tableGenerator property.
    
    Parameters:
    value - allowed object is TableGenerator
  - getNamedQuery
```
public List<NamedQuery> getNamedQuery()
```
    Gets the value of the namedQuery property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the namedQuery property.
    For example, to add a new item, do as follows:
```
    getNamedQuery().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list NamedQuery
  - getNamedNativeQuery
```
public List<NamedNativeQuery> getNamedNativeQuery()
```
    Gets the value of the namedNativeQuery property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the namedNativeQuery property.
    For example, to add a new item, do as follows:
```
    getNamedNativeQuery().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list NamedNativeQuery
  - getNamedStoredProcedureQuery
```
public List<NamedStoredProcedureQuery> getNamedStoredProcedureQuery()
```
    Gets the value of the namedStoredProcedureQuery property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the namedStoredProcedureQuery property.
    For example, to add a new item, do as follows:
```
    getNamedStoredProcedureQuery().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list NamedStoredProcedureQuery
  - getSqlResultSetMapping
```
public List<SqlResultSetMapping> getSqlResultSetMapping()
```
    Gets the value of the sqlResultSetMapping property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the sqlResultSetMapping property.
    For example, to add a new item, do as follows:
```
    getSqlResultSetMapping().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SqlResultSetMapping
  - getExcludeDefaultListeners
```
public EmptyType getExcludeDefaultListeners()
```
    Gets the value of the excludeDefaultListeners property.
    
    Returns:
    possible object is EmptyType
  - setExcludeDefaultListeners
```
public void setExcludeDefaultListeners(EmptyType value)
```
    Sets the value of the excludeDefaultListeners property.
    
    Parameters:
    value - allowed object is EmptyType
  - getExcludeSuperclassListeners
```
public EmptyType getExcludeSuperclassListeners()
```
    Gets the value of the excludeSuperclassListeners property.
    
    Returns:
    possible object is EmptyType
  - setExcludeSuperclassListeners
```
public void setExcludeSuperclassListeners(EmptyType value)
```
    Sets the value of the excludeSuperclassListeners property.
    
    Parameters:
    value - allowed object is EmptyType
  - getEntityListeners
```
public EntityListeners getEntityListeners()
```
    Gets the value of the entityListeners property.
    
    Returns:
    possible object is EntityListeners
  - setEntityListeners
```
public void setEntityListeners(EntityListeners value)
```
    Sets the value of the entityListeners property.
    
    Parameters:
    value - allowed object is EntityListeners
  - getPrePersist
```
public PrePersist getPrePersist()
```
    Gets the value of the prePersist property.
    
    Returns:
    possible object is PrePersist
  - setPrePersist
```
public void setPrePersist(PrePersist value)
```
    Sets the value of the prePersist property.
    
    Parameters:
    value - allowed object is PrePersist
  - getPostPersist
```
public PostPersist getPostPersist()
```
    Gets the value of the postPersist property.
    
    Returns:
    possible object is PostPersist
  - setPostPersist
```
public void setPostPersist(PostPersist value)
```
    Sets the value of the postPersist property.
    
    Parameters:
    value - allowed object is PostPersist
  - getPreRemove
```
public PreRemove getPreRemove()
```
    Gets the value of the preRemove property.
    
    Returns:
    possible object is PreRemove
  - setPreRemove
```
public void setPreRemove(PreRemove value)
```
    Sets the value of the preRemove property.
    
    Parameters:
    value - allowed object is PreRemove
  - getPostRemove
```
public PostRemove getPostRemove()
```
    Gets the value of the postRemove property.
    
    Returns:
    possible object is PostRemove
  - setPostRemove
```
public void setPostRemove(PostRemove value)
```
    Sets the value of the postRemove property.
    
    Parameters:
    value - allowed object is PostRemove
  - getPreUpdate
```
public PreUpdate getPreUpdate()
```
    Gets the value of the preUpdate property.
    
    Returns:
    possible object is PreUpdate
  - setPreUpdate
```
public void setPreUpdate(PreUpdate value)
```
    Sets the value of the preUpdate property.
    
    Parameters:
    value - allowed object is PreUpdate
  - getPostUpdate
```
public PostUpdate getPostUpdate()
```
    Gets the value of the postUpdate property.
    
    Returns:
    possible object is PostUpdate
  - setPostUpdate
```
public void setPostUpdate(PostUpdate value)
```
    Sets the value of the postUpdate property.
    
    Parameters:
    value - allowed object is PostUpdate
  - getPostLoad
```
public PostLoad getPostLoad()
```
    Gets the value of the postLoad property.
    
    Returns:
    possible object is PostLoad
  - setPostLoad
```
public void setPostLoad(PostLoad value)
```
    Sets the value of the postLoad property.
    
    Parameters:
    value - allowed object is PostLoad
  - getAttributeOverride
```
public List<AttributeOverride> getAttributeOverride()
```
    Gets the value of the attributeOverride property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the attributeOverride property.
    For example, to add a new item, do as follows:
```
    getAttributeOverride().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AttributeOverride
  - getAssociationOverride
```
public List<AssociationOverride> getAssociationOverride()
```
    Gets the value of the associationOverride property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the associationOverride property.
    For example, to add a new item, do as follows:
```
    getAssociationOverride().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AssociationOverride
  - getConvert
```
public List<Convert> getConvert()
```
    Gets the value of the convert property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the convert property.
    For example, to add a new item, do as follows:
```
    getConvert().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Convert
  - getNamedEntityGraph
```
public List<NamedEntityGraph> getNamedEntityGraph()
```
    Gets the value of the namedEntityGraph property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the namedEntityGraph property.
    For example, to add a new item, do as follows:
```
    getNamedEntityGraph().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list NamedEntityGraph
  - getAttributes
```
public Attributes getAttributes()
```
    Gets the value of the attributes property.
    
    Returns:
    possible object is Attributes
  - setAttributes
```
public void setAttributes(Attributes value)
```
    Sets the value of the attributes property.
    
    Parameters:
    value - allowed object is Attributes
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    value - allowed object is String
  - getClazz
```
public String getClazz()
```
    Gets the value of the clazz property.
    
    Returns:
    possible object is String
  - setClazz
```
public void setClazz(String value)
```
    Sets the value of the clazz property.
    
    Parameters:
    value - allowed object is String
  - getAccess
```
public AccessType getAccess()
```
    Gets the value of the access property.
    
    Returns:
    possible object is AccessType
  - setAccess
```
public void setAccess(AccessType value)
```
    Sets the value of the access property.
    
    Parameters:
    value - allowed object is AccessType
  - isCacheable
```
public Boolean isCacheable()
```
    Gets the value of the cacheable property.
    
    Returns:
    possible object is Boolean
  - setCacheable
```
public void setCacheable(Boolean value)
```
    Sets the value of the cacheable property.
    
    Parameters:
    value - allowed object is Boolean
  - isMetadataComplete
```
public Boolean isMetadataComplete()
```
    Gets the value of the metadataComplete property.
    
    Returns:
    possible object is Boolean
  - setMetadataComplete
```
public void setMetadataComplete(Boolean value)
```
    Sets the value of the metadataComplete property.
    
    Parameters:
    value - allowed object is Boolean

Class Entity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

table

secondaryTable

primaryKeyJoinColumn

primaryKeyForeignKey

idClass

inheritance

discriminatorValue

discriminatorColumn

sequenceGenerator

tableGenerator

namedQuery

namedNativeQuery

namedStoredProcedureQuery

sqlResultSetMapping

excludeDefaultListeners

excludeSuperclassListeners

entityListeners

prePersist

postPersist

preRemove

postRemove

preUpdate

postUpdate

postLoad

attributeOverride

associationOverride

convert

namedEntityGraph

attributes

name

clazz

access

cacheable

metadataComplete

Constructor Detail

Entity

Method Detail

getDescription

setDescription

getTable

setTable

getSecondaryTable

getPrimaryKeyJoinColumn

getPrimaryKeyForeignKey

setPrimaryKeyForeignKey

getIdClass

setIdClass

getInheritance

setInheritance

getDiscriminatorValue

setDiscriminatorValue

getDiscriminatorColumn

setDiscriminatorColumn

getSequenceGenerator

setSequenceGenerator

getTableGenerator

setTableGenerator

getNamedQuery

getNamedNativeQuery

getNamedStoredProcedureQuery

getSqlResultSetMapping

getExcludeDefaultListeners

setExcludeDefaultListeners

getExcludeSuperclassListeners

setExcludeSuperclassListeners

getEntityListeners

setEntityListeners

getPrePersist

setPrePersist

getPostPersist

setPostPersist

getPreRemove

setPreRemove