Module io.ebean.core

Package io.ebeaninternal.server.deploy

Class BeanDescriptorManager

java.lang.Object

io.ebeaninternal.server.deploy.BeanDescriptorManager

All Implemented Interfaces:

SpiBeanTypeManager, BeanDescriptorMap

public final class BeanDescriptorManager
extends Object
implements BeanDescriptorMap, SpiBeanTypeManager

Creates BeanDescriptors.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JAVA_LANG_RECORD

Constructor Summary

Constructors

Constructor	Description
BeanDescriptorManager(InternalConfiguration config)	Create for a given database dbConfig.

Method Summary

Modifier and Type	Method	Description
<T> BeanManager<T>	beanManager(Class<T> entityType)
BeanTable	beanTable(Class<?> type)
SpiBeanType	beanType(Class<?> entityType)	Return the bean type for the given entity class.
List<? extends BeanType<?>>	beanTypes(String tableName)	Return the BeanDescriptors mapped to the table.
BindMaxLength	bindMaxLength()
SpiCacheManager	cacheManager()	Return the Cache Manager.
void	cacheNotify(TransactionEventTable.TableIUD tableIUD, CacheChangeSet changeSet)	For SQL based modifications we need to invalidate appropriate parts of the cache.
ChangeLogListener	changeLogListener()	Return the changeLogListener (that actually does the logging).
ChangeLogPrepare	changeLogPrepare()	Return the changeLogPrepare (for setting user context into the ChangeSet in the foreground thread).
DatabaseBuilder.Settings	config()	Return the DatabaseConfig.
BeanTable	createCollectionBeanTable(String fullTableName, Class<?> targetType)	Return a BeanTable for an ElementCollection.
<A> DeployBeanDescriptor<A>	createDeployDescriptor(Class<A> targetType)	Create a DeployBeanDescriptor for an ElementCollection target.
<A> BeanDescriptor<A>	createElementDescriptor(DeployBeanDescriptor<A> elementDescriptor, ManyType manyType, boolean scalar)	Create a BeanDescriptor for an ElementCollection target.
IdBinder	createIdBinder(BeanProperty idProperty)	Create a IdBinder for this bean property.
<A> void	createUnidirectional(DeployBeanDescriptor<?> targetDesc, Class<A> targetType, BeanTable beanTable, DeployTableJoin oneToManyJoin)	Create and add a Unidirectional property (for ElementCollection) which maps to the foreign key.
Map<String,String>	deploy()	Deploy returning the asOfTableMap (which is required by the SQL builders).
<T> io.ebeaninternal.server.deploy.parse.DeployBeanInfo<T>	deploy(Class<T> cls)	Return the bean deploy info for the given class.
<T> BeanDescriptor<T>	descriptor(Class<T> entityType)	Return the BeanDescriptor for a given class.
<T> BeanDescriptor<T>	descriptorByClassName(String entityClassName)
List<BeanDescriptor<?>>	descriptorList()	Return an immutable list of all the BeanDescriptors.
List<BeanDescriptor<?>>	descriptors(String tableName)	Return the BeanDescriptors mapped to the table.
EncryptKey	encryptKey(String tableName, String columnName)	Return the Encrypt key given the table and column name.
boolean	isJacksonCorePresent()	Return true if Jackson core is present on the classpath.
boolean	isMultiValueSupported()	Return true if multiple values can be bound as Array or Table Value and hence share the same query plan.
boolean	isTableManaged(String tableName)	Returns true, if the given table (or view) is managed by ebean (= an entity exists)
String	name()	Return the name of the server/database.
NamingConvention	namingConvention()	Return the naming convention.
void	processViewInvalidation(Set<String> viewInvalidation)	Invalidate entity beans based on views via their dependent tables.
List<MetaQueryPlan>	queryPlanInit(QueryPlanInit request)
boolean	requiresViewEntityCacheInvalidation()	Return true if there are 'view based entities' using l2 query caching and so need to be invalidated based on changes to dependent tables.
ScalarType<?>	scalarType(int jdbcType)	Return the scalarType for the given JDBC type.
ScalarType<?>	scalarType(String cast)	Return the scalarType for the given logical type.
void	scheduleBackgroundTrim()	Run periodic trim of query plans.
void	setEbeanServer(SpiEbeanServer internalEbean)	Set the internal EbeanServer instance to all BeanDescriptors.
void	visitMetrics(MetricVisitor visitor)

Methods inherited from class java.lang.Object

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

Field Details

JAVA_LANG_RECORD

public static final String JAVA_LANG_RECORD

See Also:

• Constant Field Values

Constructor Details

BeanDescriptorManager

public BeanDescriptorManager(InternalConfiguration config)

Create for a given database dbConfig.

Method Details

isJacksonCorePresent

public boolean isJacksonCorePresent()

Description copied from interface: BeanDescriptorMap

Return true if Jackson core is present on the classpath.

Specified by:

isJacksonCorePresent in interface BeanDescriptorMap

scheduleBackgroundTrim

public void scheduleBackgroundTrim()

Run periodic trim of query plans.

scalarType

public ScalarType<?> scalarType(String cast)

Description copied from interface: BeanDescriptorMap

Return the scalarType for the given logical type.

Specified by:

scalarType in interface BeanDescriptorMap

