net.sf.jkniv.sqlegance

Class Query

java.lang.Object

net.sf.jkniv.sqlegance.Query

All Implemented Interfaces:

IQuery

public class Query
extends Object
implements IQuery

Since:

0.0.2

Author:

alisson gomes

Constructor Summary

Constructors

Constructor and Description
Query(String name) TODO documentation
Query(String name, Object params) TODO documentation
Query(String name, Object params, int start, int max) TODO documentation

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.
void	setTotal(Long total)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(String name,
             Object params,
             int start,
             int max)

TODO documentation

Parameters:

name -

params -

start -

max -

Query

public Query(String name,
             Object params)

TODO documentation

Parameters:

name -

params -

Query

public Query(String name)

TODO documentation

Parameters:

name -

Method Detail

getName

public String getName()

Description copied from interface: IQuery

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

Specified by:

getName in interface IQuery

Returns:

Return the name of the query.

getParams

public Object getParams()

Description copied from interface: IQuery

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

Specified by:

getParams in interface IQuery

Returns:

the parameters to use at query.

getStart

public int getStart()

Description copied from interface: IQuery

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

Specified by:

getStart in interface IQuery

Returns:

return a row number, numbered from 0.

setStart

public void setStart(int value)

Description copied from interface: IQuery

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

Specified by:

setStart in interface IQuery

Parameters:

value -

getMax

public int getMax()

Description copied from interface: IQuery

Get the maximum number of rows from query result.

Specified by:

getMax in interface IQuery

Returns:

Return the maximum number.

setMax

public void setMax(int value)

Description copied from interface: IQuery

Set the maximum number of rows from query result.

Specified by:

setMax in interface IQuery

getTotal

public Long getTotal()

Description copied from interface: IQuery

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

Specified by:

getTotal in interface IQuery

Returns:

return the number of rows from query result.

setTotal

public void setTotal(Long total)

toString

public String toString()

Overrides:

toString in class Object