com.arsdigita.categorization
Class CategorizedCollection
java.lang.Object
com.arsdigita.domain.DomainQuery
com.arsdigita.domain.DomainCollection
com.arsdigita.kernel.ACSObjectCollection
com.arsdigita.categorization.CategorizedCollection
- All Implemented Interfaces:
- DataQuery
- public final class CategorizedCollection
- extends ACSObjectCollection
Represents a collection of categorized objects.
This collection can be iterated over by calling the next()
method and retrieving the current object via getDomainObject()
.
This class inherits a number of methods from DomainQuery
that allow filtering and ordering of this
collection. In order to apply filters or order clauses, you have to know the
object model of the data collection
backing up this
class. Categorized collections are produced by Category.getObjects(String)
and Category.getObjects(String, String)
.
See the Javadoc for these methods to learn about high-level guarantees of the
structure of the possible query paths that can be used for ordering and/or
filtering.
- Since:
- 2003-09-17
- Version:
- $Revision: #6 $ $DateTime: 2004/04/07 16:07:11 $
- Author:
- Vadim Nasardinov (vadimn@redhat.com)
- See Also:
Category.getObjects(String)
,
Category.getObjects(String, String)
Method Summary |
void |
sort(boolean ascending)
Specifies the sort order the categorized collection. |
Methods inherited from class com.arsdigita.domain.DomainQuery |
addEqualsFilter, addFilter, addFilter, addInSubqueryFilter, addInSubqueryFilter, addNotEqualsFilter, addNotInSubqueryFilter, addOrder, addOrderWithNull, addPath, alias, clearFilter, clearOrder, close, first, get, getFilterFactory, getParameter, getPosition, getPropertyValues, getType, hasProperty, isAfterLast, isBeforeFirst, isEmpty, isFirst, isLast, last, next, previous, removeFilter, reset, rewind, setFilter, setOrder, setParameter, setRange, setRange, setReturnsLowerBound, setReturnsUpperBound, size |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
sort
public final void sort(boolean ascending)
- Specifies the sort order the categorized collection.
A categorization collection usually represents a list of child objects
of a particular category. These objects can be sorted using the Category.swapWithNext(ACSObject)
and Category.swapWithPrevious(ACSObject)
methods. This method to make use
of this sort order.
- See Also:
Category.SORT_KEY
,
Category.swapWithNext(ACSObject)
,
Category.swapWithPrevious(ACSObject)
,
Category.alphabetizeChildCategories()
Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC