Package io.ebeaninternal.server.query

Interface STreeType

All Known Implementing Classes:

BeanDescriptor

public interface STreeType

Bean type interface for Sql query tree.

Method Summary

Modifier and Type	Method	Description
Object	contextPutIfAbsent(PersistenceContext persistenceContext, Object id, EntityBean localBean)	Put the entity bean into the persistence context.
EntityBean	createEntityBean()	Create a new entity bean instance.
ExtraJoin	extraJoin(String propertyPath)	Return an extra join if the property path requires it.
STreeProperty	findProperty(String propName)	Find a known property.
STreeProperty	findPropertyFromPath(String property)	Return the bean property traversing the object graph and taking into account inheritance.
STreeProperty	findPropertyWithDynamic(String baseName, String path)	Find and return property allowing for dynamic formula properties.
String	getBaseTable(SpiQuery.TemporalMode temporalMode)	Return the base table to use given the temporalMode.
IdBinder	getIdBinder()	Return the IdBinder for this type.
InheritInfo	getInheritInfo()	Return the inheritance information for this type.
String	getName()	Return the bean short name.
String	getSoftDeletePredicate(String baseTableAlias)	Return the soft delete predicate using the given table alias.
boolean	hasId()	Return true if the underlying type has an Id property.
void	inheritanceLoad(SqlBeanLoad sqlBeanLoad, STreeProperty property, DbReadContext ctx)	Load the property taking into account inheritance.
boolean	isEmbeddedPath(String propertyPath)	Return true if the given path is an embedded bean.
boolean	isHistorySupport()	Return true if the type uses history.
boolean	isRawSqlBased()	Return true if the type is RawSql based.
boolean	isSoftDelete()	Return true if the type uses soft delete.
void	markAsDeleted(EntityBean bean)	Mark the bean as deleted by setting the softDelete property to true.
void	postLoad(Object localBean)	Invoke any post load listeners.
STreeProperty[]	propsBaseScalar()	Return the scalar properties.
STreePropertyAssoc[]	propsEmbedded()	Return the embedded bean properties.
STreePropertyAssocMany[]	propsMany()	Return the associated many properties.
STreePropertyAssocOne[]	propsOne()	Return the associated one properties.
void	setDraft(EntityBean localBean)	Set draft status on the entity bean.

Method Detail

getName

String getName()

Return the bean short name.

hasId

boolean hasId()

Return true if the underlying type has an Id property.

isSoftDelete

boolean isSoftDelete()

Return true if the type uses soft delete.

isHistorySupport

boolean isHistorySupport()

Return true if the type uses history.

isRawSqlBased

boolean isRawSqlBased()

Return true if the type is RawSql based.

getSoftDeletePredicate

String getSoftDeletePredicate(String baseTableAlias)

Return the soft delete predicate using the given table alias.

propsBaseScalar

STreeProperty[] propsBaseScalar()

Return the scalar properties.

propsEmbedded

STreePropertyAssoc[] propsEmbedded()

Return the embedded bean properties.

propsOne

STreePropertyAssocOne[] propsOne()

Return the associated one properties.

propsMany

STreePropertyAssocMany[] propsMany()

Return the associated many properties.

getInheritInfo

InheritInfo getInheritInfo()

Return the inheritance information for this type.

getIdBinder

IdBinder getIdBinder()

Return the IdBinder for this type.

createEntityBean

EntityBean createEntityBean()

Create a new entity bean instance.

contextPutIfAbsent

Object contextPutIfAbsent(PersistenceContext persistenceContext,
                          Object id,
                          EntityBean localBean)

Put the entity bean into the persistence context.

setDraft

void setDraft(EntityBean localBean)

Set draft status on the entity bean.

postLoad

void postLoad(Object localBean)

Invoke any post load listeners.

getBaseTable

String getBaseTable(SpiQuery.TemporalMode temporalMode)

Return the base table to use given the temporalMode.

isEmbeddedPath

boolean isEmbeddedPath(String propertyPath)

Return true if the given path is an embedded bean.

findPropertyFromPath

STreeProperty findPropertyFromPath(String property)

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

findProperty

STreeProperty findProperty(String propName)

Find a known property.

findPropertyWithDynamic

STreeProperty findPropertyWithDynamic(String baseName,
                                      String path)

Find and return property allowing for dynamic formula properties.

extraJoin

ExtraJoin extraJoin(String propertyPath)

Return an extra join if the property path requires it.

inheritanceLoad

void inheritanceLoad(SqlBeanLoad sqlBeanLoad,
                     STreeProperty property,
                     DbReadContext ctx)

Load the property taking into account inheritance.

markAsDeleted

void markAsDeleted(EntityBean bean)

Mark the bean as deleted by setting the softDelete property to true. This works also, if there is only a virtual softDelete property computed by a formula. If there is no softdelete property, it sets the lazyLoadFailure flag in EBI.