org.shredzone.flattr4j.model
Class SearchQuery

java.lang.Object
  org.shredzone.flattr4j.model.SearchQuery

All Implemented Interfaces:

Serializable

public class SearchQuery
extends Object
implements Serializable

Collects search parameters. Every parameter is optional.

Since:

2.0

Author:

Richard "Shred" Körber

See Also:

Serialized Form

Nested Class Summary

static class

SearchQuery.Order Enumeration of available sort orders.

Constructor Summary

SearchQuery()

Method Summary

void	addCategory(CategoryId category) Adds a category to search for.
SearchQuery	category(CategoryId category) Category to search for.
Collection<CategoryId>	getCategories() Returns the collection of categories to search for.
CategoryId	getCategory() Returns the Category to search for.
LanguageId	getLanguage() Language to search for.
String	getQuery() Text to search for.
SearchQuery.Order	getSort() Sort order.
String	getTags() Tags to search for.
String	getUrl() URL to search for.
UserId	getUser() User to search for.
SearchQuery	language(LanguageId language) Language to search for.
SearchQuery	query(String query) Text to search for.
void	setCategory(CategoryId category) Sets a single category to search for.
void	setLanguage(LanguageId language)
void	setQuery(String query)
void	setSort(SearchQuery.Order sort)
void	setTags(String tags)
void	setupConnection(Connection conn) Sets up a Connection with the current search parameters.
void	setUrl(String url)
void	setUser(UserId user)
SearchQuery	sort(SearchQuery.Order order) Order to sort the result by.
SearchQuery	tags(String tags) Sets a tag expression to search for.
SearchQuery	user(UserId user) User to search for.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchQuery

public SearchQuery()

Method Detail

getQuery

public String getQuery()

Text to search for.

setQuery

public void setQuery(String query)

getTags

public String getTags()

Tags to search for. Allows logical operators: '|' (or), '&' (and), '!' (not). For example, "game | games ! software" means: search for "game" or "games", but not "software".

setTags

public void setTags(String tags)

getUrl

public String getUrl()

URL to search for.

setUrl

public void setUrl(String url)

getLanguage

public LanguageId getLanguage()

Language to search for.

setLanguage

public void setLanguage(LanguageId language)

getUser

public UserId getUser()

User to search for.

setUser

public void setUser(UserId user)

getSort

public SearchQuery.Order getSort()

Sort order. Defaults to SearchQuery.Order.RELEVANCE.

setSort

public void setSort(SearchQuery.Order sort)

getCategory

public CategoryId getCategory()

Returns the Category to search for. If multiple categories are set, only the first one is returned.

setCategory

public void setCategory(CategoryId category)

Sets a single category to search for. If other categories were set, they will be replaced.

addCategory

public void addCategory(CategoryId category)

Adds a category to search for.

Since:

2.2

getCategories

public Collection<CategoryId> getCategories()

Returns the collection of categories to search for. This collection is unmodifiable.

Since:

2.2

query

public SearchQuery query(String query)

Text to search for.

tags

public SearchQuery tags(String tags)

Sets a tag expression to search for.

language

public SearchQuery language(LanguageId language)

Language to search for.

category

public SearchQuery category(CategoryId category)

Category to search for.

Since version 2.2, multiple categories can be set by invoking this call multiple times.

user

public SearchQuery user(UserId user)

User to search for.

sort

public SearchQuery sort(SearchQuery.Order order)

Order to sort the result by.

setupConnection

public void setupConnection(Connection conn)

Sets up a Connection with the current search parameters.

Parameters:

conn - Connection to set up