com.avaje.ebeaninternal.server.deploy.meta

Class DeployBeanDescriptor<T>

java.lang.Object

com.avaje.ebeaninternal.server.deploy.meta.DeployBeanDescriptor<T>

public class DeployBeanDescriptor<T>
extends Object

Describes Beans including their deployment information.

Constructor Summary

Constructors

Constructor and Description
DeployBeanDescriptor(Class<T> beanType) Construct the BeanDescriptor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(DeployNamedQuery namedQuery)
void	add(DeployNamedUpdate namedUpdate)
void	add(DRawSqlMeta rawSqlMeta)
DeployBeanProperty	addBeanProperty(DeployBeanProperty prop) Add a bean property.
void	addCompoundUniqueConstraint(CompoundUniqueContraint c) Add a compound unique constraint.
void	addPersistController(BeanPersistController controller) Set the Controller.
void	addPersistListener(BeanPersistListener<T> listener)
void	addQueryAdapter(BeanQueryAdapter queryAdapter)
void	addTableJoin(DeployTableJoin join) Add a TableJoin to this type of bean.
boolean	checkReadAndWriteMethods() Check all the properties to see if they all have read and write methods (required if using "subclassing" but not for "enhancement").
DeployBeanTable	createDeployBeanTable()
DeployBeanPropertyAssocOne<?>	findJoinToTable(String tableName)
String	getBaseTable() Return the base table.
TableName	getBaseTableFull() Return the base table with full structure.
BeanFinder<T>	getBeanFinder() Return the beanFinder.
DeployBeanProperty	getBeanProperty(String propName) Get a BeanProperty by its name.
BeanReflect	getBeanReflect()
Class<T>	getBeanType() Return the class type this BeanDescriptor describes.
CacheOptions	getCacheOptions() Return the reference options.
CompoundUniqueContraint[]	getCompoundUniqueConstraints() Return the compound unique constraints (can be null).
ConcurrencyMode	getConcurrencyMode() Return the concurrency mode used for beans of this type.
String	getDefaultSelectClause() Return the defaultSelectClause using FetchType.LAZY and FetchType.EAGER.
String[]	getDependantTables() Return the tables this bean is dependant on.
BeanDescriptor.EntityType	getEntityType()
String	getExtraAttribute(String key) Get a named extra attribute.
Map<String,String>	getExtraAttributeMap()
Class<?>	getFactoryType() Return the class type this BeanDescriptor describes.
String	getFullName() Return the bean class name this descriptor is used for.
IdGenerator	getIdGenerator() Return the actual IdGenerator for this bean type (can be null).
String	getIdGeneratorName() Return the name of the IdGenerator that should be used with this type of bean.
IdType	getIdType() Return the identity generation type.
InheritInfo	getInheritInfo() Returns the Inheritance mapping information.
String	getLazyFetchIncludes() Return the includes for getReference().
String	getName() Return the bean short name.
Map<String,DeployNamedQuery>	getNamedQueries()
Map<String,DeployNamedUpdate>	getNamedUpdates()
BeanPersistController	getPersistController() Return the BeanPersistController (could be a chain of them, 1 or null).
BeanPersistListener<T>	getPersistListener() Return the BeanPersistListener (could be a chain of them, 1 or null).
BeanQueryAdapter	getQueryAdapter()
Collection<DRawSqlMeta>	getRawSqlMeta()
String	getSelectLastInsertedId() Return the SQL used to return the last inserted Id.
String	getSequenceName() Return the DB sequence name (can be null).
String	getSinglePrimaryKeyColumn() Return the Primary Key column assuming it is a single column (not compound).
List<DeployTableJoin>	getTableJoins()
DeployBeanPropertyAssocOne<?>	getUnidirectional()
boolean	isAbstract() Return true if this beanType is an abstract class.
boolean	isBaseTableType()
boolean	isEmbedded()
boolean	isNaturalKeyProperty(String name)
boolean	isScalaObject()
boolean	isUpdateChangesOnly()
boolean	isUseIdGenerator() Return true if this bean type should use IdGeneration.
Set<String>	parseDefaultSelectClause(String rawList) Parse the include separating by comma or semicolon.
Iterator<DeployBeanProperty>	propertiesAll() Return an Iterator of all BeanProperty.
List<DeployBeanPropertyAssocMany<?>>	propertiesAssocMany() Return BeanPropertyAssocMany for this descriptor.
List<DeployBeanPropertyAssocOne<?>>	propertiesAssocOne() Return an Iterator of BeanPropertyAssocOne that are not embedded.
List<DeployBeanProperty>	propertiesBase() base properties without the unique id properties.
List<DeployBeanProperty>	propertiesId() Return the BeanProperty that make up the unique id.
List<DeployBeanProperty>	propertiesVersion() Returns 'Version' properties on this bean.
void	setBaseTable(TableName baseTableFull) Set the base table.
void	setBeanFinder(BeanFinder<T> beanFinder) Set the BeanFinder to use for beans of this type.
void	setBeanReflect(BeanReflect beanReflect) Set the BeanReflect used to create new instances of an EntityBean.
void	setConcurrencyMode(ConcurrencyMode concurrencyMode) Set the concurrency mode used for beans of this type.
void	setDependantTables(String[] dependantTables) Set the tables this bean is dependant on.
void	setEntityType(BeanDescriptor.EntityType entityType)
void	setExtraAttribute(String key, String value) Set an extra attribute with a given name.
void	setFactoryType(Class<?> factoryType) Set the class used to create new EntityBean instances.
void	setIdGenerator(IdGenerator idGenerator) Set the actual IdGenerator for this bean type.
void	setIdGeneratorName(String idGeneratorName) Set the name of the IdGenerator that should be used with this type of bean.
void	setIdType(IdType idType) Set the identity generation type.
void	setInheritInfo(InheritInfo inheritInfo) Set the ORM inheritance mapping information.
void	setLazyFetchIncludes(String lazyFetchIncludes) Set includes to use for lazy loading by getReference().
void	setName(String name) Set the bean shortName.
void	setSelectLastInsertedId(String selectLastInsertedId) Set the SQL used to return the last inserted Id.
void	setSequenceName(String sequenceName) Set the DB sequence name.
void	setUnidirectional(DeployBeanPropertyAssocOne<?> unidirectional)
void	setUpdateChangesOnly(boolean updateChangesOnly)
void	sortProperties()
String	toString() Summary description.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployBeanDescriptor

