Module io.ebean.api

Package io.ebean.plugin

Interface ExpressionPath

public interface ExpressionPath

A dot notation expression path.

Method Summary

Modifier and Type	Method	Description
String	assocIdExpression(String propName, String bindOperator)	Return the Id expression string.
Object[]	assocIdValues(EntityBean bean)	Return the Id values for the given bean value.
boolean	containsMany()	Return true if there is a property on the path that is a many property.
Object	convert(Object value)	Convert the value to the expected type.
String	elName()	The ElPrefix plus name.
boolean	isAssocId()	Return true if this is an ManyToOne or OneToOne associated bean property.
boolean	isDateTimeCapable()	Return true if the last type is "DateTime capable" - can support parseDateTime(long).
int	jdbcType()	Return the underlying JDBC type or 0 if this is not a scalar type.
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.
void	pathSet(Object bean, Object value)	Set a value to the bean for this expression path.
Property	property()	Return the underlying bean property.
StringParser	stringParser()	Return the default StringParser for the scalar property.

Method Detail

containsMany

boolean containsMany()

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

pathGet

Object pathGet(Object bean)

Return the value from a given entity bean.

pathSet

void pathSet(Object bean,
             Object value)

Set a value to the bean for this expression path.

Parameters:

bean - the bean to set the value on

value - the value to set

convert

Object convert(Object value)

Convert the value to the expected type.

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

stringParser

StringParser stringParser()

Return the default StringParser for the scalar property.

parseDateTime

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).

isDateTimeCapable

boolean isDateTimeCapable()

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

jdbcType

int jdbcType()

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

isAssocId

boolean isAssocId()

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

assocIdExpression

String assocIdExpression(String propName,
                         String bindOperator)

Return the Id expression string.

Typically used to produce id = ? expression strings.

assocIdValues

Object[] assocIdValues(EntityBean bean)

Return the Id values for the given bean value.

property

Property property()

Return the underlying bean property.

elName

String elName()

The ElPrefix plus name.