com.avaje.ebeaninternal.server.el

Class ElPropertyChain

java.lang.Object

com.avaje.ebeaninternal.server.el.ElPropertyChain

All Implemented Interfaces:

ElPropertyDeploy, ElPropertyValue

public class ElPropertyChain
extends Object
implements ElPropertyValue

A ElGetValue based on a chain of properties.

Used to get the value for an compound expression like customer.name or customer.shippingAddress.city etc.

Note that if any element in the chain returns null, then null is returned and no further processing of the chain occurs.

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
ElPropertyChain(boolean containsMany, boolean embedded, String expression, ElPropertyValue[] chain)

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() Return true if there is a property on the path that is a many property.
boolean	containsManySince(String sinceProperty) Return true if there is a many property from sinceProperty to the end of this chain.
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	elSetLoaded(Object 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) Return the logical id in expression taking into account embedded id's.
String	getAssocIdInValueExpr(int size) Return the logical id value expression taking into account embedded id's.
String	getAssocOneIdExpr(String prefix, String operator) Return the Id expression string.
Object[]	getAssocOneIdValues(Object bean) Return the Id values for the given bean value.
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	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() Return true if this is an ManyToOne or OneToOne 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 ElPropertyValue.parseDateTime(long).
boolean	isDbEncrypted() Return true if the property is encrypted in the DB.
boolean	isDeployOnly() Full ElGetValue support.
boolean	isLocalEncrypted() Return true if the property is encrypted via Java.
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

ElPropertyChain

public ElPropertyChain(boolean containsMany,
               boolean embedded,
               String expression,
               ElPropertyValue[] chain)

Method Detail

isDeployOnly

public boolean isDeployOnly()

Full ElGetValue support.

containsManySince

public boolean containsManySince(String sinceProperty)

Return true if there is a many property from sinceProperty to the end of this chain.

Specified by:

containsManySince in interface 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()

Description copied from interface: ElPropertyDeploy

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

Specified by:

containsMany 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

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

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

isDbEncrypted

public boolean isDbEncrypted()

Description copied from interface: ElPropertyValue

Return true if the property is encrypted in the DB.

Specified by:

isDbEncrypted in interface ElPropertyValue

isLocalEncrypted

public boolean isLocalEncrypted()

Description copied from interface: ElPropertyValue

Return true if the property is encrypted via Java.

Specified by:

isLocalEncrypted in interface ElPropertyValue

getAssocOneIdValues

public Object[] getAssocOneIdValues(Object bean)

Description copied from interface: ElPropertyValue

Return the Id values for the given bean value.

Specified by:

getAssocOneIdValues in interface ElPropertyValue

getAssocOneIdExpr

public String getAssocOneIdExpr(String prefix,
                       String operator)

Description copied from interface: ElPropertyValue

Return the Id expression string.

Typically used to produce id = ? expression strings.

Specified by:

getAssocOneIdExpr in interface ElPropertyValue

getAssocIdInExpr

public String getAssocIdInExpr(String prefix)

Description copied from interface: ElPropertyValue

Return the logical id in expression taking into account embedded id's.

Specified by:

getAssocIdInExpr in interface ElPropertyValue

getAssocIdInValueExpr

public String getAssocIdInValueExpr(int size)

Description copied from interface: ElPropertyValue

Return the logical id value expression taking into account embedded id's.

Specified by:

getAssocIdInValueExpr in interface ElPropertyValue

getDeployOrder

public int getDeployOrder()

Description copied from interface: ElPropertyValue

Return the deploy order for the property.

Specified by:

getDeployOrder in interface ElPropertyValue

isAssocId

public boolean isAssocId()

Description copied from interface: ElPropertyValue

Return true if this is an ManyToOne or OneToOne associated bean property.

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

getDbColumn

public String getDbColumn()

Description copied from interface: ElPropertyDeploy

Return the deployment db column for this property.

Specified by:

getDbColumn in interface ElPropertyDeploy

getBeanProperty

public BeanProperty getBeanProperty()

Description copied from interface: ElPropertyDeploy

Return the underlying bean property.

Specified by:

getBeanProperty 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

getStringParser

public StringParser getStringParser()

Description copied from interface: ElPropertyValue

Return the default StringParser for the scalar property.

Specified by:

getStringParser 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

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

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

elSetLoaded

public void elSetLoaded(Object bean)

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

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