org.apache.openejb.jee.jpa
Class Entity

java.lang.Object
  org.apache.openejb.jee.jpa.Entity

All Implemented Interfaces:

Mapping, Keyable<String>

public class Entity
extends Object
implements Mapping, Keyable<String>

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

protected AccessType	access
protected List<AssociationOverride>	associationOverride
protected List<AttributeOverride>	attributeOverride
protected Attributes	attributes
protected Boolean	cacheable
protected String	clazz
protected String	description
protected DiscriminatorColumn	discriminatorColumn
protected String	discriminatorValue
protected String	ejbName
protected EntityListeners	entityListeners
protected EmptyType	excludeDefaultListeners
protected EmptyType	excludeSuperclassListeners
protected IdClass	idClass
protected Inheritance	inheritance
protected Boolean	metadataComplete
protected String	name
protected List<NamedNativeQuery>	namedNativeQuery
protected List<NamedQuery>	namedQuery
protected PostLoad	postLoad
protected PostPersist	postPersist
protected PostRemove	postRemove
protected PostUpdate	postUpdate
protected PrePersist	prePersist
protected PreRemove	preRemove
protected PreUpdate	preUpdate
protected List<PrimaryKeyJoinColumn>	primaryKeyJoinColumn
protected List<SecondaryTable>	secondaryTable
protected SequenceGenerator	sequenceGenerator
protected List<SqlResultSetMapping>	sqlResultSetMapping
protected Table	table
protected TableGenerator	tableGenerator
protected boolean	xmlMetadataComplete

Constructor Summary

Entity()

Entity(String clazz)

Method Summary

