public class

DocumentQuery

extends Query

java.lang.Object
↳	com.google.gdata.client.Query
	↳	com.google.gdata.client.DocumentQuery

Known Direct Subclasses

SpreadsheetQuery, WorksheetQuery

Class Overview

Simple class for document-based queries, i.e. things that have titles.

Summary

Constants
String	DEFAULT_SORT_MODE
String	LAST_MODIFIED_SORT
String	LAST_VIEWED_SORT
String	ORDERBY	The URI parameter for how the query should be sorted, can sort by last-modified, last-accessed, title and starred; will default to last-modified.
String	STARRED_SORT
String	TITLE	The URI parameter for querying the title or name of a document.
String	TITLE_EXACT	The URI parameter for a boolean flag for whether the title should be matched exactly (case-insensitive or sensitive depending on service).
String	TITLE_SORT

[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
	DocumentQuery(URL feedUrl) Constructs a query for querying spreadsheets that you have access to.

Public Methods
String	getSortMode() Gets the sort mode
String	getTitleQuery() Gets full-text title query.
boolean	isTitleExact() Gets whether the query should be exact (rather than keyword-based).
void	setSortMode(String orderby) Sets the sort mode of the query.
void	setTitleExact(boolean exact) Sets whether the title match should be exact (instead of keyword-based).
void	setTitleQuery(String titleQuery) Sets the full-text title search.

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

Constant Value: "last-modified"

public static final String LAST_MODIFIED_SORT

Constant Value: "last-modified"

public static final String LAST_VIEWED_SORT

Constant Value: "last-viewed"

public static final String ORDERBY

The URI parameter for how the query should be sorted, can sort by last-modified, last-accessed, title and starred; will default to last-modified.

Constant Value: "orderby"

public static final String STARRED_SORT

Constant Value: "starred"

public static final String TITLE

The URI parameter for querying the title or name of a document.

Constant Value: "title"

public static final String TITLE_EXACT

The URI parameter for a boolean flag for whether the title should be matched exactly (case-insensitive or sensitive depending on service).

Constant Value: "title-exact"

public static final String TITLE_SORT

Constant Value: "title"

Public Constructors

public DocumentQuery (URL feedUrl)

Constructs a query for querying spreadsheets that you have access to.

Parameters

feedUrl	The feed's URI

Public Methods

public String getSortMode ()

Gets the sort mode

public String getTitleQuery ()

Gets full-text title query.

public boolean isTitleExact ()

Gets whether the query should be exact (rather than keyword-based).

Returns

whether the results should be exact

public void setSortMode (String orderby)

Sets the sort mode of the query. Can be one of the following: last-modified (default), last-accessed, title, starred

Parameters

orderby	The sort mode

public void setTitleExact (boolean exact)

Sets whether the title match should be exact (instead of keyword-based). By default, the match is not exact.

Parameters

exact	Whether the results should be exact

public void setTitleQuery (String titleQuery)

Sets the full-text title search.

Parameters

titleQuery	The title query

Interfaces

Classes

Enums

Exceptions

DocumentQuery

Class Overview

Summary

Constants

public static final String DEFAULT_SORT_MODE

public static final String LAST_MODIFIED_SORT

public static final String LAST_VIEWED_SORT

public static final String ORDERBY

public static final String STARRED_SORT

public static final String TITLE

public static final String TITLE_EXACT

public static final String TITLE_SORT

Public Constructors

public DocumentQuery (URL feedUrl)

Parameters

Public Methods

public String getSortMode ()

public String getTitleQuery ()

public boolean isTitleExact ()

Returns

public void setSortMode (String orderby)

Parameters

public void setTitleExact (boolean exact)

Parameters

public void setTitleQuery (String titleQuery)

Parameters