Package com.cmobilecom.af.model.property

Class QueryInfo<T extends PersistenceEntity>

java.lang.Object

com.cmobilecom.af.model.property.QueryInfo<T>

Type Parameters:

T - entity type, a subclass of PersistenceEntity

All Implemented Interfaces:

java.io.Serializable

public class QueryInfo<T extends PersistenceEntity>
extends java.lang.Object
implements java.io.Serializable

QueryInfo is the description of an EntityProperty for query view.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
QueryInfo(CriteriaFunction.Function matchType, boolean groupByProperty, boolean orderByProperty)	Constructor.

Method Summary

Modifier and Type	Method	Description
CriteriaFunction.Function	getMatchType()	Get the match type that is used to build query criterion.
I18NName	getSearchOptionPropertyVisibleName()	Get property visible name in search options that may be different from that in query view.
boolean	isGroupByProperty()	Whether the property is a query group-by property?
boolean	isOrderByProperty()	Whether the property is a query order-by property?
void	setGroupByProperty(boolean groupByProperty)	Set whether the property is a query group-by property.
void	setMatchType(CriteriaFunction.Function matchType)	Set the match type that is used to build query criterion.
void	setOrderByProperty(boolean orderByProperty)	Set whether the property is a query order-by property.
void	setSearchOptionPropertyVisibleName(I18NName searchOptionPropertyVisibleName)	Set property visible name in search options that may be different from that in query view.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryInfo

public QueryInfo(CriteriaFunction.Function matchType,
                 boolean groupByProperty,
                 boolean orderByProperty)

Constructor. In a query form, a property can be selected as group-by and/or order-by property in search options.

Parameters:

matchType - comparison type such as equal, less than.

groupByProperty - whether the property can be a group-by property

orderByProperty - whether the property can be an order-by property extraCriterion of a QueryCriteria instance.

Method Detail

getMatchType

public CriteriaFunction.Function getMatchType()

Get the match type that is used to build query criterion. For example, less than, is null, etc.

Returns:

query match type

setMatchType

public void setMatchType(CriteriaFunction.Function matchType)

Set the match type that is used to build query criterion. For example, less than, is null, etc.

Parameters:

matchType - query match type

isGroupByProperty

public boolean isGroupByProperty()

Whether the property is a query group-by property?

Returns:

true if it is a group-by property

setGroupByProperty

public void setGroupByProperty(boolean groupByProperty)

Set whether the property is a query group-by property.

Parameters:

groupByProperty - true if it is a group-by property

isOrderByProperty

public boolean isOrderByProperty()

Whether the property is a query order-by property?

Returns:

true if it is an order-by property

setOrderByProperty

public void setOrderByProperty(boolean orderByProperty)

Set whether the property is a query order-by property.

Parameters:

orderByProperty - true if it is an order-by property

getSearchOptionPropertyVisibleName

public I18NName getSearchOptionPropertyVisibleName()

Get property visible name in search options that may be different from that in query view. For example, price (search option), price range (query).

Returns:

property visible name in search options. return null if it is same as query view property visible name.

setSearchOptionPropertyVisibleName

public void setSearchOptionPropertyVisibleName(I18NName searchOptionPropertyVisibleName)

Set property visible name in search options that may be different from that in query view. For example, price (search option), price range (query).

Parameters:

searchOptionPropertyVisibleName - visible name to set