public class

GoogleBaseQuery

extends Query

java.lang.Object
↳	com.google.gdata.client.Query
	↳	com.google.api.gbase.client.GoogleBaseQuery

Class Overview

Adds support for the "bq" and "max-values" parameters to a gdata query. Query.

Summary

Constants
String	BQ_PARAMETER
String	CONTENT
String	CROWD_BY
String	MAX_VALUES_PARAMETER
String	ORDER_BY
String	REFINE
String	SORT_ORDER

[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
	GoogleBaseQuery(URL feedUrl) Creates a Google Base query.

Public Methods
String	getContent() Gets what will be returned, on the customer feed.
String	getCrowdBy() Gets the criteria that will be used to crowd the results.
String	getGoogleBaseQuery() Gets the Google Base query that will be executed.
Integer	getMaxValues() Gets the current value for the `max-values` parameter.
String	getOrderBy() Gets the criteria that will be used to sort the results.
boolean	getRefine() Checks whether the query should be refined.
boolean	isAscendingOrder() Checks whether the results will be returned in ascending order.
void	setAscendingOrder(boolean ascending) Changes the order in which results are returned (ascending or descending).
void	setContent(String content) Selects what to return, on the customer feed.
void	setCrowdingBy(String crowdBy) Sets the criteria used for crowding the results in groups.
void	setGoogleBaseQuery(String query) Sets the Google Base query to execute.
void	setMaxValues(Integer maxValues) Sets the `max-values` parameter used by histogram feeds to limit the number of unique values to return for one attribute.
void	setOrderBy(String orderBy) Sets the criteria used to sort the results.
void	setRefine(boolean refine) Enables query refinement.

[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

private static final String BQ_PARAMETER

Constant Value: "bq"

private static final String CONTENT

Constant Value: "content"

private static final String CROWD_BY

Constant Value: "crowdby"

private static final String MAX_VALUES_PARAMETER

Constant Value: "max-values"

private static final String ORDER_BY

Constant Value: "orderby"

private static final String REFINE

Constant Value: "refine"

private static final String SORT_ORDER

Constant Value: "sortorder"

Public Constructors

public GoogleBaseQuery (URL feedUrl)

Creates a Google Base query.

Parameters

feedUrl	The URL to connect to

Public Methods

public String getContent ()

Gets what will be returned, on the customer feed.

Returns

what will be returned

public String getCrowdBy ()

Gets the criteria that will be used to crowd the results.

Returns

criteria or null if no crowding has been set

public String getGoogleBaseQuery ()

Gets the Google Base query that will be executed.

Returns

the query or null if none was set

public Integer getMaxValues ()

Gets the current value for the max-values parameter.

Returns

current value or null

public String getOrderBy ()

Gets the criteria that will be used to sort the results.

Returns

criteria or null if no order has been set

public boolean getRefine ()

Checks whether the query should be refined.

Returns

true if the query should be refined

public boolean isAscendingOrder ()

Checks whether the results will be returned in ascending order.

Returns

if true, the results will be returned in ascending order, otherwise they will be returned in descending order

public void setAscendingOrder (boolean ascending)

Changes the order in which results are returned (ascending or descending). Descending order (from the largest value to the smallest value) is the default.

Parameters

ascending	If true, return the result in ascending order

public void setContent (String content)

Selects what to return, on the customer feed.

Parameters

content	What should be returned (see documentation)

public void setCrowdingBy (String crowdBy)

Sets the criteria used for crowding the results in groups.

Parameters

crowdBy	Crowding criteria (see documentation)

public void setGoogleBaseQuery (String query)

Sets the Google Base query to execute. When running queries on Google Base, you have a choice between a Google Base query, which will be interpreted and executed strictly following the Google Base query language, and a Fulltext query (see setFullTextQuery(String)) which will be interpreted just like a query typed in the search box on the Google Base website - including some user-friendly preprocessing that might be useful or confusing depending on what you're trying to do. You cannot specify both a Google Base query and a Fulltext query.

Parameters

query	Google base query

Throws

IllegalStateException	if a fulltext query is already set.

public void setMaxValues (Integer maxValues)

Sets the max-values parameter used by histogram feeds to limit the number of unique values to return for one attribute.

Parameters

maxValues

public void setOrderBy (String orderBy)

Sets the criteria used to sort the results. By default results are ordered by relevancy.

Parameters

orderBy	Sorting criteria (see documentation)

public void setRefine (boolean refine)

Enables query refinement. By default results are not refined.

Parameters

refine	True to enable query refinment

Classes

Enums

GoogleBaseQuery

Class Overview

Summary

Constants

private static final String BQ_PARAMETER

private static final String CONTENT

private static final String CROWD_BY

private static final String MAX_VALUES_PARAMETER

private static final String ORDER_BY

private static final String REFINE

private static final String SORT_ORDER

Public Constructors

public GoogleBaseQuery (URL feedUrl)

Parameters

Public Methods

public String getContent ()

Returns

public String getCrowdBy ()

Returns

public String getGoogleBaseQuery ()

Returns

public Integer getMaxValues ()

Returns

public String getOrderBy ()

Returns

public boolean getRefine ()

Returns

public boolean isAscendingOrder ()

Returns

public void setAscendingOrder (boolean ascending)

Parameters

public void setContent (String content)

Parameters

public void setCrowdingBy (String crowdBy)

Parameters

public void setGoogleBaseQuery (String query)

Parameters

Throws

public void setMaxValues (Integer maxValues)

Parameters

public void setOrderBy (String orderBy)

Parameters

public void setRefine (boolean refine)

Parameters