com.google.gdata.client

Class DocumentQuery

java.lang.Object

com.google.gdata.client.Query

com.google.gdata.client.DocumentQuery

Direct Known Subclasses:

SpreadsheetQuery, WorksheetQuery

public class DocumentQuery
extends Query

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

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.client.Query

Query.CategoryFilter, Query.CustomParameter, Query.ResultFormat

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SORT_MODE
static String	LAST_MODIFIED_SORT
static String	LAST_VIEWED_SORT
static 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.
static String	STARRED_SORT
static String	TITLE The URI parameter for querying the title or name of a document.
static 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).
static String	TITLE_SORT

Fields inherited from class com.google.gdata.client.Query

UNDEFINED

Constructor Summary

Constructors

Constructor and Description
DocumentQuery(URL feedUrl) Constructs a query for querying spreadsheets that you have access to.

Method Summary

Methods

Modifier and Type	Method and Description
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.

Methods inherited from class com.google.gdata.client.Query

addCategoryFilter, addCustomParameter, appendQueryParameter, getAuthor, getCategoryFilters, getCustomParameters, getCustomParameters, getFeedUrl, getFields, getFullTextQuery, getIntegerCustomParameter, getMaxResults, getPublishedMax, getPublishedMin, getQueryUri, getResultFormat, getStartIndex, getStringCustomParameter, getUpdatedMax, getUpdatedMin, getUrl, isStrict, isValidState, setAuthor, setFields, setFullTextQuery, setIntegerCustomParameter, setMaxResults, setPublishedMax, setPublishedMin, setResultFormat, setStartIndex, setStrict, setStringCustomParameter, setUpdatedMax, setUpdatedMin

Methods inherited from class java.lang.Object

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

Field Detail

TITLE

public static final String TITLE

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

See Also:

Constant Field Values

TITLE_EXACT

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).

See Also:

Constant Field Values

ORDERBY

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.

See Also:

Constant Field Values

LAST_MODIFIED_SORT

public static final String LAST_MODIFIED_SORT

See Also:

Constant Field Values

LAST_VIEWED_SORT

public static final String LAST_VIEWED_SORT

See Also:

Constant Field Values

TITLE_SORT

public static final String TITLE_SORT

See Also:

Constant Field Values

STARRED_SORT

public static final String STARRED_SORT

See Also:

Constant Field Values

DEFAULT_SORT_MODE

public static final String DEFAULT_SORT_MODE

See Also:

Constant Field Values

Constructor Detail

DocumentQuery

public DocumentQuery(URL feedUrl)

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

Parameters:

feedUrl - the feed's URI

Method Detail

setTitleQuery

public void setTitleQuery(String titleQuery)

Sets the full-text title search.

Parameters:

titleQuery - the title query

getTitleQuery

public String getTitleQuery()

Gets full-text title query.

setTitleExact

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

isTitleExact

public boolean isTitleExact()

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

Returns:

whether the results should be exact

setSortMode

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

getSortMode

public String getSortMode()

Gets the sort mode