net.sf.jaxme.sqls
Interface SelectStatement

All Superinterfaces:

ConstrainedStatement, Statement

All Known Implementing Classes:

SelectStatementImpl

public interface SelectStatement

extends ConstrainedStatement

Interface of a SELECT statement.

Author:

Jochen Wiedmann

Nested Class Summary

static interface

SelectStatement.OrderColumn

Method Summary

void	addOrderColumn(ColumnReference pColumn) Adds a column to the ORDER BY clause.
void	addOrderColumn(ColumnReference pColumn, boolean pDescending) Adds a column to the ORDER BY clause.
void	addOrderColumn(SelectStatement.OrderColumn pColumn) Adds a column to the ORDER BY clause.
void	addResultColumn(ColumnReference pColumn) Adds a result column to the statement.
int	getMaxRows() Returns the limit of the number of rows in the result set, or zero, if the size of the result set is unlimited.
java.util.Iterator	getResultColumns() Returns the list of result columns.
SelectTableReference	getSelectTableReference() Shortcut for (SelectTableReference) getTable().
java.util.Iterator	getSelectTableReferences() Returns an Iterator over all the table references.
int	getSkippedRows() Returns the number of rows to skip at the result sets beginning.
boolean	isDistinct() Returns whether the statement should have a DISTINCT clause.
void	setDistinct(boolean pDistinct) Sets whether the statement should have a DISTINCT clause.
void	setMaxRows(int pMaxRows) Limits the size of the result set to the given number of rows.
void	setSkippedRows(int pSkippedRows) Indicates that the given number of rows should be skipped at the result sets beginning.

Methods inherited from interface net.sf.jaxme.sqls.ConstrainedStatement

getWhere

Methods inherited from interface net.sf.jaxme.sqls.Statement

getSQLFactory, getTableReference, setTable

Method Detail

getSelectTableReference

public SelectTableReference getSelectTableReference()

Shortcut for (SelectTableReference) getTable().

getSelectTableReferences

public java.util.Iterator getSelectTableReferences()

Returns an Iterator over all the table references.

addOrderColumn

public void addOrderColumn(SelectStatement.OrderColumn pColumn)

Adds a column to the ORDER BY clause.

addOrderColumn

public void addOrderColumn(ColumnReference pColumn)

Adds a column to the ORDER BY clause. The column is sorted in ascending order.

addOrderColumn

public void addOrderColumn(ColumnReference pColumn,
                           boolean pDescending)

Adds a column to the ORDER BY clause. The column is sorted in ascending or descending order, depending on the parameter pDescending.

Parameters:

pDescending - True for descending or false for ascending

addResultColumn

public void addResultColumn(ColumnReference pColumn)

Adds a result column to the statement. By default all columns are returned.

getResultColumns

public java.util.Iterator getResultColumns()

Returns the list of result columns.

setDistinct

public void setDistinct(boolean pDistinct)

Sets whether the statement should have a DISTINCT clause. By default no DISTINCT clause is present.

isDistinct

public boolean isDistinct()

Returns whether the statement should have a DISTINCT clause. By default no DISTINCT clause is present.

setMaxRows

public void setMaxRows(int pMaxRows)

Limits the size of the result set to the given number of rows. Defaults to zero, in which case the size of the result set is unlimited.

getMaxRows

public int getMaxRows()

Returns the limit of the number of rows in the result set, or zero, if the size of the result set is unlimited.

setSkippedRows

public void setSkippedRows(int pSkippedRows)

Indicates that the given number of rows should be skipped at the result sets beginning. The default is zero, in which case no rows are skipped.

getSkippedRows

public int getSkippedRows()

Returns the number of rows to skip at the result sets beginning. The default is zero, in which case no rows are skipped.