io.ebean.plugin

Interface BeanType<T>

public interface BeanType<T>

Information and methods on BeanDescriptors made available to plugins.

Method Summary

Modifier and Type	Method and Description
void	addInheritanceWhere(Query<?> query) Add the discriminator value to the query if needed.
Collection<? extends Property>	allProperties() Return all the properties for this bean type.
Object	beanId(Object bean) Return the bean id.
void	clearBeanCache() Clear the bean cache.
void	clearQueryCache() Clear the query cache.
T	createBean() Create a new instance of the bean.
T	createBeanUsingDisc(Object discValue) Create a bean given the discriminator value.
BeanDocType<T>	docStore() Return the doc store support for this bean type.\
String	getBaseTable() Return the base table this bean type maps to.
Object	getBeanId(T bean) Return the id value for the given bean.
Class<T>	getBeanType() Return the class type this BeanDescriptor describes.
BeanType<?>	getBeanTypeAtPath(String propertyName) Return the type bean for an OneToMany or ManyToOne or ManyToMany property.
String	getDiscColumn() Return the discriminator column.
io.ebeanservice.docstore.api.mapping.DocumentMapping	getDocMapping() Return the DocumentMapping for this bean type.
String	getDocStoreQueueId() Return the doc store queueId for this bean type.
ExpressionPath	getExpressionPath(String path) Return the ExpressionPath for a given property path.
BeanFindController	getFindController() Return the beanFinder.
String	getFullName() Return the full name of the bean type.
Property	getIdProperty() Return the Id property.
io.ebean.config.dbplatform.IdType	getIdType() Return the identity generation type.
List<BeanType<?>>	getInheritanceChildren() Returns all direct children of this beantype
BeanType<?>	getInheritanceParent() Returns the parent in inheritance hiearchy
String	getName() Return the short name of the bean type.
BeanPersistController	getPersistController() Return the bean persist controller.
BeanPersistListener	getPersistListener() Return the bean persist listener.
short	getProfileId() Return the profileId of the bean type.
Property	getProperty(String propertyName) Return the Property to read values from a bean.
BeanQueryAdapter	getQueryAdapter() Return the BeanQueryAdapter or null if none is defined.
String	getSequenceName() Return the sequence name associated to this entity bean type (if there is one).
Property	getWhenCreatedProperty() Return the when created property if there is one defined.
Property	getWhenModifiedProperty() Return the when modified property if there is one defined.
boolean	hasInheritance() Return true if this bean type has an inheritance hierarchy.
boolean	isBeanCaching() Return true if bean caching is on for this bean type.
boolean	isDocStoreMapped() Return true if this bean type has doc store backing.
boolean	isDocStoreOnly() Return true if the type is document store only.
boolean	isInheritanceRoot() Return true if this object is the root level object in its entity inheritance.
boolean	isQueryCaching() Return true if query caching is on for this bean type.
boolean	isValidExpression(String property) Return true if the property is a valid known property or path for the given bean type.
BeanType<?>	root() Return the root bean type for an inheritance hierarchy.
void	setBeanId(T bean, Object idValue) Set the id value to the bean.
void	visitAllInheritanceChildren(java.util.function.Consumer<BeanType<?>> visitor) Visit all children recursively

Method Detail

getName

@Nonnull
String getName()

Return the short name of the bean type.

getProfileId

short getProfileId()

Return the profileId of the bean type.

getFullName

@Nonnull
String getFullName()

Return the full name of the bean type.

getBeanType

@Nonnull
Class<T> getBeanType()

Return the class type this BeanDescriptor describes.

getBeanTypeAtPath

BeanType<?> getBeanTypeAtPath(String propertyName)

Return the type bean for an OneToMany or ManyToOne or ManyToMany property.

allProperties

@Nonnull
Collection<? extends Property> allProperties()

Return all the properties for this bean type.

getIdProperty

Property getIdProperty()

Return the Id property.

getWhenModifiedProperty

Property getWhenModifiedProperty()

Return the when modified property if there is one defined.

getWhenCreatedProperty

Property getWhenCreatedProperty()

Return the when created property if there is one defined.

getProperty

Property getProperty(String propertyName)

Return the Property to read values from a bean.

getExpressionPath

ExpressionPath getExpressionPath(String path)

Return the ExpressionPath for a given property path.

This can return a property or nested property path.

isValidExpression

boolean isValidExpression(String property)

Return true if the property is a valid known property or path for the given bean type.

isBeanCaching

boolean isBeanCaching()

Return true if bean caching is on for this bean type.

isQueryCaching

boolean isQueryCaching()

Return true if query caching is on for this bean type.

clearBeanCache

void clearBeanCache()

Clear the bean cache.

clearQueryCache

void clearQueryCache()

Clear the query cache.

isDocStoreOnly

boolean isDocStoreOnly()

Return true if the type is document store only.

getBaseTable

String getBaseTable()

Return the base table this bean type maps to.

createBean

T createBean()

Create a new instance of the bean.

beanId

Object beanId(Object bean)

Return the bean id. This is the same as getBeanId() but without the generic type.

getBeanId

Object getBeanId(T bean)

Return the id value for the given bean.

setBeanId

void setBeanId(T bean,
               Object idValue)

Set the id value to the bean.

getPersistController

BeanPersistController getPersistController()

Return the bean persist controller.

getPersistListener

BeanPersistListener getPersistListener()

Return the bean persist listener.

getFindController

BeanFindController getFindController()

Return the beanFinder. Usually null unless overriding the finder.

getQueryAdapter

BeanQueryAdapter getQueryAdapter()

Return the BeanQueryAdapter or null if none is defined.

getIdType

io.ebean.config.dbplatform.IdType getIdType()

Return the identity generation type.

getSequenceName

String getSequenceName()

Return the sequence name associated to this entity bean type (if there is one).

isDocStoreMapped

boolean isDocStoreMapped()

Return true if this bean type has doc store backing.

getDocMapping

io.ebeanservice.docstore.api.mapping.DocumentMapping getDocMapping()

Return the DocumentMapping for this bean type.

This is the document structure and mapping options for how this bean type is mapped for the document store.

getDocStoreQueueId

String getDocStoreQueueId()

Return the doc store queueId for this bean type.

docStore

BeanDocType<T> docStore()

Return the doc store support for this bean type.\

addInheritanceWhere

void addInheritanceWhere(Query<?> query)

Add the discriminator value to the query if needed.

root

BeanType<?> root()

Return the root bean type for an inheritance hierarchy.

hasInheritance

boolean hasInheritance()

Return true if this bean type has an inheritance hierarchy.

isInheritanceRoot

boolean isInheritanceRoot()

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

getInheritanceChildren

List<BeanType<?>> getInheritanceChildren()

Returns all direct children of this beantype

getInheritanceParent

BeanType<?> getInheritanceParent()

Returns the parent in inheritance hiearchy

visitAllInheritanceChildren

void visitAllInheritanceChildren(java.util.function.Consumer<BeanType<?>> visitor)

Visit all children recursively

getDiscColumn

String getDiscColumn()

Return the discriminator column.

createBeanUsingDisc

T createBeanUsingDisc(Object discValue)

Create a bean given the discriminator value.