com.canto.cumulus

Class MultiCategoryItemCollection

java.lang.Object

com.canto.cumulus.MultiItemCollection

com.canto.cumulus.MultiCategoryItemCollection

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<Item>

public class MultiCategoryItemCollection
extends MultiItemCollection

A collection of CategoryItemCollection objects of different catalogs. You can create a new instance using Server.newMultiCategoryItemCollection().

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
MultiCategoryItemCollection	clone(boolean createEmptyClone) Create a clone of this collection.
MultiCategoryItemCollection	clone(boolean createEmptyClone, boolean createNewCollection) Create a clone of this collection.
java.util.List<java.lang.Integer>	getCatalogIDs() Return the catalog ID of all CategoryItemCollections that are contained in this MultiCategoryItemCollection.
CategoryItem	getCategoryItemByID(int catalogID, int categoryID) Return a category item specified by catalog ID and item ID.
CategoryItem	getCategoryItemByID(ItemIdentifier identifier) Return a category item specified by identifier.
CategoryItemCollection	getCategoryItemCollection(int catalogID) Return the contained CategoryItemCollection for the given catalog ID.
java.util.Iterator<Item>	iterator() Return an iterator that iterates over all items in this collection.

Methods inherited from class com.canto.cumulus.MultiItemCollection

addCollectionListener, addFilter, addFilter, addFilter, addFilter, addFilter, addGlobalCollectionListener, addItem, addItem, addItemCollection, addItems, close, doAssetAction, doAssetAction, doAssetAction, equals, find, find, find, find, find, find, find, find, findAll, findAll, getCumulusSession, getDailyStatistics, getDailyStatistics, getItemByID, getItemByID, getItemCollection, getItemCount, getItemFieldStatistics, getItemFieldsWithStatistics, getItemFieldsWithStatistics, getItemFieldsWithStatistics, getItemFieldValues, getItemIDs, getItemPosition, getItemPosition, getItemTotalCount, getMultiLayout, getMultiSorting, getServer, getSortDirection, getSorting, getTableName, hashCode, hasItem, matchIDs, moveItem, quickSearch, removeAllItems, removeCollectionListener, removeFilter, removeGlobalCollectionListener, removeItem, removeItem, removeItemCollection, removeItems, setFreesorted, setMultiSorting, setSortDirection, setSorting, updateWantedFields, updateWantedFields

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

clone

public MultiCategoryItemCollection clone(boolean createEmptyClone)

Create a clone of this collection. The cloned collection will either be empty or contain the same CategoryItemCollections and items as this collection.

Overrides:

clone in class MultiItemCollection

Parameters:

createEmptyClone - Pass true if you want the new collection to be empty. Pass false if it should contain the same items as this collection.

Returns:

The newly created clone of this collection.

clone

public MultiCategoryItemCollection clone(boolean createEmptyClone,
                                boolean createNewCollection)

Create a clone of this collection. The cloned collection will either be empty or contain the same CategoryItemCollections and items as this collection.

Overrides:

clone in class MultiItemCollection

Parameters:

createEmptyClone - Pass true if you want the new collection to be empty. Pass false if it should contain the same items as this collection.

createNewCollection - Pass true if you want the new collection has no specific filters and sorting settings. Pass false if you want the new collection to have the same filters and sorting settings as this collection.

Returns:

The newly created clone of this collection.

Since:

9.2.4

getCatalogIDs

public java.util.List<java.lang.Integer> getCatalogIDs()

Return the catalog ID of all CategoryItemCollections that are contained in this MultiCategoryItemCollection.

Overrides:

getCatalogIDs in class MultiItemCollection

Returns:

The catalog IDs of all contained ItemCollections in the order of adding them this instance.

See Also:

MultiItemCollection.addItemCollection(ItemCollection)

getCategoryItemByID

public CategoryItem getCategoryItemByID(ItemIdentifier identifier)
                                 throws ItemNotFoundException,
                                        CumulusException

Return a category item specified by identifier.

Parameters:

identifier - The identifier of the category item to be returned.

Returns:

The CategoryItem object for the given identifier.

Throws:

ItemNotFoundException - if the collection does not contain the given item.

CumulusException - on other errors.

getCategoryItemByID

public CategoryItem getCategoryItemByID(int catalogID,
                               int categoryID)
                                 throws ItemNotFoundException,
                                        CumulusException

Return a category item specified by catalog ID and item ID. This method overwrites the base class method by returning a CategoryItem instance instead of an Item instance. This method returns the same result as MultiItemCollection.getItemByID(int, int) but is declared to return a CategoryItem.

Parameters:

catalogID - The ID of the item's catalog to be returned.

categoryID - The ID of the category item to be returned.

Returns:

The CategoryItem object for the given catalog ID and item ID.

Throws:

ItemNotFoundException - if the collection does not contain the given item.

CumulusException - on other errors.

getCategoryItemCollection

public CategoryItemCollection getCategoryItemCollection(int catalogID)
                                                 throws InvalidArgumentException,
                                                        CumulusException

Return the contained CategoryItemCollection for the given catalog ID. This method overwrites the base class method by returning a CategoryItemCollection instance instead of an ItemCollection instance. This method returns the same result as MultiItemCollection.getItemCollection(int) but is declared to return a RecordItemCollection.

Parameters:

catalogID - The catalog ID of the collection to be returned.

Returns:

The CategoryItemCollection contained in this collection that comes from the given catalog.

Throws:

InvalidArgumentException - if the catalog ID is not valid

CumulusException - on other errors

See Also:

MultiItemCollection.addItemCollection(ItemCollection), MultiItemCollection.getItemCollection(int)

iterator

public java.util.Iterator<Item> iterator()

Description copied from class: MultiItemCollection

Return an iterator that iterates over all items in this collection. This allows you to use Java 5 for-each loops that simplify your source code:

 for (Item item : itemCollection)
 {
    // use the item
 }
 

The iterator returned allows you to remove an item consistently:

 Iterator  it = iterator ();
 while (it.hasNext ())
 {
     Item item = it.next ();
     if (!item.hasValue (GUID.UID_REC_LABEL))
     {
         it.remove ();
     }
 }
 

Specified by:

iterator in interface java.lang.Iterable<Item>

Overrides:

iterator in class MultiItemCollection

Returns:

An iterator for all items in this collection.