|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.client.Query.CategoryFilter
public static class Query.CategoryFilter
The CategoryFilter class is used to define sets of category conditions that must be met in order for an entry to match.
The CategoryFilter can contain multiple category criteria (inclusive or exclusive). If it does contain multiple categories, then the query matches if any one of the category filter criteria is met, i.e. it is a logical 'OR' of the contained category criteria. To match, an entry must contain at least one included category or must not contain at least one excluded category.
It is also possible to add multiple CategoryFilters to a Query. In this case, each individual CategoryFilter must be true for an entry to match, i.e. it is a logical 'AND' of all CategoryFilters.
Query.addCategoryFilter(CategoryFilter)
Constructor Summary | |
---|---|
Query.CategoryFilter()
Creates an empty category filter. |
|
Query.CategoryFilter(ICategory category)
Creates a simple category filter containing only a single ICategory . |
|
Query.CategoryFilter(java.util.List<ICategory> included,
java.util.List<ICategory> excluded)
Creates a new category filter using the supplied inclusion and exclusion lists. |
Method Summary | |
---|---|
void |
addCategory(ICategory category)
Adds a new ICategory to the query, indicating that entries
containing the category should be considered to match. |
void |
addExcludeCategory(ICategory category)
Adds a new ICategory to the query, indicating that entries
that do not contain the category should be considered to
match. |
java.util.List<ICategory> |
getCategories()
|
java.util.List<ICategory> |
getExcludeCategories()
|
java.lang.String |
toString()
Returns a string representation for the category conditions in the CategoryFilter, in the format used by a Query URI. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Query.CategoryFilter()
public Query.CategoryFilter(java.util.List<ICategory> included, java.util.List<ICategory> excluded)
public Query.CategoryFilter(ICategory category)
ICategory
.
category
- an initial category to add to the filter.Method Detail |
---|
public java.util.List<ICategory> getCategories()
public java.util.List<ICategory> getExcludeCategories()
public void addCategory(ICategory category)
ICategory
to the query, indicating that entries
containing the category should be considered to match.
category
- the category to add to query parameters.public void addExcludeCategory(ICategory category)
ICategory
to the query, indicating that entries
that do not contain the category should be considered to
match.
category
- the category to add to query parameters.public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |