net.sf.jkniv.sqlegance

Interface IQuery

All Known Implementing Classes:

Query

public interface IQuery

This class represent a query object to find the query to be performed and your parameters like: query parameters, offset and max objects to return.

Since:

0.0.2

Author:

alisson gomes

Method Summary

Modifier and Type	Method and Description
int	getMax() Get the maximum number of rows from query result.
String	getName() The query name used to localize the query at in XML file.
Object	getParams() Parameters of query.
int	getStart() Get the number from first row from query result.
Long	getTotal() Get total of rows that query can retrieve, filled after query is executed.
void	setMax(int value) Set the maximum number of rows from query result.
void	setStart(int value) Set the number from first row from query result.

Method Detail

getName

String getName()

The query name used to localize the query at in XML file.

Returns:

Return the name of the query.

getParams

Object getParams()

Parameters of query. Can be objects like Author, Book, etc. or a java.util.Map.

Returns:

the parameters to use at query.

getStart

int getStart()

Get the number from first row from query result. If not set, rows will be retrieved beginning from row 0.

Returns:

return a row number, numbered from 0.

setStart

void setStart(int value)

Set the number from first row from query result. If not set, rows will be retrieved beginning from row 0.

Parameters:

value -

getMax

int getMax()

Get the maximum number of rows from query result.

Returns:

Return the maximum number.

setMax

void setMax(int value)

Set the maximum number of rows from query result.

Parameters:

value -

getTotal

Long getTotal()

Get total of rows that query can retrieve, filled after query is executed. Useful to make pagination.

Returns:

return the number of rows from query result.