Module io.ebean.core

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
String	assocIdExpression(String prefix, String operator)	Returns null as not an AssocOne.
String	assocIdInExpr(String prefix)	Returns null as not an AssocOne.
String	assocIdInValueExpr(boolean not, int size)	Returns null as not an AssocOne.
Object[]	assocIdValues(EntityBean value)	Returns null as not an AssocOne.
String	assocIsEmpty(SpiExpressionRequest request, String path)	Return the logical where clause to support "Is empty".
BeanProperty	beanProperty()	Return the underlying bean property.
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)
BeanFkeyProperty	create(String expression, boolean pathContainsMany)
String	dbColumn()	Return the deployment db column for this property.
String	elName()	The ElPrefix plus name.
String	elPlaceholder(boolean encrypted)	Return the place holder in the form of ${elPrefix}dbColumn.
String	elPrefix()	Return the prefix path of the property.
int	fetchPreference()	Return the fetch preference.
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	isDbEncrypted()	Returns false for keys.
boolean	isLocalEncrypted()	Returns false for keys.
int	jdbcType()
Object	localEncrypt(Object value)	Encrypt the input value return the encrypted value.
String	name()	Return the name of the property.
Object	pathGet(Object 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)
Property	property()
StringParser	stringParser()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BeanFkeyProperty

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

Method Details

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

fetchPreference

public int fetchPreference()

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:

fetchPreference 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

dbColumn

public String dbColumn()

Description copied from interface: ElPropertyDeploy

Return the deployment db column for this property.

Specified by:

dbColumn in interface ElPropertyDeploy

name

public String name()

Description copied from interface: ElPropertyDeploy

Return the name of the property.

Specified by:

name in interface ElPropertyDeploy

elName

public String elName()

Description copied from interface: ElPropertyDeploy

The ElPrefix plus name.

Specified by:

elName in interface ElPropertyDeploy

Specified by:

elName in interface ExpressionPath

assocIdValues

public Object[] assocIdValues(EntityBean value)

Returns null as not an AssocOne.

Specified by:

assocIdValues in interface ExpressionPath

assocIdExpression

public String assocIdExpression(String prefix,
 String operator)

Returns null as not an AssocOne.

Specified by:

assocIdExpression in interface ExpressionPath

assocIdInExpr

public String assocIdInExpr(String prefix)

Returns null as not an AssocOne.

Specified by:

assocIdInExpr in interface ElPropertyValue

assocIdInValueExpr

public String assocIdInValueExpr(boolean not,
 int size)

Returns null as not an AssocOne.

Specified by:

assocIdInValueExpr in interface ElPropertyValue

assocIsEmpty

public String assocIsEmpty(SpiExpressionRequest request,
 String path)

Description copied from interface: ElPropertyValue

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

Specified by:

assocIsEmpty 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

elPlaceholder

public String elPlaceholder(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:

elPlaceholder in interface ElPropertyDeploy

elPrefix

public String elPrefix()

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:

elPrefix in interface ElPropertyDeploy

jdbcType

public int jdbcType()

Specified by:

jdbcType in interface ExpressionPath

beanProperty

public BeanProperty beanProperty()

Description copied from interface: ElPropertyDeploy

Return the underlying bean property.

Specified by:

beanProperty in interface ElPropertyDeploy

stringParser

public StringParser stringParser()

Specified by:

stringParser in interface ExpressionPath

convert

public Object convert(Object value)

Specified by:

convert in interface ExpressionPath

pathSet

public void pathSet(Object bean,
 Object value)

Specified by:

pathSet in interface ExpressionPath

pathGet

public Object pathGet(Object 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

property

public Property property()

Specified by:

property in interface ExpressionPath