scalarType

public ScalarType<?> scalarType(int jdbcType)

Description copied from interface: BeanDescriptorMap

Return the scalarType for the given JDBC type.

Specified by:

scalarType in interface BeanDescriptorMap

isMultiValueSupported

public boolean isMultiValueSupported()

Description copied from interface: BeanDescriptorMap

Return true if multiple values can be bound as Array or Table Value and hence share the same query plan.

Specified by:

isMultiValueSupported in interface BeanDescriptorMap

config

public DatabaseBuilder.Settings config()

Description copied from interface: BeanDescriptorMap

Return the DatabaseConfig.

Specified by:

config in interface BeanDescriptorMap

beanType

public SpiBeanType beanType(Class<?> entityType)

Description copied from interface: SpiBeanTypeManager

Return the bean type for the given entity class.

Specified by:

beanType in interface SpiBeanTypeManager

descriptor

public <T> BeanDescriptor<T> descriptor(Class<T> entityType)

Description copied from interface: BeanDescriptorMap

Return the BeanDescriptor for a given class.

Specified by:

descriptor in interface BeanDescriptorMap

descriptorByClassName

public <T> BeanDescriptor<T> descriptorByClassName(String entityClassName)

name

public String name()

Description copied from interface: BeanDescriptorMap

Return the name of the server/database.

Specified by:

name in interface BeanDescriptorMap

cacheManager

public SpiCacheManager cacheManager()

Description copied from interface: BeanDescriptorMap

Return the Cache Manager.

Specified by:

cacheManager in interface BeanDescriptorMap

namingConvention

public NamingConvention namingConvention()

Description copied from interface: BeanDescriptorMap

Return the naming convention.

Specified by:

namingConvention in interface BeanDescriptorMap

setEbeanServer

public void setEbeanServer(SpiEbeanServer internalEbean)

Set the internal EbeanServer instance to all BeanDescriptors.

createIdBinder

public IdBinder createIdBinder(BeanProperty idProperty)

Description copied from interface: BeanDescriptorMap

Create a IdBinder for this bean property.

Specified by:

createIdBinder in interface BeanDescriptorMap

deploy

public Map<String,String> deploy()

Deploy returning the asOfTableMap (which is required by the SQL builders).

encryptKey

public EncryptKey encryptKey(String tableName,
 String columnName)

Return the Encrypt key given the table and column name.

Specified by:

encryptKey in interface BeanDescriptorMap

cacheNotify

public void cacheNotify(TransactionEventTable.TableIUD tableIUD,
 CacheChangeSet changeSet)

For SQL based modifications we need to invalidate appropriate parts of the cache.

descriptors

public List<BeanDescriptor<?>> descriptors(String tableName)

Return the BeanDescriptors mapped to the table.

beanTypes

public List<? extends BeanType<?>> beanTypes(String tableName)

Return the BeanDescriptors mapped to the table.

isTableManaged

public boolean isTableManaged(String tableName)

Description copied from interface: BeanDescriptorMap

Returns true, if the given table (or view) is managed by ebean (= an entity exists)

Specified by:

isTableManaged in interface BeanDescriptorMap

processViewInvalidation

public void processViewInvalidation(Set<String> viewInvalidation)

Invalidate entity beans based on views via their dependent tables.

requiresViewEntityCacheInvalidation

public boolean requiresViewEntityCacheInvalidation()

Return true if there are 'view based entities' using l2 query caching and so need to be invalidated based on changes to dependent tables.

descriptorList

public List<BeanDescriptor<?>> descriptorList()

Return an immutable list of all the BeanDescriptors.

beanTable

public BeanTable beanTable(Class<?> type)

createCollectionBeanTable

public BeanTable createCollectionBeanTable(String fullTableName,
 Class<?> targetType)

Return a BeanTable for an ElementCollection.

beanManager

public <T> BeanManager<T> beanManager(Class<T> entityType)

deploy

public <T>
io.ebeaninternal.server.deploy.parse.DeployBeanInfo<T> deploy(Class<T> cls)

Return the bean deploy info for the given class.

createUnidirectional

public <A> void createUnidirectional(DeployBeanDescriptor<?> targetDesc,
 Class<A> targetType,
 BeanTable beanTable,
 DeployTableJoin oneToManyJoin)

Create and add a Unidirectional property (for ElementCollection) which maps to the foreign key.

changeLogPrepare

public ChangeLogPrepare changeLogPrepare()

Return the changeLogPrepare (for setting user context into the ChangeSet in the foreground thread).

changeLogListener

public ChangeLogListener changeLogListener()

Return the changeLogListener (that actually does the logging).

createDeployDescriptor

public <A> DeployBeanDescriptor<A> createDeployDescriptor(Class<A> targetType)

Create a DeployBeanDescriptor for an ElementCollection target.

createElementDescriptor

public <A> BeanDescriptor<A> createElementDescriptor(DeployBeanDescriptor<A> elementDescriptor,
 ManyType manyType,
 boolean scalar)

Create a BeanDescriptor for an ElementCollection target.

visitMetrics

public void visitMetrics(MetricVisitor visitor)

queryPlanInit

public List<MetaQueryPlan> queryPlanInit(QueryPlanInit request)

bindMaxLength

public BindMaxLength bindMaxLength()