public class

ListQuery

extends Query

java.lang.Object
↳	com.google.gdata.client.Query
	↳	com.google.gdata.client.spreadsheet.ListQuery

Class Overview

Simple class for cells-feed-specific queries.

Summary

Constants
String	ORDERBY	The URI parameter for sorting options.
String	ORDERBY_COLUMN	The "orderby" string for sorting by a particular column.
String	ORDERBY_POSITION	The "orderby" string for sorting by position.
String	REVERSE	The URI parameter for reversing sorted results.
String	SPREADSHEET_QUERY	The URI parameter for structured spreadsheet queries.

[Expand]

Inherited Constants

From class com.google.gdata.client.Query

[Expand]

Inherited Fields

From class com.google.gdata.client.Query

private String	author	Author name or e-mail address for matched entries.
private List<Query.CategoryFilter>	categoryFilters	The list of category filters associate with the query.
private List<Query.CustomParameter>	customParameters	The list of custom parameters associated with the query.
private URL	feedUrl	Base feed URL against which the query will be applied.
private String	fields	Fields partial selection query parameter
private int	maxResults	The maximum number of results to return for the query.
private DateTime	publishedMax	Maximum published timestamp for matched entries.
private DateTime	publishedMin	Minimum published timestamp for matched entries.
private String	queryString	Full-text search query string.
private Query.ResultFormat	resultFormat	The expected result format for the query.
private int	startIndex	The start index for query results.
private boolean	strict	The strictness of the query parameter parsing on the server.
private DateTime	updatedMax	Maximum updated timestamp for matched entries.
private DateTime	updatedMin	Minimum updated timestamp for matched entries.

Public Constructors
	ListQuery(URL feedUrl) Constructs a non-restrictive row-based query, given the URI of a list feed for a particular worksheet.

Public Methods
String	getOrderBy() Gets the sorting query parameter.
String	getSpreadsheetQuery() Gets the structured spreadsheet query string.
boolean	isReverse() Gets whether the query should be reversed.
void	setFullTextQuery(String query) Sets the full-text query.
void	setOrderBy(String orderby) Sets the sorting parameter, which can be "position", or "column:(column name)".
void	setReverse(boolean reverse) Sets whether the results should be reversed, i.e.
void	setSortColumn(String column) Sort by a specific column.
void	setSpreadsheetQuery(String query) Sets the structured spreadsheet query.

[Expand]

Inherited Methods

From class com.google.gdata.client.Query

