net.sourceforge.ccxjc.it.model.prot.indexed.novalueclass.persistence.orm
Interface Entity

All Known Implementing Classes:

EntityImpl

public interface Entity

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.

Method Summary

AccessType	getAccess() Gets the value of the access property.
AssociationOverride[]	getAssociationOverride()
AssociationOverride	getAssociationOverride(int idx)
int	getAssociationOverrideLength()
AttributeOverride[]	getAttributeOverride()
AttributeOverride	getAttributeOverride(int idx)
int	getAttributeOverrideLength()
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.
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.
NamedNativeQuery[]	getNamedNativeQuery()
NamedNativeQuery	getNamedNativeQuery(int idx)
int	getNamedNativeQueryLength()
NamedQuery[]	getNamedQuery()
NamedQuery	getNamedQuery(int idx)
int	getNamedQueryLength()
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.
PrimaryKeyJoinColumn[]	getPrimaryKeyJoinColumn()
PrimaryKeyJoinColumn	getPrimaryKeyJoinColumn(int idx)
int	getPrimaryKeyJoinColumnLength()
SecondaryTable[]	getSecondaryTable()
SecondaryTable	getSecondaryTable(int idx)
int	getSecondaryTableLength()
SequenceGenerator	getSequenceGenerator() Gets the value of the sequenceGenerator property.
SqlResultSetMapping[]	getSqlResultSetMapping()
SqlResultSetMapping	getSqlResultSetMapping(int idx)
int	getSqlResultSetMappingLength()
Table	getTable() Gets the value of the table property.
TableGenerator	getTableGenerator() Gets the value of the tableGenerator property.
Boolean	isMetadataComplete() Gets the value of the metadataComplete property.
void	setAccess(AccessType value) Sets the value of the access property.
void	setAssociationOverride(AssociationOverride[] values)
AssociationOverride	setAssociationOverride(int idx, AssociationOverride value)
void	setAttributeOverride(AttributeOverride[] values)
AttributeOverride	setAttributeOverride(int idx, AttributeOverride value)
void	setAttributes(Attributes value) Sets the value of the attributes 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.
NamedNativeQuery	setNamedNativeQuery(int idx, NamedNativeQuery value)
void	setNamedNativeQuery(NamedNativeQuery[] values)
NamedQuery	setNamedQuery(int idx, NamedQuery value)
void	setNamedQuery(NamedQuery[] values)
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.
PrimaryKeyJoinColumn	setPrimaryKeyJoinColumn(int idx, PrimaryKeyJoinColumn value)
void	setPrimaryKeyJoinColumn(PrimaryKeyJoinColumn[] values)
SecondaryTable	setSecondaryTable(int idx, SecondaryTable value)
void	setSecondaryTable(SecondaryTable[] values)
void	setSequenceGenerator(SequenceGenerator value) Sets the value of the sequenceGenerator property.
SqlResultSetMapping	setSqlResultSetMapping(int idx, SqlResultSetMapping value)
void	setSqlResultSetMapping(SqlResultSetMapping[] values)
void	setTable(Table value) Sets the value of the table property.
void	setTableGenerator(TableGenerator value) Sets the value of the tableGenerator property.

Method Detail

getDescription

String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getTable

Table getTable()

Gets the value of the table property.

Returns:

possible object is Table

setTable

void setTable(Table value)

Sets the value of the table property.

Parameters:

value - allowed object is Table

getSecondaryTable

SecondaryTable[] getSecondaryTable()

Returns:

array of SecondaryTable

getSecondaryTable

SecondaryTable getSecondaryTable(int idx)

Returns:

one of SecondaryTable

getSecondaryTableLength

int getSecondaryTableLength()

setSecondaryTable

void setSecondaryTable(SecondaryTable[] values)

Parameters:

values - allowed objects are SecondaryTable

setSecondaryTable

SecondaryTable setSecondaryTable(int idx,
                                 SecondaryTable value)

Parameters:

value - allowed object is SecondaryTable

getPrimaryKeyJoinColumn

PrimaryKeyJoinColumn[] getPrimaryKeyJoinColumn()

Returns:

array of PrimaryKeyJoinColumn

getPrimaryKeyJoinColumn

PrimaryKeyJoinColumn getPrimaryKeyJoinColumn(int idx)

Returns:

one of PrimaryKeyJoinColumn

getPrimaryKeyJoinColumnLength

int getPrimaryKeyJoinColumnLength()

setPrimaryKeyJoinColumn

void setPrimaryKeyJoinColumn(PrimaryKeyJoinColumn[] values)

