com.avaje.ebeaninternal.server.deploy

Class BeanFkeyProperty

java.lang.Object

com.avaje.ebeaninternal.server.deploy.BeanFkeyProperty

All Implemented Interfaces:

ElPropertyDeploy, ElPropertyValue

public final class BeanFkeyProperty
extends Object
implements ElPropertyValue

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

Property Summary

Properties

Type	Property and Description
boolean	isAssoc Return true if any path of this path contains a Associated One or Many.

Field Summary

Fields inherited from interface com.avaje.ebeaninternal.server.el.ElPropertyDeploy

ROOT_ELPREFIX

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and 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.
BeanFkeyProperty	create(String expression)
Object	elConvertType(Object value) Convert the value to the expected type.
Object	elGetReference(Object bean) Return the value ensuring objects prior to the top scalar property are automatically populated.
Object	elGetValue(Object bean) Return the value from a given entity bean.
void	elSetReference(Object bean) Make the owning bean of this property a reference (as in not new/dirty).
void	elSetValue(Object bean, Object value, boolean populate, boolean reference) Set a value given a root level bean.
String	getAssocIdInExpr(String prefix) Returns null as not an AssocOne.
String	getAssocIdInValueExpr(int size) Returns null as not an AssocOne.
String	getAssocOneIdExpr(String prefix, String operator) Returns null as not an AssocOne.
Object[]	getAssocOneIdValues(Object value) Returns null as not an AssocOne.
BeanProperty	getBeanProperty() Return the underlying bean property.
String	getDbColumn() Return the deployment db column for this property.
int	getDeployOrder() Return the deploy order for the property.
String	getDeployProperty()
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	getJdbcType() Return the underlying JDBC type or 0 if this is not a scalar type.
String	getName() Return the name of the property.
StringFormatter	getStringFormatter() Return the default StringFormatter for the scalar property.
StringParser	getStringParser() Return the default StringParser for the scalar property.
boolean	isAssocId() Returns false as not an AssocOne.
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 ElPropertyValue.parseDateTime(long).
boolean	isDbEncrypted() Returns false for keys.
boolean	isDeployOnly() Only usable as ElPropertyDeploy.
boolean	isLocalEncrypted() Returns false for keys.
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).

Methods inherited from class java.lang.Object

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

Property Detail

isAssoc

Specified by:

isAssocProperty in interface ElPropertyValue

Constructor Detail

BeanFkeyProperty

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

Method Detail

getDeployOrder

public int getDeployOrder()

Description copied from interface: ElPropertyValue

Return the deploy order for the property.

Specified by:

getDeployOrder in interface ElPropertyValue

create

public BeanFkeyProperty create(String expression)

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

isDeployOnly

public boolean isDeployOnly()

Only usable as ElPropertyDeploy.

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

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

getAssocOneIdValues

public Object[] getAssocOneIdValues(Object value)

Returns null as not an AssocOne.

Specified by:

getAssocOneIdValues in interface ElPropertyValue

getAssocOneIdExpr

public String getAssocOneIdExpr(String prefix,
                       String operator)

Returns null as not an AssocOne.

Specified by:

getAssocOneIdExpr in interface ElPropertyValue

getAssocIdInExpr

public String getAssocIdInExpr(String prefix)

Returns null as not an AssocOne.

Specified by:

getAssocIdInExpr in interface ElPropertyValue

getAssocIdInValueExpr

public String getAssocIdInValueExpr(int size)

Returns null as not an AssocOne.

Specified by:

getAssocIdInValueExpr in interface ElPropertyValue

isAssocId

public boolean isAssocId()

Returns false as not an AssocOne.

Specified by:

isAssocId in interface ElPropertyValue

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: ElPropertyValue

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

Specified by:

isDateTimeCapable in interface ElPropertyValue

getJdbcType

public int getJdbcType()

Description copied from interface: ElPropertyValue

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

Specified by:

getJdbcType in interface ElPropertyValue

parseDateTime

public Object parseDateTime(long systemTimeMillis)

Description copied from interface: ElPropertyValue

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 ElPropertyValue

getStringFormatter

public StringFormatter getStringFormatter()

Description copied from interface: ElPropertyValue

Return the default StringFormatter for the scalar property.

Specified by:

getStringFormatter in interface ElPropertyValue

getStringParser

public StringParser getStringParser()

Description copied from interface: ElPropertyValue

Return the default StringParser for the scalar property.

Specified by:

getStringParser in interface ElPropertyValue

elSetReference

public void elSetReference(Object bean)

Description copied from interface: ElPropertyValue

Make the owning bean of this property a reference (as in not new/dirty).

Specified by:

elSetReference in interface ElPropertyValue

elConvertType

public Object elConvertType(Object value)

Description copied from interface: ElPropertyValue

Convert the value to the expected type.

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

Specified by:

elConvertType in interface ElPropertyValue

elSetValue

public void elSetValue(Object bean,
              Object value,
              boolean populate,
              boolean reference)

Description copied from interface: ElPropertyValue

Set a value given a root level bean.

If populate then

Specified by:

elSetValue in interface ElPropertyValue

elGetValue

public Object elGetValue(Object bean)

Description copied from interface: ElPropertyValue

Return the value from a given entity bean.

Specified by:

elGetValue in interface ElPropertyValue

elGetReference

public Object elGetReference(Object bean)

Description copied from interface: ElPropertyValue

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

Specified by:

elGetReference in interface ElPropertyValue

getBeanProperty

public BeanProperty getBeanProperty()

Description copied from interface: ElPropertyDeploy

Return the underlying bean property.

Specified by:

getBeanProperty in interface ElPropertyDeploy

getDeployProperty

public String getDeployProperty()