void	addCategoryFilter(Query.CategoryFilter categoryFilter) Adds a new CategoryFilter to the query.
void	addCustomParameter(Query.CustomParameter customParameter) Adds a new CustomParameter.
void	appendQueryParameter(StringBuilder queryBuf, String paramName, String paramValue) Appends specified query (parameter, value) to provided query URL buffer.
String	getAuthor() Returns the author name or email address used for the query.
List<Query.CategoryFilter>	getCategoryFilters() Returns the current list of CategoryFilters associated with the query.
List<Query.CustomParameter>	getCustomParameters() Returns the list of custom parameters.
List<Query.CustomParameter>	getCustomParameters(String name) Returns the list of custom parameters that match a specified name.
URL	getFeedUrl() Returns the feed URL of this query.
String	getFields() Returns the fields query string that will be used for the query.
String	getFullTextQuery() Returns the full text query string that will be used for the query.
final Integer	getIntegerCustomParameter(String name) Gets an existing Integer custom paramter, with null signifying that the parameter is not specified or not an integer.
int	getMaxResults() Returns the maximum number of results to return for the query, or `UNDEFINED` if max results has not been set.
DateTime	getPublishedMax() Returns the maximum published timestamp used for this query.
DateTime	getPublishedMin() Returns the minimum published timestamp used for this query.
URI	getQueryUri() Returns the relative query URI that represents only the query parameters without any components related to the target feed.
Query.ResultFormat	getResultFormat() Returns the query result format.
int	getStartIndex() Returns the current start index value for the query, or `UNDEFINED` if start index has not been set.
final String	getStringCustomParameter(String name) Gets an existing String custom parameter, with null signifying that the parameter is not specified.
DateTime	getUpdatedMax() Returns the maximum updated timestamp used for this query.
DateTime	getUpdatedMin() Returns the minimum updated timestamp used for this query.
URL	getUrl() Returns the Query URL that encapsulates the current state of this query object.
boolean	isStrict() Returns the strictness setting for query parameter parsing on the server.
boolean	isValidState() Check if current query state is supported.
void	setAuthor(String author) Sets the author name or email address used for the query.
void	setFields(String fields) Sets the "fields" partial selection query parameter.
void	setFullTextQuery(String query) Sets the full text query string that will be used for the query.
final void	setIntegerCustomParameter(String name, Integer value) Sets an integer custom paramter, with null signifying to clear the parameter.
void	setMaxResults(int maxResults) Sets the maximum number of results to return for the query.
void	setPublishedMax(DateTime publishedMax) Sets the maximum published timestamp used for the query.
void	setPublishedMin(DateTime publishedMin) Sets the minimum published timestamp used for the query.
void	setResultFormat(Query.ResultFormat resultFormat) Sets the expected query result format.
void	setStartIndex(int startIndex) Sets the start index for query results.
void	setStrict(boolean strict) Sets the strictness of parameter parsing.
final void	setStringCustomParameter(String name, String value) Sets a string custom parameter, with null signifying to clear the parameter.
void	setUpdatedMax(DateTime updatedMax) Sets the maximum updated timestamp used for the query.
void	setUpdatedMin(DateTime updatedMin) Sets the minimum updated timestamp used for the query.

From class java.lang.Object

Constants

public static final String ORDERBY

The URI parameter for sorting options.

Constant Value: "orderby"

public static final String ORDERBY_COLUMN

The "orderby" string for sorting by a particular column. For instance, "column:title" would sort by the column title.

Constant Value: "column"

public static final String ORDERBY_POSITION

The "orderby" string for sorting by position.

Constant Value: "position"

public static final String REVERSE

The URI parameter for reversing sorted results.

Constant Value: "reverse"

public static final String SPREADSHEET_QUERY

The URI parameter for structured spreadsheet queries.

Constant Value: "sq"

Public Constructors

public ListQuery (URL feedUrl)

Constructs a non-restrictive row-based query, given the URI of a list feed for a particular worksheet.

Parameters

feedUrl	The feed's URI

Public Methods

public String getOrderBy ()

Gets the sorting query parameter.

public String getSpreadsheetQuery ()

Gets the structured spreadsheet query string.

public boolean isReverse ()

Gets whether the query should be reversed.

public void setFullTextQuery (String query)

Sets the full-text query. Matched entries must contain all the specified words somewhere in the input.

Parameters

query	The full-text query string such as "Sonja Georgia"

public void setOrderBy (String orderby)

Sets the sorting parameter, which can be "position", or "column:(column name)".

Parameters

orderby	The order-by parameter

public void setReverse (boolean reverse)

Sets whether the results should be reversed, i.e. descending.

Parameters

reverse	Whether to reverse results

public void setSortColumn (String column)

Sort by a specific column. Convenience method for setOrderBy("column:" + column).

Parameters

column

public void setSpreadsheetQuery (String query)

Sets the structured spreadsheet query.

Parameters

query	The query such as "name = 'Sonja' and state = 'Georgia'"

Classes

ListQuery

Class Overview

Summary

Constants

public static final String ORDERBY

public static final String ORDERBY_COLUMN

public static final String ORDERBY_POSITION

public static final String REVERSE

public static final String SPREADSHEET_QUERY

Public Constructors

public ListQuery (URL feedUrl)

Parameters

Public Methods

public String getOrderBy ()

public String getSpreadsheetQuery ()

public boolean isReverse ()

public void setFullTextQuery (String query)

Parameters

public void setOrderBy (String orderby)

Parameters

public void setReverse (boolean reverse)

Parameters

public void setSortColumn (String column)

Parameters

public void setSpreadsheetQuery (String query)

Parameters