Package io.ebeaninternal.server.deploy

Class BeanFkeyProperty

java.lang.Object

io.ebeaninternal.server.deploy.BeanFkeyProperty

All Implemented Interfaces:

ExpressionPath, ElPropertyDeploy, ElPropertyValue

public final class BeanFkeyProperty
extends Object
implements ElPropertyValue

Used to evaluate imported foreign keys so as to avoid unnecessary joins.

Field Summary

Fields inherited from interface io.ebeaninternal.server.el.ElPropertyDeploy

ROOT_ELPREFIX

Constructor Summary

Constructors

Constructor	Description
BeanFkeyProperty(String name, String dbColumn, int deployOrder)

Method Summary

Modifier and Type	Method	Description
boolean	containsFormulaWithJoin()	Return true if the property is a formula with a join clause.
boolean	containsMany()	Returns false.
boolean	containsManySince(String sinceProperty)	Return true if there is a property is on the path after sinceProperty that is a 'many' property.
Object	convert(Object value)	Convert the value to the expected type.
BeanFkeyProperty	create(String expression, boolean pathContainsMany)
String	getAssocIdExpression(String prefix, String operator)	Returns null as not an AssocOne.
String	getAssocIdInExpr(String prefix)	Returns null as not an AssocOne.
String	getAssocIdInValueExpr(boolean not, int size)	Returns null as not an AssocOne.
Object[]	getAssocIdValues(EntityBean value)	Returns null as not an AssocOne.
String	getAssocIsEmpty(SpiExpressionRequest request, String path)	Return the logical where clause to support "Is empty".
BeanProperty	getBeanProperty()	Return the underlying bean property.
String	getDbColumn()	Return the deployment db column for this property.
String	getElName()	The ElPrefix plus name.
String	getElPlaceholder(boolean encrypted)	Return the place holder in the form of ${elPrefix}dbColumn.
String	getElPrefix()	Return the prefix path of the property.
int	getFetchPreference()	Return the fetch preference.
int	getJdbcType()	Return the underlying JDBC type or 0 if this is not a scalar type.
String	getName()	Return the name of the property.
Property	getProperty()	Return the underlying bean property.
StringParser	getStringParser()	Return the default StringParser for the scalar property.
boolean	isAggregation()	Return true if this is an aggregation property.
boolean	isAssocId()	Returns false as not an AssocOne.
boolean	isAssocMany()	Return true if the property is a OneToMany or ManyToMany associated bean property.
boolean	isAssocProperty()	Return true if any path of this path contains a Associated One or Many.
boolean	isDateTimeCapable()	Return true if the last type is "DateTime capable" - can support ExpressionPath.parseDateTime(long).
boolean	isDbEncrypted()	Returns false for keys.
boolean	isLocalEncrypted()	Returns false for keys.
Object	localEncrypt(Object value)	Encrypt the input value return the encrypted value.
Object	parseDateTime(long systemTimeMillis)	For DateTime capable scalar types convert the long systemTimeMillis into an appropriate java time (Date,Timestamp,Time,Calendar, JODA type etc).
Object	pathGet(Object bean)	Return the value from a given entity bean.
Object	pathGetNested(Object bean)	Return the value ensuring objects prior to the top scalar property are automatically populated.
void	pathSet(Object bean, Object value)	Set a value to the bean for this expression path.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BeanFkeyProperty

public BeanFkeyProperty(String name,
                        String dbColumn,
                        int deployOrder)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

isAggregation

public boolean isAggregation()

Description copied from interface: ElPropertyDeploy

Return true if this is an aggregation property.

Specified by:

isAggregation in interface ElPropertyDeploy

getFetchPreference

public int getFetchPreference()

Description copied from interface: ElPropertyDeploy

Return the fetch preference. This can be used to control which ToMany relationship is left as a 'join' and which get converted to query join.

Specified by:

getFetchPreference in interface ElPropertyDeploy

create

public BeanFkeyProperty create(String expression,
                               boolean pathContainsMany)

isDbEncrypted

public boolean isDbEncrypted()

Returns false for keys.

Specified by:

isDbEncrypted in interface ElPropertyValue

isLocalEncrypted

public boolean isLocalEncrypted()

Returns false for keys.

Specified by:

isLocalEncrypted in interface ElPropertyValue

localEncrypt

public Object localEncrypt(Object value)

Description copied from interface: ElPropertyValue

Encrypt the input value return the encrypted value.

Specified by:

localEncrypt in interface ElPropertyValue

containsFormulaWithJoin

public boolean containsFormulaWithJoin()

Description copied from interface: ElPropertyDeploy

Return true if the property is a formula with a join clause.

Specified by:

containsFormulaWithJoin in interface ElPropertyDeploy

containsMany

public boolean containsMany()

Returns false.

Specified by:

containsMany in interface ElPropertyDeploy

Specified by:

containsMany in interface ExpressionPath

containsManySince

public boolean containsManySince(String sinceProperty)

Description copied from interface: ElPropertyDeploy

