com.google.visualization.datasource.query
Class QuerySort

java.lang.Object
  com.google.visualization.datasource.query.QuerySort

public class QuerySort
extends java.lang.Object

Sorting definition for a query. Sort is defined as a list of column sorts where the first is the primary sort order, the second is the secondary sort order, etc.

Author:

Yoah B.D.

Constructor Summary

QuerySort()
Constructs an empty sort list.

Method Summary

void	addSort(AbstractColumn column, SortOrder order) Adds a column sort condition.
void	addSort(ColumnSort columnSort) Adds a column sort condition.
boolean	equals(java.lang.Object obj)
java.util.List<AggregationColumn>	getAggregationColumns() Returns all the columns that are AggregationColumns including aggregation columns that are inside scalar function columns (e.g., year(min(a1))).
java.util.List<AbstractColumn>	getColumns() Returns a list of columns held by this query sort.
java.util.List<ScalarFunctionColumn>	getScalarFunctionColumns() Returns all the columns that are ScalarFunctionColumns including scalar functions columns that are inside other scalar function columns (e.g., sum(year(a), year(b))).
java.util.List<ColumnSort>	getSortColumns() Returns the list of sort columns.
int	hashCode()
boolean	isEmpty() Returns true if the sort list is empty.
java.lang.String	toQueryString() Returns a string that when fed to the query parser would produce an equal QuerySort.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QuerySort

public QuerySort()

Constructs an empty sort list.

Method Detail

isEmpty

public boolean isEmpty()

Returns true if the sort list is empty.

Returns:

True if the sort list is empty.

addSort

public void addSort(ColumnSort columnSort)

Adds a column sort condition. Validates that the column ID is not already specified in the sort.

Parameters:

columnSort - The column sort condition.

addSort

public void addSort(AbstractColumn column,
                    SortOrder order)

Adds a column sort condition. Validates that the column ID is not already specified in the sort.

Parameters:

column - The column to sort by.

order - The requested ordering.

getSortColumns

public java.util.List<ColumnSort> getSortColumns()

Returns the list of sort columns. This list is immutable.

Returns:

The list of sort columns. This list is immutable.

getColumns

public java.util.List<AbstractColumn> getColumns()

Returns a list of columns held by this query sort.

Returns:

A list of columns held by this query sort.

getAggregationColumns

public java.util.List<AggregationColumn> getAggregationColumns()

Returns all the columns that are AggregationColumns including aggregation columns that are inside scalar function columns (e.g., year(min(a1))).

Returns:

All the columns that are AggregationColumns.

getScalarFunctionColumns

public java.util.List<ScalarFunctionColumn> getScalarFunctionColumns()

Returns all the columns that are ScalarFunctionColumns including scalar functions columns that are inside other scalar function columns (e.g., sum(year(a), year(b))).

Returns:

all the columns that are ScalarFunctionColumns.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toQueryString

public java.lang.String toQueryString()

Returns a string that when fed to the query parser would produce an equal QuerySort. The string returned does not contain the ORDER BY keywords.

Returns:

The query string.