com.redhat.rhn.common.db.datasource
Class SelectMode

java.lang.Object
  com.redhat.rhn.common.db.datasource.BaseMode
      com.redhat.rhn.common.db.datasource.SelectMode

All Implemented Interfaces:

Mode

Direct Known Subclasses:

DataListTest.HookedSelectMode

public class SelectMode
extends BaseMode

A cached set of query/elaborator strings and the parameterMap hash maps.

Constructor Summary

SelectMode()
Constructs a new SelectMode

SelectMode(SelectMode modeIn)
Copy constructor

Method Summary

void	addElaborator(CachedStatement q) Adds an elaborator query.
void	elaborate(java.util.List resultList, java.util.Map parameters) Elaborates a list by calling the elaboration queries with the given parameters.
DataResult	execute() Executes the query with no parameters.
DataResult	execute(java.util.List parameters) Executes the query with an IN clause.
DataResult	execute(java.util.Map parameters) Executes the query using the given parameters.
DataResult	execute(java.util.Map parameters, java.util.List inClause) Executes the query with the given parameters an an IN clause.
DataResult	execute(java.util.Map parameters, java.lang.String sortColumn, java.lang.String order) Executes the query using the given paramters and sort options.
java.lang.String	getClassString() get the class
java.util.List	getElaborators() Returns the list of elaborator queries.
int	getMaxRows() Returns maximum number of rows to be returned by this query.
void	setMaxRows(int max) The maximum number of rows to be returned by the query.
java.lang.String	toString()

Methods inherited from class com.redhat.rhn.common.db.datasource.BaseMode

getArity, getName, getQuery, setName, setQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectMode

public SelectMode()

Constructs a new SelectMode

SelectMode

public SelectMode(SelectMode modeIn)

Copy constructor

Parameters:

modeIn - The mode to copy into new SelectMode object

Method Detail

getClassString

public java.lang.String getClassString()

get the class

Returns:

the class

addElaborator

public void addElaborator(CachedStatement q)

Adds an elaborator query.

Parameters:

q - Elaborator query to execute.

getElaborators

public java.util.List getElaborators()

Returns the list of elaborator queries.

Returns:

List of elaborator queries.

execute

public DataResult execute(java.util.Map parameters,
                          java.lang.String sortColumn,
                          java.lang.String order)

Executes the query using the given paramters and sort options.

Parameters:

parameters - Query paramters.

sortColumn - column used for sorting.

order - Sorting order ASC or DESC

Returns:

DataResult containing results from query.

execute

public DataResult execute(java.util.Map parameters)

Executes the query using the given parameters.

Parameters:

parameters - Query parameters.

Returns:

DataResult containing results from query.

execute

public DataResult execute(java.util.List parameters)

Executes the query with an IN clause.

Parameters:

parameters - Query parameters.

Returns:

DataResult containing results from query.

execute

public DataResult execute()

Executes the query with no parameters.

Returns:

DataResult containing results from query.

execute

public DataResult execute(java.util.Map parameters,
                          java.util.List inClause)

Executes the query with the given parameters an an IN clause.

Parameters:

parameters - named parameters for the Query.

inClause - values to be included in the IN clause.

Returns:

DataResult containing results from query.

elaborate

public void elaborate(java.util.List resultList,
                      java.util.Map parameters)

Elaborates a list by calling the elaboration queries with the given parameters.

Parameters:

resultList - The resultList that has items from the driving query results.

parameters - named query parameters for elaborators.

toString

public java.lang.String toString()

Overrides:

toString in class BaseMode

setMaxRows

public void setMaxRows(int max)

The maximum number of rows to be returned by the query. Zero (0) means unlimited.

Parameters:

max - maximum number of rows to be returned, zero (0) is unlimited.

getMaxRows

public int getMaxRows()

Returns maximum number of rows to be returned by this query.

Returns:

maximum number of rows to be returned by this query.