org.unitedinternet.cosmo.model.filter

Class ItemFilter

java.lang.Object

org.unitedinternet.cosmo.model.filter.ItemFilter

Direct Known Subclasses:

ContentItemFilter

public class ItemFilter
extends Object

Represents a filter that matches a set of criteria to all items. The set of criteria is essentially "ANDed" together. For example if displayName and parent are set, then the filter will match all items that match the displayName set AND belong to the parent set. If there are multiple AttributeFilters or StampFilters, all filters must match the item for the item to match the ItemFilter.

Constructor Summary

Constructors

Constructor and Description
ItemFilter()

Method Summary

Modifier and Type	Method and Description
void	addOrderBy(FilterOrder fo) Add an item property to order results by.
AttributeFilter	getAttributeFilter(QName qname) Return an AttributeFilter that matches a specific QName
List<AttributeFilter>	getAttributeFilters() List of AttributeFilters.
FilterCriteria	getDisplayName()
String	getFilterProperty(String key) Get a filter property
Integer	getMaxResults()
List<FilterOrder>	getOrders()
CollectionItem	getParent()
StampFilter	getStampFilter(Class<?> clazz) Return a specific StampFilter instance
List<StampFilter>	getStampFilters() List of StampFilters.
FilterCriteria	getUid()
void	setDisplayName(FilterCriteria displayName) Match items by item displayName
void	setFilterProperty(String key, String value) Set a filter property.
void	setMaxResults(Integer maxResults) Limit the number of results returned
void	setParent(CollectionItem parent) Match items by parent
void	setUid(FilterCriteria uid) Match item by uid

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemFilter

public ItemFilter()

Method Detail

getAttributeFilters

public List<AttributeFilter> getAttributeFilters()

List of AttributeFilters. If there are multiple attribute filters, each filter must match for an item to match the ItemFilter.

Returns:

list of attribute filters

getAttributeFilter

public AttributeFilter getAttributeFilter(QName qname)

Return an AttributeFilter that matches a specific QName

Parameters:

qname - qualified name

Returns:

attribute filter that matches the qualified name

getStampFilter

public StampFilter getStampFilter(Class<?> clazz)

Return a specific StampFilter instance

Parameters:

clazz - StampFilter class

Returns:

StampFilter instance that matches the given class

getStampFilters

public List<StampFilter> getStampFilters()

List of StampFilters. If there are multiple stamp filters, each filter must match for an item to match the ItemFilter.

Returns:

list of stamp filters

getDisplayName

public FilterCriteria getDisplayName()

setDisplayName

public void setDisplayName(FilterCriteria displayName)

Match items by item displayName

Parameters:

displayName - displayName to match

getParent

public CollectionItem getParent()

setParent

public void setParent(CollectionItem parent)

Match items by parent

Parameters:

parent - parent to match

getUid

public FilterCriteria getUid()

setUid

public void setUid(FilterCriteria uid)

Match item by uid

Parameters:

uid - uid to match

setFilterProperty

public void setFilterProperty(String key,
                              String value)

Set a filter property. Filter properties can be used by the filter processor to further filter the results.

Parameters:

key - key

value - value

getFilterProperty

public String getFilterProperty(String key)

Get a filter property

Parameters:

key - key

Returns:

value of property

addOrderBy

public void addOrderBy(FilterOrder fo)

Add an item property to order results by. For now, this is only really useful when used with setMaxResults(), where you only want to return the top X items, where the items are in a certain order before the top X are chosen.

Parameters:

fo -

getOrders

public List<FilterOrder> getOrders()

getMaxResults

public Integer getMaxResults()

setMaxResults

public void setMaxResults(Integer maxResults)

Limit the number of results returned

Parameters:

maxResults -