public DeployBeanDescriptor(Class<T> beanType)

Construct the BeanDescriptor.

Method Detail

isAbstract

public boolean isAbstract()

Return true if this beanType is an abstract class.

isScalaObject

public boolean isScalaObject()

getRawSqlMeta

public Collection<DRawSqlMeta> getRawSqlMeta()

createDeployBeanTable

public DeployBeanTable createDeployBeanTable()

checkReadAndWriteMethods

public boolean checkReadAndWriteMethods()

Check all the properties to see if they all have read and write methods (required if using "subclassing" but not for "enhancement").

setEntityType

public void setEntityType(BeanDescriptor.EntityType entityType)

isEmbedded

public boolean isEmbedded()

isBaseTableType

public boolean isBaseTableType()

getEntityType

public BeanDescriptor.EntityType getEntityType()

add

public void add(DRawSqlMeta rawSqlMeta)

add

public void add(DeployNamedUpdate namedUpdate)

add

public void add(DeployNamedQuery namedQuery)

getNamedQueries

public Map<String,DeployNamedQuery> getNamedQueries()

getNamedUpdates

public Map<String,DeployNamedUpdate> getNamedUpdates()

getBeanReflect

public BeanReflect getBeanReflect()

getBeanType

public Class<T> getBeanType()

Return the class type this BeanDescriptor describes.

getFactoryType

public Class<?> getFactoryType()

Return the class type this BeanDescriptor describes.

setFactoryType

public void setFactoryType(Class<?> factoryType)

Set the class used to create new EntityBean instances.

Normally this would be a subclass dynamically generated for this bean.

setBeanReflect

public void setBeanReflect(BeanReflect beanReflect)

Set the BeanReflect used to create new instances of an EntityBean. This could use reflection or code generation to do this.

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.

setInheritInfo

public void setInheritInfo(InheritInfo inheritInfo)

Set the ORM inheritance mapping information.

getCacheOptions

public CacheOptions getCacheOptions()

Return the reference options.

isNaturalKeyProperty

public boolean isNaturalKeyProperty(String name)

getUnidirectional

public DeployBeanPropertyAssocOne<?> getUnidirectional()

setUnidirectional

public void setUnidirectional(DeployBeanPropertyAssocOne<?> unidirectional)

getConcurrencyMode

public ConcurrencyMode getConcurrencyMode()

Return the concurrency mode used for beans of this type.

setConcurrencyMode

public void setConcurrencyMode(ConcurrencyMode concurrencyMode)

Set the concurrency mode used for beans of this type.

isUpdateChangesOnly

public boolean isUpdateChangesOnly()

setUpdateChangesOnly

public void setUpdateChangesOnly(boolean updateChangesOnly)

getDependantTables

public String[] getDependantTables()

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

addCompoundUniqueConstraint

public void addCompoundUniqueConstraint(CompoundUniqueContraint c)

Add a compound unique constraint.

getCompoundUniqueConstraints

public CompoundUniqueContraint[] getCompoundUniqueConstraints()

Return the compound unique constraints (can be null).

setDependantTables

public void setDependantTables(String[] dependantTables)

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

getBeanFinder

