com.googlecode.genericdao.search
Class Field

java.lang.Object
  com.googlecode.genericdao.search.Field

All Implemented Interfaces:

Serializable

public class Field
extends Object
implements Serializable

Used to specify field selection in Search.

See Also:

Search, Serialized Form

Field Summary

protected String	key The key to use for the property when using result mode RESULT_MAP.
static int	OP_AVG Possible value for operator.
static int	OP_COUNT Possible value for operator.
static int	OP_COUNT_DISTINCT Possible value for operator.
static int	OP_CUSTOM Possible value for operator.
static int	OP_MAX Possible value for operator.
static int	OP_MIN Possible value for operator.
static int	OP_PROPERTY Possible value for operator.
static int	OP_SUM Possible value for operator.
protected int	operator The operator to apply to the column: for example OP_COUNT, OP_SUM, OP_MAX.
protected String	property The property to include in the result.
static String	ROOT_ENTITY Property string representing the root entity of the search.

Constructor Summary

Field()

Field(String property)

Field(String property, int operator)

Field(String property, int operator, String key)

Field(String property, String key)

Method Summary

boolean	equals(Object obj)
String	getKey()
int	getOperator()
String	getProperty()
int	hashCode()
void	setKey(String key)
void	setOperator(int operator)
void	setProperty(String property)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ROOT_ENTITY

public static final String ROOT_ENTITY

Property string representing the root entity of the search. This is just the empty string ("").

See Also:

Constant Field Values

property

protected String property

The property to include in the result.

key

protected String key

The key to use for the property when using result mode RESULT_MAP.

operator

protected int operator

The operator to apply to the column: for example OP_COUNT, OP_SUM, OP_MAX. The default is OP_PROPERTY.

OP_PROPERTY

public static final int OP_PROPERTY

Possible value for operator. This is the default value and does not apply any operator to the column. All the rows in the result set are returned.

See Also:

Constant Field Values

OP_COUNT

public static final int OP_COUNT

Possible value for operator. This returns the number of rows in the result set where the given property is non-null.

See Also:

Constant Field Values

OP_COUNT_DISTINCT

public static final int OP_COUNT_DISTINCT

Possible value for operator. This returns the number of distinct values of the given property in the result set.

See Also:

Constant Field Values

OP_MAX

public static final int OP_MAX

Possible value for operator. This returns the maximum value of the given property in the result set.

See Also:

Constant Field Values

OP_MIN

public static final int OP_MIN

Possible value for operator. This returns the minimum value of the given property in the result set.

See Also:

Constant Field Values

OP_SUM

public static final int OP_SUM

Possible value for operator. This returns the sum of the given property in all rows of the result set.

See Also:

Constant Field Values

OP_AVG

public static final int OP_AVG

Possible value for operator. This returns the average value of the given property in the result set.

See Also:

Constant Field Values

OP_CUSTOM

public static final int OP_CUSTOM

Possible value for operator. This allows a free-form JPQL/HQL select-clause expression. When using this operator, the expression is set in the "property" property of the Field. Reference properties by wrapping them with curly braces ({}).

Here are some examples:

 new Field("{firstName}||' '||{initial}||' '||upper({lastName})", Field.OP_CUSTOM);
 new Field("max(({top} - {bottom}) / 2)", Field.OP_CUSTOM);
 

See Also:

Constant Field Values

Constructor Detail

Field

public Field()

Field

public Field(String property)

Field

public Field(String property,
             String key)

Field

public Field(String property,
             int operator)

Field

public Field(String property,
             int operator,
             String key)

Method Detail

getProperty

public String getProperty()

setProperty

public void setProperty(String property)

getKey

public String getKey()

setKey

public void setKey(String key)

getOperator

public int getOperator()

setOperator

public void setOperator(int operator)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object