com.avaje.ebeaninternal.server.deploy

Class BeanDescriptor<T>

java.lang.Object

com.avaje.ebeaninternal.server.deploy.BeanDescriptor<T>

All Implemented Interfaces:

MetaBeanInfo

public class BeanDescriptor<T>
extends Object
implements MetaBeanInfo

Describes Beans including their deployment information.

Property Summary

Properties

Type	Property and Description
BeanProperty	firstVersion Return the first version property that exists on the bean.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeanDescriptor.EntityType

Constructor Summary

Constructors

Constructor and Description
BeanDescriptor(BeanDescriptorMap owner, TypeManager typeManager, DeployBeanDescriptor<T> deploy, String descriptorId) Construct the BeanDescriptor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(BeanFkeyProperty fkey) Add objects to ElPropertyDeploy etc.
DeployNamedQuery	addNamedQuery(DeployNamedQuery deployNamedQuery)
void	bindId(DataBind dataBind, Object idValue) Bind the idValue to the preparedStatement.
protected ElPropertyValue	buildElGetValue(String propName, ElPropertyChainBuilder chain, boolean propertyDeploy)
void	cacheClear() Clear the bean cache.
void	cacheClearCachedManyIds(String propertyName)
void	cacheDelete(Object id, PersistRequestBean<T> deleteRequest) Remove a bean from the cache given its Id.
T	cacheGetBean(Object id, Boolean readOnly) Return a bean from the bean cache.
CachedManyIds	cacheGetCachedManyIds(Object parentId, String propertyName)
Object	cacheGetNaturalKeyId(Object uniqueKeyValue)
void	cacheInitialise() Initialise the cache once the server has started.
void	cacheInsert(Object id, PersistRequestBean<T> insertRequest)
boolean	cacheIsNaturalKey(String propName)
boolean	cacheIsUseManyId()
boolean	cacheLoadMany(BeanPropertyAssocMany<?> many, BeanCollection<?> bc, Object parentId, Boolean readOnly)
void	cacheNotify(TransactionEventTable.TableIUD tableIUD) Invalidate parts of cache due to SqlUpdate or external modification etc.
void	cachePutBeanData(Object bean) Put a bean into the bean cache.
void	cachePutCachedManyIds(Object parentId, String propertyName, CachedManyIds ids)
void	cachePutMany(BeanPropertyAssocMany<?> many, BeanCollection<?> bc, Object parentId)
void	cacheRemove(Object id) Remove a bean from the cache given its Id.
void	cacheRemoveCachedManyIds(Object parentId, String propertyName)
void	cacheUpdate(Object id, PersistRequestBean<T> updateRequest) Update the cached bean data.
boolean	calculateUseCache(Boolean queryUseCache)
boolean	calculateUseNaturalKeyCache(Boolean queryUseCache)
void	clearQueryStatistics() Reset the statistics on all the query plans.
List<MetaQueryPlanStatistic>	collectAllQueryPlanStatistics(boolean reset) Collect the current query plan statistics return all the statistics (include query plans that haven't had query executions).
List<MetaQueryPlanStatistic>	collectQueryPlanStatistics(boolean reset) Collect the current query plan statistics return the non-empty statistics.
List<MetaQueryPlanStatistic>	collectQueryPlanStatisticsInternal(boolean reset, boolean collectAll)
Object	convertId(Object idValue) Convert the type of the idValue if required.
String	convertOrmUpdateToSql(String ormUpdateStatement) Convert the logical orm update statement into sql by converting the bean properties and bean name to database columns and table.
Object	convertSetId(Object idValue, Object bean) Convert and set the id value.
Object	createBean() Create an EntityBean.
DeployPropertyParser	createDeployPropertyParser()
EntityBean	createEntityBean() Creates a new EntityBean without using the creation queue.
T	createReference(Boolean readOnly, Object id, Object parent) Create a reference bean based on the id.
SqlUpdate	deleteById(Object id, List<Object> idList)
void	deregister(BeanPersistController controller) De-register the BeanPersistController.
void	deregister(BeanPersistListener<?> listener) De-register the BeanPersistListener.
ConcurrencyMode	determineConcurrencyMode(Object bean) Determine the concurrency mode based on the existence of a non-null version property value.
Set<String>	determineLoadedProperties(Object bean) Determine the non-null properties of the bean.
BeanProperty	findBeanProperty(String propName) Find a BeanProperty including searching the inheritance hierarchy.
BeanProperty	firstVersionProperty() Return the first version property that exists on the bean.
void	flushPersistenceContextOnIterate(PersistenceContext persistenceContext)
String	getBaseTable() Return the base table.
String	getBaseTableAlias() Return the base table alias.
<U> BeanDescriptor<U>	getBeanDescriptor(Class<U> otherType) Return the BeanDescriptor of another bean type.
BeanDescriptor<?>	getBeanDescriptor(String path) Return the BeanDescriptor for a given path of Associated One or Many beans.
BeanFinder<T>	getBeanFinder() Return the beanFinder.
BeanProperty	getBeanProperty(String propName) Get a BeanProperty by its name.
BeanProperty	getBeanPropertyFromDbColumn(String dbColumn) Return the BeanProperty for the given deployment name.
BeanProperty	getBeanPropertyFromPath(String path) Return the bean property traversing the object graph and taking into account inheritance.
protected Object	getBeanPropertyWithInheritance(Object bean, String propName)
Class<T>	getBeanType() Return the class type this BeanDescriptor describes.
Object[]	getBindIdValues(Object idValue) Return the id as an array of scalar bindable values.
CacheOptions	getCacheOptions() Return the cache options.
CompoundUniqueContraint[]	getCompoundUniqueConstraints() Return the compound unique constraints.
ConcurrencyMode	getConcurrencyMode() Return the concurrency mode used for beans of this type.
String	getDefaultOrderBy() Return the default order by that may need to be added if a many property is included in the query.
String	getDefaultSelectClause() Return the default select clause.
Set<String>	getDefaultSelectClauseSet() Return the default select clause already parsed into an ordered Set.
String[]	getDependantTables() Return the tables this bean is dependent on.
String	getDescriptorId() Return the alternate "Id" that identifies this BeanDescriptor.
Set<String>	getDirtyEmbeddedProperties(Object bean) Return the Set of embedded beans that have changed.
SpiEbeanServer	getEbeanServer() Return the EbeanServer instance that owns this BeanDescriptor.
ElComparator<T>	getElComparator(String propNameOrSortBy)
ElPropertyValue	getElGetValue(String propName) Get an Expression language Value object.
ElPropertyDeploy	getElPropertyDeploy(String propName) Similar to ElPropertyValue but also uses foreign key shortcuts.
EncryptKey	getEncryptKey(BeanProperty p) Return the Encrypt key given the BeanProperty.
EncryptKey	getEncryptKey(String tableName, String columnName) Return the Encrypt key given the table and column name.
BeanDescriptor.EntityType	getEntityType() Return the type of this domain object.
String	getExtraAttribute(String key) Get a named extra attribute.
Class<?>	getFactoryType() Return the class type this BeanDescriptor describes.
String	getFullName() Return the bean class name this descriptor is used for.
Object	getId(Object bean) Helper method to return the unique property.
IdBinder	getIdBinder() Return the IdBinder which is helpful for handling the various types of Id.
String	getIdBinderIdSql() Return the sql for binding an id.
String	getIdBinderInLHSSql() Return the sql for binding id's using an IN clause.
IdGenerator	getIdGenerator() Return the IdGenerator.
IdType	getIdType() Return the identity generation type.
InheritInfo	getInheritInfo() Returns the Inheritance mapping information.
String	getLazyFetchIncludes() Return the includes for getReference().
BeanPropertyAssocMany<?>	getManyProperty(SpiQuery<?> query) Return the many property included in the query or null if one is not.
String	getName() Return the short name of the entity bean.
DeployNamedQuery	getNamedQuery(String name) Return a named query.
DeployNamedUpdate	getNamedUpdate(String name) Return a named update.
Set<String>	getNamesOfManyProps() Returns the set of many property names for this bean type.
int	getNamesOfManyPropsHash() Return a hash of the names of the many properties on this bean type.
BeanPersistController	getPersistController() Return the Controller.
BeanPersistListener<T>	getPersistListener() Return the beanListener.
BeanQueryAdapter	getQueryAdapter() Return the BeanQueryAdapter or null if none is defined.
CQueryPlan	getQueryPlan(HashQueryPlan key)
String	getSelectLastInsertedId() Return the SQL used to return the last inserted id.
String	getSequenceName() Return the sequence name.
String	getServerName() Return the name of the server this BeanDescriptor belongs to.
BeanProperty	getSingleIdProperty() If the Id is a single non-embedded property then returns that, otherwise returns null.
TypeManager	getTypeManager() Return the TypeManager.
BeanPropertyAssocOne<?>	getUnidirectional() Return the "shadow" property to support unidirectional relationships.
SpiUpdatePlan	getUpdatePlan(Integer key) Get a UpdatePlan for a given hash.
Object	getValue(Object bean, String property) Get a property value from a bean of this type.
boolean	hasDefaultSelectClause() Return true if this bean type has a default select clause that is not simply select all properties.
protected boolean	hasInheritance()
void	initialiseFkeys()
void	initialiseId() Initialise the Id properties first.
void	initialiseOther() Initialise the exported and imported parts for associated properties.
void	initInheritInfo()
boolean	isAutoFetchTunable() Return true if queries for beans of this type are autoFetch tunable.
boolean	isBaseTableType()
boolean	isBeanCaching() Return true if there is currently bean caching for this type of bean.
boolean	isCacheNotify() Return true if the persist request needs to notify the cache.
boolean	isCacheSharableBeans() Return true if this bean can cache sharable instances.
boolean	isComplexId() Return false if the id is a simple scalar and false if it is embedded or concatenated.
boolean	isDeleteRecurseSkippable() Return true if delete does not recurse to other beans.
protected boolean	isDynamicSubclass()
boolean	isEmbedded() Return true if this is an embedded bean.
boolean	isInheritanceRoot() Return true if this object is the root level object in its entity inheritance.
boolean	isLoadedReference(Set<String> loadedProps) Return true if the loadedProperties is just the Id property and therefore this is really a reference.
boolean	isQueryCaching() Return true if there is currently query caching for this type of bean.
boolean	isSaveRecurseSkippable() Return true if save does not recurse to other beans.
boolean	isSqlSelectBased() Returns true if this bean is based on a table (or possibly view) and returns false if this bean is based on a raw sql select statement.
boolean	isStatelessUpdate(Object bean) Return true if this is an Update (rather than insert) given that the bean is involved in a stateless update.
boolean	isUpdateChangesOnly() Return true if updates should only include changed properties.
boolean	isUseIdGenerator() Return true if this bean type should use IdGeneration.
boolean	isUsingL2Cache() Return true if there is L2 bean caching for this bean type.
ReadJsonContext.ReadBeanState	jsonRead(ReadJsonContext ctx, String path)
T	jsonReadBean(ReadJsonContext ctx, String path)
void	jsonWrite(WriteJsonContext ctx, Object bean)
boolean	lazyLoadMany(EntityBeanIntercept ebi) Return true if the lazy loading property is a Many in which case just define a Reference for the collection and not invoke a query.
boolean	loadFromCache(EntityBeanIntercept ebi)
boolean	loadFromCache(Object bean, EntityBeanIntercept ebi, Object id)
Object	nextId(Transaction t)
void	postLoad(Object bean, Set<String> includedProperties) Execute the postLoad if a BeanPersistController exists for this bean.
void	preAllocateIds(int batchSize)
Iterator<BeanProperty>	propertiesAll() Return an Iterator of all BeanProperty.
BeanPropertyCompound[]	propertiesBaseCompound() Return properties that are immutable compound value objects.
BeanProperty[]	propertiesBaseScalar() Scalar properties without the unique id or secondary table properties.
BeanPropertyAssocOne<?>[]	propertiesEmbedded() Return the beans that are embedded.
BeanProperty[]	propertiesId() Return the BeanProperty that make up the unique id.
BeanProperty[]	propertiesLocal() Return the properties local to this type for inheritance.
BeanPropertyAssocMany<?>[]	propertiesMany() All Assoc Many's for this descriptor.
BeanPropertyAssocMany<?>[]	propertiesManyDelete() Assoc Many's with delete cascade.
BeanPropertyAssocMany<?>[]	propertiesManySave() Assoc Many's with save cascade.
BeanPropertyAssocMany<?>[]	propertiesManyToMany() Assoc ManyToMany's.
BeanProperty[]	propertiesNonMany() All Non Assoc Many's for this descriptor.
BeanProperty[]	propertiesNonTransient() Return the non transient non id properties.
BeanPropertyAssocOne<?>[]	propertiesOne() All the BeanPropertyAssocOne that are not embedded.
BeanPropertyAssocOne<?>[]	propertiesOneExported() Returns OneToOnes that are on the exported side of a OneToOne.
BeanPropertyAssocOne<?>[]	propertiesOneExportedDelete() Exported assoc ones with delete cascade.
BeanPropertyAssocOne<?>[]	propertiesOneExportedSave() Exported assoc ones with cascade save.
BeanPropertyAssocOne<?>[]	propertiesOneImported() Returns ManyToOnes and OneToOnes on the imported owning side.
BeanPropertyAssocOne<?>[]	propertiesOneImportedDelete() Imported Assoc Ones with cascade delete true.
BeanPropertyAssocOne<?>[]	propertiesOneImportedSave() Imported Assoc Ones with cascade save true.
BeanProperty[]	propertiesTransient() Return the transient properties.
BeanProperty[]	propertiesVersion() Returns 'Version' properties on this bean.
void	putQueryPlan(HashQueryPlan key, CQueryPlan plan)
void	putUpdatePlan(Integer key, SpiUpdatePlan plan) Add a UpdatePlan to the cache with a given hash.
void	queryCacheClear() Clear the query cache.
BeanCollection<T>	queryCacheGet(Object id) Get a query result from the query cache.
void	queryCachePut(Object id, BeanCollection<T> query) Put a query result into the query cache.
Iterator<CQueryPlan>	queryPlans() Return the query plans for this BeanDescriptor.
void	register(BeanPersistController newController) Register the new BeanPersistController.
void	register(BeanPersistListener<?> newPersistListener) Register the new BeanPersistController.
void	runCacheWarming() Execute the warming cache query (if defined) and load the cache.
void	setEbeanServer(SpiEbeanServer ebeanServer) Set the server.
void	setLoadedProps(EntityBeanIntercept ebi, Set<String> loadedProps) Set the loaded properties with additional check to see if the bean is a reference.
void	sort(List<T> list, String sortByClause)
TableJoin[]	tableJoins() Return the TableJoins.
String	toString() Summary description.

Methods inherited from class java.lang.Object

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

Property Detail

firstVersion

Return the first version property that exists on the bean. Returns null if no version property exists on the bean.

Note that this DOES NOT find a version property on an embedded bean.

Constructor Detail

BeanDescriptor

public BeanDescriptor(BeanDescriptorMap owner,
              TypeManager typeManager,
              DeployBeanDescriptor<T> deploy,
              String descriptorId)

Construct the BeanDescriptor.

Method Detail

setEbeanServer

public void setEbeanServer(SpiEbeanServer ebeanServer)

Set the server. Primarily so that the Many's can lazy load.

determineConcurrencyMode

public ConcurrencyMode determineConcurrencyMode(Object bean)

Determine the concurrency mode based on the existence of a non-null version property value.

getDirtyEmbeddedProperties

public Set<String> getDirtyEmbeddedProperties(Object bean)

Return the Set of embedded beans that have changed.

determineLoadedProperties

public Set<String> determineLoadedProperties(Object bean)

Determine the non-null properties of the bean.

getEbeanServer

public SpiEbeanServer getEbeanServer()

Return the EbeanServer instance that owns this BeanDescriptor.

getEntityType

public BeanDescriptor.EntityType getEntityType()

Return the type of this domain object.

initialiseId

public void initialiseId()

Initialise the Id properties first.

These properties need to be initialised prior to the association properties as they are used to get the imported and exported properties.

initialiseOther

public void initialiseOther()

Initialise the exported and imported parts for associated properties.

initInheritInfo

public void initInheritInfo()

cacheInitialise

public void cacheInitialise()

Initialise the cache once the server has started.

hasInheritance

protected boolean hasInheritance()

isDynamicSubclass

protected boolean isDynamicSubclass()

deleteById

public SqlUpdate deleteById(Object id,
                   List<Object> idList)

add

public void add(BeanFkeyProperty fkey)

Add objects to ElPropertyDeploy etc. These are used so that expressions on foreign keys don't require an extra join.

initialiseFkeys

public void initialiseFkeys()

calculateUseCache

public boolean calculateUseCache(Boolean queryUseCache)

calculateUseNaturalKeyCache

public boolean calculateUseNaturalKeyCache(Boolean queryUseCache)

getCacheOptions

public CacheOptions getCacheOptions()

Return the cache options.

getEncryptKey

public EncryptKey getEncryptKey(BeanProperty p)

Return the Encrypt key given the BeanProperty.

getEncryptKey

public EncryptKey getEncryptKey(String tableName,
                       String columnName)

Return the Encrypt key given the table and column name.

runCacheWarming

public void runCacheWarming()

Execute the warming cache query (if defined) and load the cache.

hasDefaultSelectClause

public boolean hasDefaultSelectClause()

Return true if this bean type has a default select clause that is not simply select all properties.

getDefaultSelectClause

public String getDefaultSelectClause()

Return the default select clause.

getDefaultSelectClauseSet

public Set<String> getDefaultSelectClauseSet()

Return the default select clause already parsed into an ordered Set.

isInheritanceRoot

public boolean isInheritanceRoot()

Return true if this object is the root level object in its entity inheritance.

isQueryCaching

public boolean isQueryCaching()

Return true if there is currently query caching for this type of bean.

isBeanCaching

public boolean isBeanCaching()

Return true if there is currently bean caching for this type of bean.

cacheIsUseManyId

public boolean cacheIsUseManyId()

isCacheNotify

public boolean isCacheNotify()

Return true if the persist request needs to notify the cache.

isUsingL2Cache

public boolean isUsingL2Cache()

Return true if there is L2 bean caching for this bean type.

cacheNotify

public void cacheNotify(TransactionEventTable.TableIUD tableIUD)

Invalidate parts of cache due to SqlUpdate or external modification etc.

queryCacheClear

public void queryCacheClear()

Clear the query cache.

queryCacheGet

public BeanCollection<T> queryCacheGet(Object id)

Get a query result from the query cache.

queryCachePut

public void queryCachePut(Object id,
                 BeanCollection<T> query)

Put a query result into the query cache.

cacheClear

public void cacheClear()

Clear the bean cache.

cachePutBeanData

public void cachePutBeanData(Object bean)

Put a bean into the bean cache.

cacheLoadMany

public boolean cacheLoadMany(BeanPropertyAssocMany<?> many,
                    BeanCollection<?> bc,
                    Object parentId,
                    Boolean readOnly)

cachePutMany

public void cachePutMany(BeanPropertyAssocMany<?> many,
                BeanCollection<?> bc,
                Object parentId)

cacheRemoveCachedManyIds

public void cacheRemoveCachedManyIds(Object parentId,
                            String propertyName)

cacheClearCachedManyIds

public void cacheClearCachedManyIds(String propertyName)

cacheGetCachedManyIds

public CachedManyIds cacheGetCachedManyIds(Object parentId,
                                  String propertyName)

cachePutCachedManyIds

public void cachePutCachedManyIds(Object parentId,
                         String propertyName,
                         CachedManyIds ids)

cacheGetBean

public T cacheGetBean(Object id,
             Boolean readOnly)

Return a bean from the bean cache.

cacheIsNaturalKey

public boolean cacheIsNaturalKey(String propName)

cacheGetNaturalKeyId

public Object cacheGetNaturalKeyId(Object uniqueKeyValue)

cacheRemove

public void cacheRemove(Object id)

Remove a bean from the cache given its Id.

cacheDelete

public void cacheDelete(Object id,
               PersistRequestBean<T> deleteRequest)

Remove a bean from the cache given its Id.

cacheInsert

public void cacheInsert(Object id,
               PersistRequestBean<T> insertRequest)

cacheUpdate

public void cacheUpdate(Object id,
               PersistRequestBean<T> updateRequest)

Update the cached bean data.

getBaseTableAlias

public String getBaseTableAlias()

Return the base table alias. This is always the first letter of the bean name.

loadFromCache

public boolean loadFromCache(EntityBeanIntercept ebi)

loadFromCache

public boolean loadFromCache(Object bean,
                    EntityBeanIntercept ebi,
                    Object id)

preAllocateIds

public void preAllocateIds(int batchSize)

nextId

public Object nextId(Transaction t)

createDeployPropertyParser

public DeployPropertyParser createDeployPropertyParser()

convertOrmUpdateToSql

public String convertOrmUpdateToSql(String ormUpdateStatement)

Convert the logical orm update statement into sql by converting the bean properties and bean name to database columns and table.

collectQueryPlanStatistics

public List<MetaQueryPlanStatistic> collectQueryPlanStatistics(boolean reset)

Description copied from interface: MetaBeanInfo

Collect the current query plan statistics return the non-empty statistics.

Specified by:

collectQueryPlanStatistics in interface MetaBeanInfo

collectAllQueryPlanStatistics

public List<MetaQueryPlanStatistic> collectAllQueryPlanStatistics(boolean reset)

Description copied from interface: MetaBeanInfo

Collect the current query plan statistics return all the statistics (include query plans that haven't had query executions).

Specified by:

collectAllQueryPlanStatistics in interface MetaBeanInfo

collectQueryPlanStatisticsInternal

public List<MetaQueryPlanStatistic> collectQueryPlanStatisticsInternal(boolean reset,
                                                              boolean collectAll)

clearQueryStatistics

public void clearQueryStatistics()

Reset the statistics on all the query plans.

postLoad

public void postLoad(Object bean,
            Set<String> includedProperties)

Execute the postLoad if a BeanPersistController exists for this bean.

queryPlans

public Iterator<CQueryPlan> queryPlans()

Return the query plans for this BeanDescriptor.

getQueryPlan

public CQueryPlan getQueryPlan(HashQueryPlan key)

putQueryPlan

public void putQueryPlan(HashQueryPlan key,
                CQueryPlan plan)

getUpdatePlan

public SpiUpdatePlan getUpdatePlan(Integer key)

Get a UpdatePlan for a given hash.

putUpdatePlan

public void putUpdatePlan(Integer key,
                 SpiUpdatePlan plan)

Add a UpdatePlan to the cache with a given hash.

getTypeManager

public TypeManager getTypeManager()

Return the TypeManager.

isUpdateChangesOnly

public boolean isUpdateChangesOnly()

Return true if updates should only include changed properties. Otherwise all loaded properties are included in the update.

isSaveRecurseSkippable

public boolean isSaveRecurseSkippable()

Return true if save does not recurse to other beans. That is return true if there are no assoc one or assoc many beans that cascade save.

isDeleteRecurseSkippable

public boolean isDeleteRecurseSkippable()

Return true if delete does not recurse to other beans. That is return true if there are no assoc one or assoc many beans that cascade delete.

getManyProperty

public BeanPropertyAssocMany<?> getManyProperty(SpiQuery<?> query)

Return the many property included in the query or null if one is not.

getIdBinder

public IdBinder getIdBinder()

Return the IdBinder which is helpful for handling the various types of Id.

getIdBinderIdSql

public String getIdBinderIdSql()

Return the sql for binding an id. This is the columns with table alias that make up the id.

getIdBinderInLHSSql

public String getIdBinderInLHSSql()

Return the sql for binding id's using an IN clause.

bindId

public void bindId(DataBind dataBind,
          Object idValue)
            throws SQLException

Bind the idValue to the preparedStatement.

This takes care of the various id types such as embedded beans etc.

Throws:

SQLException

getBindIdValues

public Object[] getBindIdValues(Object idValue)

Return the id as an array of scalar bindable values.

This 'flattens' any EmbeddedId or multiple Id property cases.

getNamedQuery

public DeployNamedQuery getNamedQuery(String name)

Return a named query.

addNamedQuery

public DeployNamedQuery addNamedQuery(DeployNamedQuery deployNamedQuery)

getNamedUpdate

public DeployNamedUpdate getNamedUpdate(String name)

Return a named update.

createBean

public Object createBean()

Create an EntityBean.

createEntityBean

public EntityBean createEntityBean()

Creates a new EntityBean without using the creation queue.

createReference

public T createReference(Boolean readOnly,
                Object id,
                Object parent)

Create a reference bean based on the id.

getBeanPropertyFromDbColumn

public BeanProperty getBeanPropertyFromDbColumn(String dbColumn)

Return the BeanProperty for the given deployment name.

getBeanPropertyFromPath

public BeanProperty getBeanPropertyFromPath(String path)

Return the bean property traversing the object graph and taking into account inheritance.

getBeanDescriptor

public BeanDescriptor<?> getBeanDescriptor(String path)

Return the BeanDescriptor for a given path of Associated One or Many beans.

getBeanDescriptor

public <U> BeanDescriptor<U> getBeanDescriptor(Class<U> otherType)

Return the BeanDescriptor of another bean type.

getUnidirectional

public BeanPropertyAssocOne<?> getUnidirectional()

Return the "shadow" property to support unidirectional relationships.

For bidirectional this is a real property on the bean. For unidirectional relationships we have this 'shadow' property which is not externally visible.

getValue

public Object getValue(Object bean,
              String property)

Get a property value from a bean of this type.

isUseIdGenerator

public boolean isUseIdGenerator()

Return true if this bean type should use IdGeneration.

If this is false and the Id is null it is assumed that a database auto increment feature is being used to populate the id.

getDescriptorId

public String getDescriptorId()

Return the alternate "Id" that identifies this BeanDescriptor. This is an alternative to using the bean class name.

getBeanType

public Class<T> getBeanType()

Return the class type this BeanDescriptor describes.

getFactoryType

public Class<?> getFactoryType()

Return the class type this BeanDescriptor describes.

getFullName

public String getFullName()

Return the bean class name this descriptor is used for.

If this BeanDescriptor is for a table then this returns the table name instead.

getName

public String getName()

Return the short name of the entity bean.

toString

public String toString()

Summary description.

Overrides:

toString in class Object

getId

public Object getId(Object bean)

Helper method to return the unique property. If only one property makes up the unique id then it's value is returned. If there is a concatenated unique id then a Map is built with the keys being the names of the properties that make up the unique id.

isComplexId

public boolean isComplexId()

Return false if the id is a simple scalar and false if it is embedded or concatenated.

getDefaultOrderBy

public String getDefaultOrderBy()

Return the default order by that may need to be added if a many property is included in the query.

convertId

public Object convertId(Object idValue)

Convert the type of the idValue if required.

convertSetId

public Object convertSetId(Object idValue,
                  Object bean)

Convert and set the id value.

If the bean is not null, the id value is set to the id property of the bean after it has been converted to the correct type.

getBeanProperty

public BeanProperty getBeanProperty(String propName)

Get a BeanProperty by its name.

sort

public void sort(List<T> list,
        String sortByClause)

getElComparator

public ElComparator<T> getElComparator(String propNameOrSortBy)

lazyLoadMany

public boolean lazyLoadMany(EntityBeanIntercept ebi)

Return true if the lazy loading property is a Many in which case just define a Reference for the collection and not invoke a query.

getElGetValue

public ElPropertyValue getElGetValue(String propName)

Get an Expression language Value object.

getElPropertyDeploy

public ElPropertyDeploy getElPropertyDeploy(String propName)

Similar to ElPropertyValue but also uses foreign key shortcuts.

The foreign key shortcuts means we can avoid unnecessary joins.

buildElGetValue

protected ElPropertyValue buildElGetValue(String propName,
                              ElPropertyChainBuilder chain,
                              boolean propertyDeploy)

findBeanProperty

public BeanProperty findBeanProperty(String propName)

Find a BeanProperty including searching the inheritance hierarchy.

This searches this BeanDescriptor and then searches further down the inheritance tree (not up).

getBeanPropertyWithInheritance

protected Object getBeanPropertyWithInheritance(Object bean,
                                    String propName)

getServerName

public String getServerName()

Return the name of the server this BeanDescriptor belongs to.

isCacheSharableBeans

public boolean isCacheSharableBeans()

Return true if this bean can cache sharable instances.

This means is has no relationships and has readOnly=true in its cache options.

isAutoFetchTunable

public boolean isAutoFetchTunable()

Return true if queries for beans of this type are autoFetch tunable.

getInheritInfo

public InheritInfo getInheritInfo()

Returns the Inheritance mapping information. This will be null if this type of bean is not involved in any ORM inheritance mapping.

isEmbedded

public boolean isEmbedded()

Return true if this is an embedded bean.

isBaseTableType

public boolean isBaseTableType()

getConcurrencyMode

public ConcurrencyMode getConcurrencyMode()

Return the concurrency mode used for beans of this type.

getDependantTables

public String[] getDependantTables()

Return the tables this bean is dependent on. This implies that if any of these tables are modified then cached beans may be invalidated.

getCompoundUniqueConstraints

public CompoundUniqueContraint[] getCompoundUniqueConstraints()

Return the compound unique constraints.

getPersistListener

public BeanPersistListener<T> getPersistListener()

Return the beanListener.

getBeanFinder

public BeanFinder<T> getBeanFinder()

Return the beanFinder. Usually null unless overriding the finder.

getQueryAdapter

public BeanQueryAdapter getQueryAdapter()

Return the BeanQueryAdapter or null if none is defined.

deregister

public void deregister(BeanPersistListener<?> listener)

De-register the BeanPersistListener.

deregister

public void deregister(BeanPersistController controller)

De-register the BeanPersistController.

register

public void register(BeanPersistListener<?> newPersistListener)

Register the new BeanPersistController.

register

public void register(BeanPersistController newController)

Register the new BeanPersistController.

getPersistController

public BeanPersistController getPersistController()

Return the Controller.

isSqlSelectBased

public boolean isSqlSelectBased()

Returns true if this bean is based on a table (or possibly view) and returns false if this bean is based on a raw sql select statement.

When false querying this bean is based on a supplied sql select statement placed in the orm xml file (as opposed to Ebean generated sql).

getBaseTable

public String getBaseTable()

Return the base table. Only properties mapped to the base table are by default persisted.

getExtraAttribute

public String getExtraAttribute(String key)

Get a named extra attribute.

getIdType

public IdType getIdType()

Return the identity generation type.

getSequenceName

public String getSequenceName()

Return the sequence name.

getSelectLastInsertedId

public String getSelectLastInsertedId()

Return the SQL used to return the last inserted id.

This is only used with Identity columns and getGeneratedKeys is not supported.

getIdGenerator

public IdGenerator getIdGenerator()

Return the IdGenerator.

getLazyFetchIncludes

public String getLazyFetchIncludes()

Return the includes for getReference().

tableJoins

public TableJoin[] tableJoins()

Return the TableJoins.

For properties mapped to secondary tables rather than the base table.

propertiesAll

public Iterator<BeanProperty> propertiesAll()

Return an Iterator of all BeanProperty. This includes transient properties.

propertiesId

public BeanProperty[] propertiesId()

Return the BeanProperty that make up the unique id.

The order of these properties can be relied on to be consistent if the bean itself doesn't change or the xml deployment order does not change.

propertiesNonTransient

public BeanProperty[] propertiesNonTransient()

Return the non transient non id properties.

propertiesTransient

public BeanProperty[] propertiesTransient()

Return the transient properties.

getSingleIdProperty

public BeanProperty getSingleIdProperty()

If the Id is a single non-embedded property then returns that, otherwise returns null.

propertiesEmbedded

public BeanPropertyAssocOne<?>[] propertiesEmbedded()

Return the beans that are embedded. These share the base table with the owner bean.

propertiesOne

public BeanPropertyAssocOne<?>[] propertiesOne()

All the BeanPropertyAssocOne that are not embedded. These are effectively joined beans. For ManyToOne and OneToOne associations.

propertiesOneImported

public BeanPropertyAssocOne<?>[] propertiesOneImported()

Returns ManyToOnes and OneToOnes on the imported owning side.

Excludes OneToOnes on the exported side.

propertiesOneImportedSave

public BeanPropertyAssocOne<?>[] propertiesOneImportedSave()

Imported Assoc Ones with cascade save true.

propertiesOneImportedDelete

public BeanPropertyAssocOne<?>[] propertiesOneImportedDelete()

Imported Assoc Ones with cascade delete true.

propertiesOneExported

public BeanPropertyAssocOne<?>[] propertiesOneExported()

Returns OneToOnes that are on the exported side of a OneToOne.

These associations do not own the relationship.

propertiesOneExportedSave

public BeanPropertyAssocOne<?>[] propertiesOneExportedSave()

Exported assoc ones with cascade save.

propertiesOneExportedDelete

public BeanPropertyAssocOne<?>[] propertiesOneExportedDelete()

Exported assoc ones with delete cascade.

getNamesOfManyPropsHash

public int getNamesOfManyPropsHash()

Return a hash of the names of the many properties on this bean type. This is used for efficient building of included properties sets for partial objects.

getNamesOfManyProps

public Set<String> getNamesOfManyProps()

Returns the set of many property names for this bean type.

propertiesNonMany

public BeanProperty[] propertiesNonMany()

All Non Assoc Many's for this descriptor.

propertiesMany

public BeanPropertyAssocMany<?>[] propertiesMany()

All Assoc Many's for this descriptor.

propertiesManySave

public BeanPropertyAssocMany<?>[] propertiesManySave()

Assoc Many's with save cascade.

propertiesManyDelete

public BeanPropertyAssocMany<?>[] propertiesManyDelete()

Assoc Many's with delete cascade.

propertiesManyToMany

public BeanPropertyAssocMany<?>[] propertiesManyToMany()

Assoc ManyToMany's.

firstVersionProperty

public BeanProperty firstVersionProperty()

Return the first version property that exists on the bean. Returns null if no version property exists on the bean.

Note that this DOES NOT find a version property on an embedded bean.

isStatelessUpdate

public boolean isStatelessUpdate(Object bean)

Return true if this is an Update (rather than insert) given that the bean is involved in a stateless update.

propertiesVersion

public BeanProperty[] propertiesVersion()

Returns 'Version' properties on this bean. These are 'Counter' or 'Update Timestamp' type properties. Note version properties can also be on embedded beans rather than on the bean itself.

propertiesBaseScalar

public BeanProperty[] propertiesBaseScalar()

Scalar properties without the unique id or secondary table properties.

propertiesBaseCompound

public BeanPropertyCompound[] propertiesBaseCompound()

Return properties that are immutable compound value objects.

These are compound types but are not enhanced (Embedded are enhanced).

propertiesLocal

public BeanProperty[] propertiesLocal()

Return the properties local to this type for inheritance.

jsonWrite

public void jsonWrite(WriteJsonContext ctx,
             Object bean)

jsonReadBean

public T jsonReadBean(ReadJsonContext ctx,
             String path)

jsonRead

public ReadJsonContext.ReadBeanState jsonRead(ReadJsonContext ctx,
                                     String path)

setLoadedProps

public void setLoadedProps(EntityBeanIntercept ebi,
                  Set<String> loadedProps)

Set the loaded properties with additional check to see if the bean is a reference.

isLoadedReference

public boolean isLoadedReference(Set<String> loadedProps)

Return true if the loadedProperties is just the Id property and therefore this is really a reference.

flushPersistenceContextOnIterate

public void flushPersistenceContextOnIterate(PersistenceContext persistenceContext)