public BeanFinder<T> getBeanFinder()

Return the beanFinder. Usually null unless overriding the finder.

setBeanFinder

public void setBeanFinder(BeanFinder<T> beanFinder)

Set the BeanFinder to use for beans of this type. This is set to override the finding from the default.

getPersistController

public BeanPersistController getPersistController()

Return the BeanPersistController (could be a chain of them, 1 or null).

getPersistListener

public BeanPersistListener<T> getPersistListener()

Return the BeanPersistListener (could be a chain of them, 1 or null).

getQueryAdapter

public BeanQueryAdapter getQueryAdapter()

addPersistController

public void addPersistController(BeanPersistController controller)

Set the Controller.

addPersistListener

public void addPersistListener(BeanPersistListener<T> listener)

addQueryAdapter

public void addQueryAdapter(BeanQueryAdapter queryAdapter)

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.

getBaseTable

public String getBaseTable()

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

getBaseTableFull

public TableName getBaseTableFull()

Return the base table with full structure.

setBaseTable

public void setBaseTable(TableName baseTableFull)

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

sortProperties

public void sortProperties()

addBeanProperty

public DeployBeanProperty addBeanProperty(DeployBeanProperty prop)

Add a bean property.

getBeanProperty

public DeployBeanProperty getBeanProperty(String propName)

Get a BeanProperty by its name.

getExtraAttributeMap

public Map<String,String> getExtraAttributeMap()

getExtraAttribute

public String getExtraAttribute(String key)

Get a named extra attribute.

setExtraAttribute

public void setExtraAttribute(String key,
                     String value)

Set an extra attribute with a given name.

Parameters:

key - the name of the extra attribute

value - the value of the extra attribute

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 bean short name.

setName

public void setName(String name)

Set the bean shortName.

getIdType

public IdType getIdType()

Return the identity generation type.

setIdType

public void setIdType(IdType idType)

Set the identity generation type.

getSequenceName

public String getSequenceName()

Return the DB sequence name (can be null).

setSequenceName

public void setSequenceName(String sequenceName)

Set the DB sequence name.

getSelectLastInsertedId

public String getSelectLastInsertedId()

Return the SQL used to return the last inserted Id.

Used with Identity columns where getGeneratedKeys is not supported.

setSelectLastInsertedId

public void setSelectLastInsertedId(String selectLastInsertedId)

Set the SQL used to return the last inserted Id.

getIdGeneratorName

public String getIdGeneratorName()

Return the name of the IdGenerator that should be used with this type of bean. A null value could be used to specify the 'default' IdGenerator.

setIdGeneratorName

public void setIdGeneratorName(String idGeneratorName)

Set the name of the IdGenerator that should be used with this type of bean.

getIdGenerator

public IdGenerator getIdGenerator()

Return the actual IdGenerator for this bean type (can be null).

setIdGenerator

public void setIdGenerator(IdGenerator idGenerator)

Set the actual IdGenerator for this bean type.

getLazyFetchIncludes

public String getLazyFetchIncludes()

Return the includes for getReference().

setLazyFetchIncludes

public void setLazyFetchIncludes(String lazyFetchIncludes)

Set includes to use for lazy loading by getReference(). Note queries also build references and includes on the actual association are used for those references.

toString

public String toString()

Summary description.

Overrides:

toString in class Object

addTableJoin

public void addTableJoin(DeployTableJoin join)

Add a TableJoin to this type of bean. For Secondary table properties.

getTableJoins

public List<DeployTableJoin> getTableJoins()

propertiesAll

public Iterator<DeployBeanProperty> propertiesAll()

Return an Iterator of all BeanProperty.

getDefaultSelectClause

public String getDefaultSelectClause()

Return the defaultSelectClause using FetchType.LAZY and FetchType.EAGER.

parseDefaultSelectClause

public Set<String> parseDefaultSelectClause(String rawList)

Parse the include separating by comma or semicolon.

getSinglePrimaryKeyColumn

public String getSinglePrimaryKeyColumn()

Return the Primary Key column assuming it is a single column (not compound). This is for the purpose of defining a sequence name.

propertiesId

public List<DeployBeanProperty> 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.

findJoinToTable

public DeployBeanPropertyAssocOne<?> findJoinToTable(String tableName)

propertiesAssocOne

public List<DeployBeanPropertyAssocOne<?>> propertiesAssocOne()

Return an Iterator of BeanPropertyAssocOne that are not embedded. These are effectively joined beans. For ManyToOne and OneToOne associations.

propertiesAssocMany

public List<DeployBeanPropertyAssocMany<?>> propertiesAssocMany()

Return BeanPropertyAssocMany for this descriptor.

propertiesVersion

public List<DeployBeanProperty> 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.

propertiesBase

public List<DeployBeanProperty> propertiesBase()

base properties without the unique id properties.