Parameters:

values - allowed objects are PrimaryKeyJoinColumn

setPrimaryKeyJoinColumn

PrimaryKeyJoinColumn setPrimaryKeyJoinColumn(int idx,
                                             PrimaryKeyJoinColumn value)

Parameters:

value - allowed object is PrimaryKeyJoinColumn

getIdClass

IdClass getIdClass()

Gets the value of the idClass property.

Returns:

possible object is IdClass

setIdClass

void setIdClass(IdClass value)

Sets the value of the idClass property.

Parameters:

value - allowed object is IdClass

getInheritance

Inheritance getInheritance()

Gets the value of the inheritance property.

Returns:

possible object is Inheritance

setInheritance

void setInheritance(Inheritance value)

Sets the value of the inheritance property.

Parameters:

value - allowed object is Inheritance

getDiscriminatorValue

String getDiscriminatorValue()

Gets the value of the discriminatorValue property.

Returns:

possible object is String

setDiscriminatorValue

void setDiscriminatorValue(String value)

Sets the value of the discriminatorValue property.

Parameters:

value - allowed object is String

getDiscriminatorColumn

DiscriminatorColumn getDiscriminatorColumn()

Gets the value of the discriminatorColumn property.

Returns:

possible object is DiscriminatorColumn

setDiscriminatorColumn

void setDiscriminatorColumn(DiscriminatorColumn value)

Sets the value of the discriminatorColumn property.

Parameters:

value - allowed object is DiscriminatorColumn

getSequenceGenerator

SequenceGenerator getSequenceGenerator()

Gets the value of the sequenceGenerator property.

Returns:

possible object is SequenceGenerator

setSequenceGenerator

void setSequenceGenerator(SequenceGenerator value)

Sets the value of the sequenceGenerator property.

Parameters:

value - allowed object is SequenceGenerator

getTableGenerator

TableGenerator getTableGenerator()

Gets the value of the tableGenerator property.

Returns:

possible object is TableGenerator

setTableGenerator

void setTableGenerator(TableGenerator value)

Sets the value of the tableGenerator property.

Parameters:

value - allowed object is TableGenerator

getNamedQuery

NamedQuery[] getNamedQuery()

Returns:

array of NamedQuery

getNamedQuery

NamedQuery getNamedQuery(int idx)

Returns:

one of NamedQuery

getNamedQueryLength

int getNamedQueryLength()

setNamedQuery

void setNamedQuery(NamedQuery[] values)

Parameters:

values - allowed objects are NamedQuery

setNamedQuery

NamedQuery setNamedQuery(int idx,
                         NamedQuery value)

Parameters:

value - allowed object is NamedQuery

getNamedNativeQuery

NamedNativeQuery[] getNamedNativeQuery()

Returns:

array of NamedNativeQuery

getNamedNativeQuery

NamedNativeQuery getNamedNativeQuery(int idx)

Returns:

one of NamedNativeQuery

getNamedNativeQueryLength

int getNamedNativeQueryLength()

setNamedNativeQuery

void setNamedNativeQuery(NamedNativeQuery[] values)

Parameters:

values - allowed objects are NamedNativeQuery

setNamedNativeQuery

NamedNativeQuery setNamedNativeQuery(int idx,
                                     NamedNativeQuery value)

Parameters:

value - allowed object is NamedNativeQuery

getSqlResultSetMapping

SqlResultSetMapping[] getSqlResultSetMapping()

Returns:

array of SqlResultSetMapping

getSqlResultSetMapping

SqlResultSetMapping getSqlResultSetMapping(int idx)

Returns:

one of SqlResultSetMapping

getSqlResultSetMappingLength

int getSqlResultSetMappingLength()

setSqlResultSetMapping

void setSqlResultSetMapping(SqlResultSetMapping[] values)

Parameters:

values - allowed objects are SqlResultSetMapping

setSqlResultSetMapping

SqlResultSetMapping setSqlResultSetMapping(int idx,
                                           SqlResultSetMapping value)

Parameters:

value - allowed object is SqlResultSetMapping

getExcludeDefaultListeners

EmptyType getExcludeDefaultListeners()

Gets the value of the excludeDefaultListeners property.

Returns:

possible object is EmptyType

setExcludeDefaultListeners

void setExcludeDefaultListeners(EmptyType value)

Sets the value of the excludeDefaultListeners property.

Parameters:

value - allowed object is EmptyType

getExcludeSuperclassListeners

EmptyType getExcludeSuperclassListeners()

Gets the value of the excludeSuperclassListeners property.

