public class

CellQuery

extends Query

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

Class Overview

Simple class for cells-feed-specific queries. The main features include minimum and maximum row and column numbers. For instance, you could select only cells in the range of rows 2 through 5 and columns 3 and beyond. This would correspond to: query.setMinimumRow(2); query.setMaximumRow(5); query.setMinimumCol(3);

Summary

Constants
String	MAXIMUM_COL	String property for maximum column number.
String	MAXIMUM_ROW	String property for maximum row number.
String	MINIMUM_COL	String property for minimum column number.
String	MINIMUM_ROW	String property for minimum row number.
String	RANGE	String property for a cell range.
String	RETURN_EMPTY	String porperty for flag to return empty cells.

[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
	CellQuery(URL feedUrl) Constructs an object representing a to-be-executed query on cells.

Public Methods
Integer	getMaximumCol() Gets the largest column number possible in the cells to be returned.
Integer	getMaximumRow() Gets the largest row number possible in the cells to be returned.
Integer	getMinimumCol() Gets the smallest column number possible in the cells to be returned.
Integer	getMinimumRow() Gets the smallest row number possible in the cells to be returned.
String	getRange() Gets the range of the cells to be returned.
boolean	getReturnEmpty() Gets whether the empty cells should be returned.
void	setMaximumCol(Integer value) Sets the maximum column number of cells that are returned.
void	setMaximumRow(Integer value) Sets the maximum row number of cells that are returned.
void	setMinimumCol(Integer value) Sets the minimum column number of cells that are returned.
void	setMinimumRow(Integer value) Sets the minimum row number of cells that are returned.
void	setRange(String value) Sets the range for the cells to return.
void	setReturnEmpty(boolean value) Sets whether to return empty cells.

[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 MAXIMUM_COL

String property for maximum column number.

Constant Value: "max-col"

public static final String MAXIMUM_ROW

String property for maximum row number.

Constant Value: "max-row"

public static final String MINIMUM_COL

String property for minimum column number.

Constant Value: "min-col"

public static final String MINIMUM_ROW

String property for minimum row number.

Constant Value: "min-row"

public static final String RANGE

String property for a cell range.

Constant Value: "range"

public static final String RETURN_EMPTY

String porperty for flag to return empty cells.

Constant Value: "return-empty"

Public Constructors

public CellQuery (URL feedUrl)

Constructs an object representing a to-be-executed query on cells.

Parameters

feedUrl	The URI of the particular worksheet's cells feed

Public Methods

public Integer getMaximumCol ()

Gets the largest column number possible in the cells to be returned.

public Integer getMaximumRow ()

Gets the largest row number possible in the cells to be returned.

public Integer getMinimumCol ()

Gets the smallest column number possible in the cells to be returned.

public Integer getMinimumRow ()

Gets the smallest row number possible in the cells to be returned.

public String getRange ()

Gets the range of the cells to be returned.

public boolean getReturnEmpty ()

Gets whether the empty cells should be returned.

public void setMaximumCol (Integer value)

Sets the maximum column number of cells that are returned.

Parameters

value	The column number, of null if there is no maximum

public void setMaximumRow (Integer value)

Sets the maximum row number of cells that are returned.

Parameters

value	The row number, or null if there is no maximum

public void setMinimumCol (Integer value)

Sets the minimum column number of cells that are returned.

Parameters

value	The column numer, or null if there is no minimum

public void setMinimumRow (Integer value)

Sets the minimum row number of cells that are returned.

Parameters

value	The row number, or null if there is no minimum

public void setRange (String value)

Sets the range for the cells to return.

Parameters

value	The range in A1 or R1C1 for the cells to be returned.

public void setReturnEmpty (boolean value)

Sets whether to return empty cells.

Parameters

value	If true, then empty cells will be returned in the feed.

Classes

CellQuery

Class Overview

Summary

Constants

public static final String MAXIMUM_COL

public static final String MAXIMUM_ROW

public static final String MINIMUM_COL

public static final String MINIMUM_ROW

public static final String RANGE

public static final String RETURN_EMPTY

Public Constructors

public CellQuery (URL feedUrl)

Parameters

Public Methods

public Integer getMaximumCol ()

public Integer getMaximumRow ()

public Integer getMinimumCol ()

public Integer getMinimumRow ()

public String getRange ()

public boolean getReturnEmpty ()

public void setMaximumCol (Integer value)

Parameters

public void setMaximumRow (Integer value)

Parameters

public void setMinimumCol (Integer value)

Parameters

public void setMinimumRow (Integer value)

Parameters

public void setRange (String value)

Parameters

public void setReturnEmpty (boolean value)

Parameters