void	addField(Field field)
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.
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.
String	getEjbName()
EntityListeners	getEntityListeners() Gets the value of the entityListeners property.
IdClass	getIdClass() Gets the value of the idClass property.
Inheritance	getInheritance() Gets the value of the inheritance property.
String	getKey() Gets the immutable key for this object.
String	getName() Gets the value of the name property.
List<NamedNativeQuery>	getNamedNativeQuery() Gets the value of the namedNativeQuery property.
List<NamedQuery>	getNamedQuery() Gets the value of the namedQuery 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.
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	isExcludeDefaultListeners() Gets the value of the excludeDefaultListeners property.
boolean	isExcludeSuperclassListeners() Gets the value of the excludeSuperclassListeners property.
Boolean	isMetadataComplete() Gets the value of the metadataComplete property.
boolean	isXmlMetadataComplete()
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	setEjbName(String ejbName)
void	setEntityListeners(EntityListeners value) Sets the value of the entityListeners property.
void	setExcludeDefaultListeners(boolean value) Sets the value of the excludeDefaultListeners property.
void	setExcludeSuperclassListeners(boolean 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	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.
void	setXmlMetadataComplete(boolean xmlMetadataComplete)

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

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

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

attributes

protected Attributes attributes

access

protected AccessType access

clazz

protected String clazz

cacheable

protected Boolean cacheable

metadataComplete

protected Boolean metadataComplete

name

protected String name

ejbName

protected String ejbName

xmlMetadataComplete

protected boolean xmlMetadataComplete

Constructor Detail

Entity

public Entity()

Entity

public Entity(String clazz)

Method Detail

getDescription

public String getDescription()

Gets the value of the description property.

Specified by:

getDescription in interface Mapping

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Specified by:

setDescription in interface Mapping

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

getIdClass

public IdClass getIdClass()

Gets the value of the idClass property.

Specified by:

getIdClass in interface Mapping

Returns:

possible object is IdClass

setIdClass

public void setIdClass(IdClass value)

Sets the value of the idClass property.

Specified by:

setIdClass in interface Mapping

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

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

isExcludeDefaultListeners

public boolean isExcludeDefaultListeners()

Gets the value of the excludeDefaultListeners property.

Specified by:

isExcludeDefaultListeners in interface Mapping

Returns:

possible object is boolean

setExcludeDefaultListeners

public void setExcludeDefaultListeners(boolean value)

Sets the value of the excludeDefaultListeners property.

Specified by:

setExcludeDefaultListeners in interface Mapping

Parameters:

value - allowed object is boolean

isExcludeSuperclassListeners

public boolean isExcludeSuperclassListeners()

Gets the value of the excludeSuperclassListeners property.

Specified by:

isExcludeSuperclassListeners in interface Mapping

Returns:

possible object is boolean

setExcludeSuperclassListeners

public void setExcludeSuperclassListeners(boolean value)

Sets the value of the excludeSuperclassListeners property.

Specified by:

setExcludeSuperclassListeners in interface Mapping

Parameters:

value - allowed object is boolean

getEntityListeners

public EntityListeners getEntityListeners()

Gets the value of the entityListeners property.

Specified by:

getEntityListeners in interface Mapping

Returns:

possible object is EntityListeners

setEntityListeners

public void setEntityListeners(EntityListeners value)

Sets the value of the entityListeners property.

Specified by:

setEntityListeners in interface Mapping

Parameters:

value - allowed object is EntityListeners

getPrePersist

public PrePersist getPrePersist()

Gets the value of the prePersist property.

Specified by:

getPrePersist in interface Mapping

Returns:

possible object is PrePersist

setPrePersist

public void setPrePersist(PrePersist value)

Sets the value of the prePersist property.

Specified by:

setPrePersist in interface Mapping

Parameters:

value - allowed object is PrePersist

getPostPersist

public PostPersist getPostPersist()

Gets the value of the postPersist property.

Specified by:

getPostPersist in interface Mapping

Returns:

possible object is PostPersist

setPostPersist

public void setPostPersist(PostPersist value)

Sets the value of the postPersist property.

Specified by:

setPostPersist in interface Mapping

Parameters:

value - allowed object is PostPersist

getPreRemove

public PreRemove getPreRemove()

Gets the value of the preRemove property.

Specified by:

getPreRemove in interface Mapping

Returns:

possible object is PreRemove

setPreRemove

public void setPreRemove(PreRemove value)

Sets the value of the preRemove property.

Specified by:

setPreRemove in interface Mapping

Parameters:

value - allowed object is PreRemove

getPostRemove

public PostRemove getPostRemove()

Gets the value of the postRemove property.

Specified by:

getPostRemove in interface Mapping

Returns:

possible object is PostRemove

setPostRemove

public void setPostRemove(PostRemove value)

Sets the value of the postRemove property.

Specified by:

setPostRemove in interface Mapping

Parameters:

value - allowed object is PostRemove

getPreUpdate

public PreUpdate getPreUpdate()

Gets the value of the preUpdate property.

Specified by:

getPreUpdate in interface Mapping

Returns:

possible object is PreUpdate

setPreUpdate

public void setPreUpdate(PreUpdate value)

Sets the value of the preUpdate property.

Specified by:

setPreUpdate in interface Mapping

Parameters:

value - allowed object is PreUpdate

getPostUpdate

public PostUpdate getPostUpdate()

Gets the value of the postUpdate property.

Specified by:

getPostUpdate in interface Mapping

Returns:

possible object is PostUpdate

setPostUpdate

public void setPostUpdate(PostUpdate value)

Sets the value of the postUpdate property.

Specified by:

setPostUpdate in interface Mapping

Parameters:

value - allowed object is PostUpdate

getPostLoad

public PostLoad getPostLoad()

Gets the value of the postLoad property.

Specified by:

getPostLoad in interface Mapping

Returns:

possible object is PostLoad

setPostLoad

public void setPostLoad(PostLoad value)

Sets the value of the postLoad property.

Specified by:

setPostLoad in interface Mapping

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

getAttributes

public Attributes getAttributes()

Gets the value of the attributes property.

Specified by:

getAttributes in interface Mapping

Returns:

possible object is Attributes

setAttributes

public void setAttributes(Attributes value)

Sets the value of the attributes property.

Specified by:

setAttributes in interface Mapping

Parameters:

value - allowed object is Attributes

getAccess

public AccessType getAccess()

Gets the value of the access property.

Specified by:

getAccess in interface Mapping

Returns:

possible object is AccessType

setAccess

public void setAccess(AccessType value)

Sets the value of the access property.

Specified by:

setAccess in interface Mapping

Parameters:

value - allowed object is AccessType

getClazz

public String getClazz()

Gets the value of the clazz property.

Specified by:

getClazz in interface Mapping

Returns:

possible object is String

setClazz

public void setClazz(String value)

Sets the value of the clazz property.

Specified by:

setClazz in interface Mapping

Parameters:

value - allowed object is String

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.

Specified by:

isMetadataComplete in interface Mapping

Returns:

possible object is Boolean

setMetadataComplete

public void setMetadataComplete(Boolean value)

Sets the value of the metadataComplete property.

Specified by:

setMetadataComplete in interface Mapping

Parameters:

value - allowed object is Boolean

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

getEjbName

public String getEjbName()

setEjbName

public void setEjbName(String ejbName)

isXmlMetadataComplete

public boolean isXmlMetadataComplete()

setXmlMetadataComplete

public void setXmlMetadataComplete(boolean xmlMetadataComplete)

addField

public void addField(Field field)

Specified by:

addField in interface Mapping

getKey

public String getKey()

Description copied from interface: Keyable

Gets the immutable key for this object.

Specified by:

getKey in interface Keyable<String>

Returns:

gets the immutable key for this object