Returns:

possible object is EmptyType

setExcludeSuperclassListeners

void setExcludeSuperclassListeners(EmptyType value)

Sets the value of the excludeSuperclassListeners property.

Parameters:

value - allowed object is EmptyType

getEntityListeners

EntityListeners getEntityListeners()

Gets the value of the entityListeners property.

Returns:

possible object is EntityListeners

setEntityListeners

void setEntityListeners(EntityListeners value)

Sets the value of the entityListeners property.

Parameters:

value - allowed object is EntityListeners

getPrePersist

PrePersist getPrePersist()

Gets the value of the prePersist property.

Returns:

possible object is PrePersist

setPrePersist

void setPrePersist(PrePersist value)

Sets the value of the prePersist property.

Parameters:

value - allowed object is PrePersist

getPostPersist

PostPersist getPostPersist()

Gets the value of the postPersist property.

Returns:

possible object is PostPersist

setPostPersist

void setPostPersist(PostPersist value)

Sets the value of the postPersist property.

Parameters:

value - allowed object is PostPersist

getPreRemove

PreRemove getPreRemove()

Gets the value of the preRemove property.

Returns:

possible object is PreRemove

setPreRemove

void setPreRemove(PreRemove value)

Sets the value of the preRemove property.

Parameters:

value - allowed object is PreRemove

getPostRemove

PostRemove getPostRemove()

Gets the value of the postRemove property.

Returns:

possible object is PostRemove

setPostRemove

void setPostRemove(PostRemove value)

Sets the value of the postRemove property.

Parameters:

value - allowed object is PostRemove

getPreUpdate

PreUpdate getPreUpdate()

Gets the value of the preUpdate property.

Returns:

possible object is PreUpdate

setPreUpdate

void setPreUpdate(PreUpdate value)

Sets the value of the preUpdate property.

Parameters:

value - allowed object is PreUpdate

getPostUpdate

PostUpdate getPostUpdate()

Gets the value of the postUpdate property.

Returns:

possible object is PostUpdate

setPostUpdate

void setPostUpdate(PostUpdate value)

Sets the value of the postUpdate property.

Parameters:

value - allowed object is PostUpdate

getPostLoad

PostLoad getPostLoad()

Gets the value of the postLoad property.

Returns:

possible object is PostLoad

setPostLoad

void setPostLoad(PostLoad value)

Sets the value of the postLoad property.

Parameters:

value - allowed object is PostLoad

getAttributeOverride

AttributeOverride[] getAttributeOverride()

Returns:

array of AttributeOverride

getAttributeOverride

AttributeOverride getAttributeOverride(int idx)

Returns:

one of AttributeOverride

getAttributeOverrideLength

int getAttributeOverrideLength()

setAttributeOverride

void setAttributeOverride(AttributeOverride[] values)

Parameters:

values - allowed objects are AttributeOverride

setAttributeOverride

AttributeOverride setAttributeOverride(int idx,
                                       AttributeOverride value)

Parameters:

value - allowed object is AttributeOverride

getAssociationOverride

AssociationOverride[] getAssociationOverride()

Returns:

array of AssociationOverride

getAssociationOverride

AssociationOverride getAssociationOverride(int idx)

Returns:

one of AssociationOverride

getAssociationOverrideLength

int getAssociationOverrideLength()

setAssociationOverride

void setAssociationOverride(AssociationOverride[] values)

Parameters:

values - allowed objects are AssociationOverride

setAssociationOverride

AssociationOverride setAssociationOverride(int idx,
                                           AssociationOverride value)

Parameters:

value - allowed object is AssociationOverride

getAttributes

Attributes getAttributes()

Gets the value of the attributes property.

Returns:

possible object is Attributes

setAttributes

void setAttributes(Attributes value)

Sets the value of the attributes property.

Parameters:

value - allowed object is Attributes

getName

String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getClazz

String getClazz()

Gets the value of the clazz property.

Returns:

possible object is String

setClazz

void setClazz(String value)

Sets the value of the clazz property.

Parameters:

value - allowed object is String

getAccess

AccessType getAccess()

Gets the value of the access property.

Returns:

possible object is AccessType

setAccess

void setAccess(AccessType value)

Sets the value of the access property.

Parameters:

value - allowed object is AccessType

isMetadataComplete

Boolean isMetadataComplete()

Gets the value of the metadataComplete property.

Returns:

possible object is Boolean

setMetadataComplete

void setMetadataComplete(Boolean value)

Sets the value of the metadataComplete property.

Parameters:

value - allowed object is Boolean