Package com.caplin.transformer.persistence

Class QueryParams

java.lang.Object

com.caplin.transformer.persistence.QueryParams

public class QueryParams
extends Object

This class is used to hold all the information necessary for Persistor.onQuery(String, String, QueryParams) to create and execute a query

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueryParams.Order	Enum representing the sort order to be applied to columns

Method Summary

Modifier and Type	Method	Description
String[]	getArgs()	An array of arguments to be bound to the ? characters in the argument query passed to Persistor.onQuery(String, String, QueryParams)
long	getLimit()	Returns the maximum number of rows that should be returned by a query.
com.caplin.transformer.persistence.Ordering[]	getOrdering()	An array holding specific fields paired with a sort order represented as the enum QueryParams.Order.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getArgs

public String[] getArgs()

An array of arguments to be bound to the ? characters in the argument query passed to Persistor.onQuery(String, String, QueryParams)

Returns:

String array containing the arguments or null if none specified

getOrdering

public com.caplin.transformer.persistence.Ordering[] getOrdering()

An array holding specific fields paired with a sort order represented as the enum QueryParams.Order. The arguments in this array must be applied in priority order where index 0 represents the primary sort column

Returns:

Ordering array containing the arguments for the order by clause or null if none specified

getLimit

public long getLimit()

Returns the maximum number of rows that should be returned by a query. These rows will be the first n rows of the result without changing any order. 0

Returns:

maximum number of rows to be returned or 0 for all rows

toString

public String toString()

Overrides:

toString in class Object