Represents a persistent entity.
Type Params | Return Type | Name and description |
---|---|---|
|
java.util.List<Association> |
getAssociations() A list of the associations for this entity. |
|
PersistentProperty[] |
getCompositeIdentity() The composite id |
|
java.lang.String |
getDecapitalizedName() @return Returns the name of the class decapitalized form |
|
java.lang.String |
getDiscriminator() The discriminator used when persisting subclasses of an inheritance hierarchy |
|
PersistentProperty |
getIdentity() Returns the identity of the instance |
|
java.lang.Class |
getJavaClass() @return The underlying Java class for this entity |
|
ClassMapping |
getMapping() Defines the mapping between this persistent entity and an external form |
|
MappingContext |
getMappingContext() Obtains the MappingContext where this PersistentEntity is defined |
|
java.lang.String |
getName() The entity name including any package prefix |
|
PersistentEntity |
getParentEntity() Returns the parent entity of this entity |
|
java.util.List<PersistentProperty> |
getPersistentProperties() A list of properties to be persisted |
|
java.util.List<java.lang.String> |
getPersistentPropertyNames() A list of property names that a persistent |
|
PersistentProperty |
getPropertyByName(java.lang.String name) Obtains a PersistentProperty instance by name |
|
EntityReflector |
getReflector() @return The reflector this entity |
|
PersistentEntity |
getRootEntity() Obtains the root entity of an inheritance hierarchy |
|
TenantId |
getTenantId() @return The tenant id |
|
PersistentProperty |
getVersion() Returns the version property. |
|
boolean |
hasProperty(java.lang.String name, java.lang.Class type) Checks whether an entity has a bean property of the given name and type |
|
boolean |
isExternal() Whether this PersistentEntity is mapped using a different store. |
|
boolean |
isIdentityName(java.lang.String propertyName) True if the given property is the identifier |
|
boolean |
isInstance(java.lang.Object obj) Tests whether the given instance is an instance of this persistent entity |
|
boolean |
isMultiTenant() @return Whether the entity is multi tenant |
|
boolean |
isOwningEntity(PersistentEntity owner) Returns whether the specified entity asserts ownership over this entity |
|
boolean |
isRoot() Whether this entity is a root entity |
|
boolean |
isVersioned() Is the entity versioned for optimistic locking. |
|
java.lang.Object |
newInstance() Constructs a new instance |
|
void |
setExternal(boolean external) Whether this PersistentEntity is mapped using a different store. |
Methods inherited from class | Name |
---|---|
interface Initializable |
initialize, isInitialized |
A list of the associations for this entity. This is typically a subset of the list returned by getPersistentProperties()
The composite id
The discriminator used when persisting subclasses of an inheritance hierarchy
Returns the identity of the instance
Defines the mapping between this persistent entity and an external form
Obtains the MappingContext where this PersistentEntity is defined
The entity name including any package prefix
Returns the parent entity of this entity
A list of properties to be persisted
A list of property names that a persistent
Obtains a PersistentProperty instance by name
name
- The name of the property
Obtains the root entity of an inheritance hierarchy
Returns the version property.
Checks whether an entity has a bean property of the given name and type
name
- The nametype
- The typeWhether this PersistentEntity is mapped using a different store. Used for cross store persistence.
True if the given property is the identifier
propertyName
- the property nameTests whether the given instance is an instance of this persistent entity
obj
- The object
Returns whether the specified entity asserts ownership over this entity
owner
- The owning entityWhether this entity is a root entity
Is the entity versioned for optimistic locking.
Constructs a new instance
Whether this PersistentEntity is mapped using a different store. Used for cross store persistence.
external
- true if this entity is externally mapped