org.apache.openejb.jee.jpa
Class MappedSuperclass

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

All Implemented Interfaces:

Mapping, Keyable<java.lang.String>

public class MappedSuperclass
extends java.lang.Object
implements Mapping, Keyable<java.lang.String>

Defines the settings and mappings for a mapped superclass. 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 are to be processed If this is the case then the defaulting rules will be recursively applied.

Field Summary

protected AccessType	access
protected Attributes	attributes
protected java.lang.String	clazz
protected java.lang.String	description
protected EntityListeners	entityListeners
protected EmptyType	excludeDefaultListeners
protected EmptyType	excludeSuperclassListeners
protected IdClass	idClass
protected java.lang.Boolean	metadataComplete
protected PostLoad	postLoad
protected PostPersist	postPersist
protected PostRemove	postRemove
protected PostUpdate	postUpdate
protected PrePersist	prePersist
protected PreRemove	preRemove
protected PreUpdate	preUpdate

Constructor Summary

MappedSuperclass()

MappedSuperclass(java.lang.String clazz)

Method Summary

void	addField(Field field)
AccessType	getAccess() Gets the value of the access property.
Attributes	getAttributes() Gets the value of the attributes property.
java.lang.String	getClazz() Gets the value of the clazz property.
java.lang.String	getDescription() Gets the value of the description property.
EntityListeners	getEntityListeners() Gets the value of the entityListeners property.
IdClass	getIdClass() Gets the value of the idClass property.
java.lang.String	getKey() Gets the immutable key for this object.
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.
boolean	isExcludeDefaultListeners() Gets the value of the excludeDefaultListeners property.
boolean	isExcludeSuperclassListeners() Gets the value of the excludeSuperclassListeners property.
java.lang.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	setClazz(java.lang.String value) Sets the value of the clazz property.
void	setDescription(java.lang.String value) Sets the value of the description property.
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	setMetadataComplete(java.lang.Boolean value) Sets the value of the metadataComplete 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

protected java.lang.String description

idClass

protected IdClass idClass

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

attributes

protected Attributes attributes

access

protected AccessType access

clazz

protected java.lang.String clazz

metadataComplete

protected java.lang.Boolean metadataComplete

Constructor Detail

MappedSuperclass

public MappedSuperclass()

MappedSuperclass

public MappedSuperclass(java.lang.String clazz)

Method Detail

getDescription

public java.lang.String getDescription()

Gets the value of the description property.

Specified by:

getDescription in interface Mapping

Returns:

possible object is String

setDescription

public void setDescription(java.lang.String value)

Sets the value of the description property.

Specified by:

setDescription in interface Mapping

Parameters:

value - allowed object is String

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

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

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 java.lang.String getClazz()

Gets the value of the clazz property.

Specified by:

getClazz in interface Mapping

Returns:

possible object is String

setClazz

public void setClazz(java.lang.String value)

Sets the value of the clazz property.

Specified by:

setClazz in interface Mapping

Parameters:

value - allowed object is String

isMetadataComplete

public java.lang.Boolean isMetadataComplete()

Gets the value of the metadataComplete property.

Specified by:

isMetadataComplete in interface Mapping

Returns:

possible object is Boolean

setMetadataComplete

public void setMetadataComplete(java.lang.Boolean value)

Sets the value of the metadataComplete property.

Specified by:

setMetadataComplete in interface Mapping

Parameters:

value - allowed object is Boolean

addField

public void addField(Field field)

Specified by:

addField in interface Mapping

getKey

public java.lang.String getKey()

Description copied from interface: Keyable

Gets the immutable key for this object.

Specified by:

getKey in interface Keyable<java.lang.String>

Returns:

gets the immutable key for this object