kodo.jdbc.query
Interface FilterValue

public interface FilterValue

The simplified public view of any non-operator in a query filter, including constants, variables, and object fields.

Method Summary

void	appendTo(SQLBuffer buf) Append the first SQL element for this value to the given buffer.
void	appendTo(SQLBuffer buf, int index) Append the indexth SQL element for this value to the given buffer.
ClassMapping	getClassMapping() If this is a path to a persistent object, return its class mapping, else return null.
String	getColumnAlias(Column col) Return the alias to use for the given column (this includes the table alias prefix, if any).
String	getColumnAlias(String col, Table table) Return the alias to use for the given column (this includes the table alias prefix, if any).
Object	getDataStoreValue(Object val) Transform the given value into its datastore equivalent.
FieldMapping	getFieldMapping() If this is a path to a persistent field, return its mapping, else return null.
Object	getSQLValue() If this is a constant, returns its value as it would be represented in the database in this context, else return null.
Class	getType() Return the expected type of this value.
Object	getValue() If this is a constant, return its value, else return null.
boolean	isConstant() Return true if this value represents a constant, such as a literal or parameter.
boolean	isPath() Return true if this value represents a persistent field traversal, such as 'this', 'address.street', or 'projectVariable.title'.
int	length() Return the number of SQL elements in this value.

Method Detail

getType

public Class getType()

Return the expected type of this value.

length

public int length()

Return the number of SQL elements in this value. Usually 1.

appendTo

public void appendTo(SQLBuffer buf)

Append the first SQL element for this value to the given buffer.

appendTo

public void appendTo(SQLBuffer buf,
                     int index)

Append the indexth SQL element for this value to the given buffer.

getColumnAlias

public String getColumnAlias(Column col)

Return the alias to use for the given column (this includes the table alias prefix, if any).

getColumnAlias

public String getColumnAlias(String col,
                             Table table)

Return the alias to use for the given column (this includes the table alias prefix, if any).

getDataStoreValue

public Object getDataStoreValue(Object val)

Transform the given value into its datastore equivalent.

isConstant

public boolean isConstant()

Return true if this value represents a constant, such as a literal or parameter.

getValue

public Object getValue()

If this is a constant, return its value, else return null.

getSQLValue

public Object getSQLValue()

If this is a constant, returns its value as it would be represented in the database in this context, else return null.

isPath

public boolean isPath()

Return true if this value represents a persistent field traversal, such as 'this', 'address.street', or 'projectVariable.title'.

getClassMapping

public ClassMapping getClassMapping()

If this is a path to a persistent object, return its class mapping, else return null.

getFieldMapping

public FieldMapping getFieldMapping()

If this is a path to a persistent field, return its mapping, else return null.