Return true if there is a property is on the path after sinceProperty that is a 'many' property.

Specified by:

containsManySince in interface ElPropertyDeploy

getDbColumn

public String getDbColumn()

Description copied from interface: ElPropertyDeploy

Return the deployment db column for this property.

Specified by:

getDbColumn in interface ElPropertyDeploy

getName

public String getName()

Description copied from interface: ElPropertyDeploy

Return the name of the property.

Specified by:

getName in interface ElPropertyDeploy

getElName

public String getElName()

Description copied from interface: ElPropertyDeploy

The ElPrefix plus name.

Specified by:

getElName in interface ElPropertyDeploy

Specified by:

getElName in interface ExpressionPath

getAssocIdValues

public Object[] getAssocIdValues(EntityBean value)

Returns null as not an AssocOne.

Specified by:

getAssocIdValues in interface ExpressionPath

getAssocIdExpression

public String getAssocIdExpression(String prefix,
                                   String operator)

Returns null as not an AssocOne.

Specified by:

getAssocIdExpression in interface ExpressionPath

getAssocIdInExpr

public String getAssocIdInExpr(String prefix)

Returns null as not an AssocOne.

Specified by:

getAssocIdInExpr in interface ElPropertyValue

getAssocIdInValueExpr

public String getAssocIdInValueExpr(boolean not,
                                    int size)

Returns null as not an AssocOne.

Specified by:

getAssocIdInValueExpr in interface ElPropertyValue

getAssocIsEmpty

public String getAssocIsEmpty(SpiExpressionRequest request,
                              String path)

Description copied from interface: ElPropertyValue

Return the logical where clause to support "Is empty".

Specified by:

getAssocIsEmpty in interface ElPropertyValue

isAssocMany

public boolean isAssocMany()

Description copied from interface: ElPropertyValue

Return true if the property is a OneToMany or ManyToMany associated bean property.

Specified by:

isAssocMany in interface ElPropertyValue

isAssocId

public boolean isAssocId()

Returns false as not an AssocOne.

Specified by:

isAssocId in interface ElPropertyValue

Specified by:

isAssocId in interface ExpressionPath

isAssocProperty

public boolean isAssocProperty()

Description copied from interface: ElPropertyValue

Return true if any path of this path contains a Associated One or Many.

Specified by:

isAssocProperty in interface ElPropertyValue

getElPlaceholder

public String getElPlaceholder(boolean encrypted)

Description copied from interface: ElPropertyDeploy

Return the place holder in the form of ${elPrefix}dbColumn.

The ${elPrefix} is replaced by the appropriate table alias.

Specified by:

getElPlaceholder in interface ElPropertyDeploy

getElPrefix

public String getElPrefix()

Description copied from interface: ElPropertyDeploy

Return the prefix path of the property.

This is use to determine joins required to support this property.

Specified by:

getElPrefix in interface ElPropertyDeploy

isDateTimeCapable

public boolean isDateTimeCapable()

Description copied from interface: ExpressionPath

Return true if the last type is "DateTime capable" - can support ExpressionPath.parseDateTime(long).

Specified by:

isDateTimeCapable in interface ExpressionPath

getJdbcType

public int getJdbcType()

Description copied from interface: ExpressionPath

Return the underlying JDBC type or 0 if this is not a scalar type.

Specified by:

getJdbcType in interface ExpressionPath

getBeanProperty

public BeanProperty getBeanProperty()

Description copied from interface: ElPropertyDeploy

Return the underlying bean property.

Specified by:

getBeanProperty in interface ElPropertyDeploy

parseDateTime

public Object parseDateTime(long systemTimeMillis)

Description copied from interface: ExpressionPath

For DateTime capable scalar types convert the long systemTimeMillis into an appropriate java time (Date,Timestamp,Time,Calendar, JODA type etc).

Specified by:

parseDateTime in interface ExpressionPath

getStringParser

public StringParser getStringParser()

Description copied from interface: ExpressionPath

Return the default StringParser for the scalar property.

Specified by:

getStringParser in interface ExpressionPath

convert

public Object convert(Object value)

Description copied from interface: ExpressionPath

Convert the value to the expected type.

Typically useful for converting strings to the appropriate number type etc.

Specified by:

convert in interface ExpressionPath

pathSet

public void pathSet(Object bean,
                    Object value)

Description copied from interface: ExpressionPath

Set a value to the bean for this expression path.

Specified by:

pathSet in interface ExpressionPath

Parameters:

bean - the bean to set the value on

value - the value to set

pathGet

public Object pathGet(Object bean)

Description copied from interface: ExpressionPath

Return the value from a given entity bean.

Specified by:

pathGet in interface ExpressionPath

pathGetNested

public Object pathGetNested(Object bean)

Description copied from interface: ElPropertyValue

Return the value ensuring objects prior to the top scalar property are automatically populated.

Specified by:

pathGetNested in interface ElPropertyValue

getProperty

public Property getProperty()

Description copied from interface: ExpressionPath

Return the underlying bean property.

Specified by:

getProperty in interface ExpressionPath