Package io.ebeaninternal.server.query

Interface STreeProperty

All Superinterfaces:

ScalarDataReader<Object>

All Known Subinterfaces:

STreePropertyAssoc, STreePropertyAssocMany, STreePropertyAssocOne

All Known Implementing Classes:

BeanProperty, BeanPropertyAssoc, BeanPropertyAssocMany, BeanPropertyAssocOne, BeanPropertyIdClass, BeanPropertyOrderColumn, BeanPropertySimpleCollection, DynamicPropertyAggregationFormulaMTO

public interface STreeProperty
extends ScalarDataReader<Object>

A property in the SQL Tree.

A BeanProperty or a dynamically created property based on formula.

Method Summary

Modifier and Type	Method	Description
void	appendFrom(DbSqlContext ctx, SqlJoinType joinType)	Append to the from clause.
void	appendSelect(DbSqlContext ctx, boolean subQuery)	Append to the select clause.
void	buildRawSqlSelectChain(String prefix, List<String> selectChain)	For RawSql build the select chain.
String	getElPrefix()	Return the Expression language prefix (join path).
String	getEncryptKeyAsString()	Return the encryption key as a string value (when the property is encrypted).
String	getFullBeanName()	Return the full property name (for error messages).
String	getName()	Return the property name.
ScalarType<?>	getScalarType()	Return the underlying scalar type for the property (for findSingleAttribute).
boolean	isAggregation()	Return true if the property is an aggregation.
default boolean	isAggregationManyToOne()	Return true if the property is an aggregation on a ManyToOne.
boolean	isEmbedded()	Return true if the property is an embedded type.
boolean	isFormula()	Return true if the property is a formula.
boolean	isId()	Return true if the property is the Id.
void	load(SqlBeanLoad sqlBeanLoad)	Load into the bean (from the DataReader/ResultSet).
void	loadIgnore(DbReadContext ctx)	Ignore the property (moving the column index position without reading).

Methods inherited from interface io.ebeaninternal.server.type.ScalarDataReader

read

Method Detail

getName

String getName()

Return the property name.

getFullBeanName

String getFullBeanName()

Return the full property name (for error messages).

isId

boolean isId()

Return true if the property is the Id.

isEmbedded

boolean isEmbedded()

Return true if the property is an embedded type.

isAggregation

boolean isAggregation()

Return true if the property is an aggregation.

isAggregationManyToOne

default boolean isAggregationManyToOne()

Return true if the property is an aggregation on a ManyToOne.

isFormula

boolean isFormula()

Return true if the property is a formula.

getEncryptKeyAsString

String getEncryptKeyAsString()

Return the encryption key as a string value (when the property is encrypted).

getElPrefix

String getElPrefix()

Return the Expression language prefix (join path).

getScalarType

ScalarType<?> getScalarType()

Return the underlying scalar type for the property (for findSingleAttribute).

buildRawSqlSelectChain

void buildRawSqlSelectChain(String prefix,
                            List<String> selectChain)

For RawSql build the select chain.

load

void load(SqlBeanLoad sqlBeanLoad)

Load into the bean (from the DataReader/ResultSet).

loadIgnore

void loadIgnore(DbReadContext ctx)

Ignore the property (moving the column index position without reading).

appendSelect

void appendSelect(DbSqlContext ctx,
                  boolean subQuery)

Append to the select clause.

appendFrom

void appendFrom(DbSqlContext ctx,
                SqlJoinType joinType)

Append to the from clause.