com.canto.cumulus

Class CategoryItem

java.lang.Object

com.canto.cumulus.Item

com.canto.cumulus.CategoryItem

public class CategoryItem
extends Item

This class represents a category of a Cumulus catalog.

Since:

8.0

See Also:

CategoryItemCollection

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canBeChildOf(CategoryItem potentialParentCategoryItem) Return whether this category item could be made a sub-category of the given category item.
CategoryItem	createCategoryItem(java.lang.String name) Create a sub-category for this category item with a given name.
CategoryItem	createCategoryItems(java.lang.String categoryTreePath) Create category items along the given path and return the bottom-most category item.
CategoryItem	createDirectoryCategoryItem(int volID, int dirID, java.lang.String name) Create a new category item that represents a Mac OS directory on disk.
CategoryItem	createPathDirectoryCategoryItem(java.lang.String path, java.lang.String name) Create a new category item that represents a Windows directory on disk.
CategoryItem	createRelatedCategoryItem(CategoryItem original, java.lang.String name) Create a related category item for the given original category.
CategoryItem	createURLDirectoryCategoryItem(java.lang.String URL, java.lang.String name) Create a new category item that represents a URL or Unix directory on disk.
void	deleteItem() delete this category item from the catalog.
CategoryItemCollection	getCategoryItemCollection() Return the collection object that this category item comes from.
java.lang.String	getCategoryTreePath() Return the path to this category item in the hierarchy.
java.lang.String	getCategoryTreePath(java.util.Locale locale) Return the path to this category item in the hierarchy using the localized category names.
java.util.List<java.lang.Integer>	getCategoryTreePathIDs() Returns the category tree hierarchy as list of IDs with the top most parent first.
java.lang.String	getDisplayString() Return a string representation of this category item using the current locale.
java.lang.String	getDisplayString(int languageID) Returns a string representation of this category item for the given language.
java.lang.String	getDisplayString(java.util.Locale locale) Returns a string representation of this category item for the given locale.
CategoryItem	getFirstChildCategoryItem() Get the first sub-category item for this category.
boolean	getHasSubCategories() Return whether this category item has sub-categories.
int	getLevel() Return the level of this category item in the category tree hierarchy.
CategoryItem	getNextSiblingCategoryItem() Get the next sibling category of this category item.
int	getNumberOfAssignedRecords() Get the number of records assigned to this category item.
int	getNumberOfAssignedRecords(java.util.EnumSet<FindFlag> flags) Get the number of records assigned to this category item according to the flags specified.
CategoryItem	getOriginalCategory() Return the category item representing the original category for this related category.
CategoryItem	getParentCategoryItem() Get the category item that contains this category as a sub-category making it a parent category for this category.
java.util.List<java.lang.Integer>	getRelatedCategoryIDs() Get a list of IDs of all categories that are related categories to this category.
java.util.List<java.lang.Integer>	getSubCategoryIDs() Get a list of the IDs of all sub-categories of this category item.
java.util.Set<java.lang.Integer>	getSubCategoryIDs(boolean recursive) Get a list of the IDs of all sub-categories of this category item.
CategoryType	getType() Get the type of this category item.
boolean	isDisabled() Return whether this category is disabled.
java.lang.String	toString() Return a string representation of this category item.

Methods inherited from class com.canto.cumulus.Item

applyPermissionTemplate, checkin, checkin, checkout, clearModifiedValue, clearValue, convertAsset, copyAsset, deleteItem, deleteItem, doAssetAction, doAssetAction, doAssetAction, equals, getAssetReferenceValue, getAssetXRefValue, getBinaryValue, getBooleanValue, getCatalogID, getCumulusSession, getDataSizeValue, getDateOnlyValue, getDateValue, getDoubleValue, getID, getIntValue, getItemCollection, getItemIdentifier, getLabelValue, getLengthInInchValue, getLongValue, getPictureValue, getRatingValue, getResolutionValue, getStringEnumValue, getStringValue, getStringValue, getTableValue, getTimeOnlyValue, getUserUIDValue, getVocabularyValue, hashCode, hasValue, isCheckedOut, logUsage, matchesQuery, moveAsset, renameAsset, rollback, save, save, setAssetReferenceValue, setAssetXRefValue, setBinaryValue, setBooleanValue, setDataSizeValue, setDateOnlyValue, setDateValue, setDoubleValue, setIntValue, setLabelValue, setLengthInInchValue, setLongValue, setPictureValue, setRatingValue, setResolutionValue, setStringEnumValue, setStringValue, setTimeOnlyValue, setVocabularyValue, undoCheckout, update, update, updateAsset, updateAssetReference, updateAssetReference, updateFormulaFields, validate

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getCategoryItemCollection

public CategoryItemCollection getCategoryItemCollection()

Return the collection object that this category item comes from.

Returns:

The collection that this category item comes from.

deleteItem

public void deleteItem()
                throws PermissionDeniedException,
                       CumulusException

delete this category item from the catalog.

Overrides:

deleteItem in class Item

Throws:

PermissionDeniedException - if you do not have the necessary permission for this operation

CumulusException - on other errors

See Also:

Item.deleteItem(boolean)

getHasSubCategories

public boolean getHasSubCategories()

Return whether this category item has sub-categories.

Returns:

true if this category item has any sub-categories in the hierarchy. false otherwise.

Since:

8.1

See Also:

getSubCategoryIDs()

getSubCategoryIDs

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

Get a list of the IDs of all sub-categories of this category item. The list is sorted by the sorting criteria of the generating CategoryItemCollection.

Returns:

A list of sub-category Ids.

See Also:

getHasSubCategories()

getSubCategoryIDs

public java.util.Set<java.lang.Integer> getSubCategoryIDs(boolean recursive)

Get a list of the IDs of all sub-categories of this category item.

Returns:

A set of sub-category Ids.

Since:

9.0

See Also:

getHasSubCategories()

getOriginalCategory

public CategoryItem getOriginalCategory()
                                 throws CumulusException

Return the category item representing the original category for this related category. A related category is a category that only points to another category called the "original."

Returns:

The original of this related category.

Throws:

CumulusException - if this category item is not a related category

getRelatedCategoryIDs

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

Get a list of IDs of all categories that are related categories to this category.

Returns:

The IDs of all related categories where this category item is their "original."

getParentCategoryItem

public CategoryItem getParentCategoryItem()

Get the category item that contains this category as a sub-category making it a parent category for this category. If this category item it at top-level this method returns null.

Returns:

The category item of the parent category.

getNextSiblingCategoryItem

public CategoryItem getNextSiblingCategoryItem()

Get the next sibling category of this category item. A sibling category is a category item that has the same parent category. Using getFirstChildCategoryItem() and getNextSiblingCategoryItem() you can traverse the whole tree of category items very efficiently. Both methods return null if there is no further category item.

Returns:

The next sibling category item for this category item.

See Also:

getFirstChildCategoryItem()

getFirstChildCategoryItem

public CategoryItem getFirstChildCategoryItem()

Get the first sub-category item for this category. Using getFirstChildCategoryItem() and getNextSiblingCategoryItem() you can traverse the whole tree of category items very efficiently. Both methods return null if there is no further category item.

Returns:

The first sub-category item of this category item. This method returns null if this category does not have any sub-categories.

See Also:

getNextSiblingCategoryItem()

canBeChildOf

public boolean canBeChildOf(CategoryItem potentialParentCategoryItem)

Return whether this category item could be made a sub-category of the given category item.

Parameters:

potentialParentCategoryItem - The category item to check

Returns:

true if this category item can be made a sub-category of the given potential parent.

getType

public CategoryType getType()

Get the type of this category item.

Returns:

The type of this category item.

isDisabled

public boolean isDisabled()

Return whether this category is disabled. A disabled category is one that is added to the category tree after a search only for giving the categories found a context in the category tree. They are not part of the search result. The user can not use a disabled category other than expanding/collapsing it to display/hide the sub-categories.

Returns:

true if this category is disabled, false otherwise.

getLevel

public int getLevel()

Return the level of this category item in the category tree hierarchy. The top-level category has a level of 0.

Returns:

The level of this category item in the hierarchy.

getCategoryTreePath

public java.lang.String getCategoryTreePath()

Return the path to this category item in the hierarchy.

Returns:

The path to this category item in the category tree hierarchy.

See Also:

CategoryItemCollection.getCategoryTreePath(java.util.List)

getCategoryTreePath

public java.lang.String getCategoryTreePath(java.util.Locale locale)

Return the path to this category item in the hierarchy using the localized category names.

Parameters:

locale - locale you want to get names for

Returns:

The path to this category item in the category tree hierarchy.

Since:

8.6

See Also:

getCategoryTreePath(), getCategoryTreePathIDs(), CategoryItemCollection.getCategoryTreePath(java.util.List), CategoryItemCollection.getCategoryTreeItemIDs(int, int, java.util.Set, boolean)

getCategoryTreePathIDs

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

Returns the category tree hierarchy as list of IDs with the top most parent first.

Returns:

category tree hierarchy as list of IDs

Since:

8.5.1

getNumberOfAssignedRecords

public int getNumberOfAssignedRecords()

Get the number of records assigned to this category item.

Returns:

The number of records assigned to this category item.

See Also:

CategoryItemCollection.getNumberOfAssignedRecords(java.util.Set, java.util.EnumSet)

getNumberOfAssignedRecords

public int getNumberOfAssignedRecords(java.util.EnumSet<FindFlag> flags)

Get the number of records assigned to this category item according to the flags specified.

Parameters:

flags - The flags that control how the assignments are calculated.

Returns:

The number of records assigned to this category item.

See Also:

CategoryItemCollection.getNumberOfAssignedRecords(java.util.Set, java.util.EnumSet)

toString

public java.lang.String toString()

Return a string representation of this category item.

Overrides:

toString in class Item

Returns:

Return a string representation of this category item (currently the category name).

getDisplayString

public java.lang.String getDisplayString()

Return a string representation of this category item using the current locale.

Overrides:

getDisplayString in class Item

Returns:

Return a string representation of this category item (currently the category name).

Since:

8.5.2

See Also:

getDisplayString(java.util.Locale)

getDisplayString

public java.lang.String getDisplayString(java.util.Locale locale)

Returns a string representation of this category item for the given locale.

Overrides:

getDisplayString in class Item

Parameters:

locale - the locale to use for the category name. If that language is not available the field value for the field "Category Name" is used instead.

Returns:

string representation of this category item for the given locale

Since:

8.5.2

getDisplayString

public java.lang.String getDisplayString(int languageID)

Returns a string representation of this category item for the given language.

Overrides:

getDisplayString in class Item

Parameters:

languageID - the language to use for the category name. If that language is not available the field value for the field "Category Name" is used instead.

Returns:

string representation of this category item for the given language

Since:

8.6

createCategoryItem

public CategoryItem createCategoryItem(java.lang.String name)
                                throws PermissionDeniedException,
                                       CumulusException

Create a sub-category for this category item with a given name. This created category item is implicitly saved to respect the category tree hierarchy. You only need to call Item.save() to save additional changes to this category item.
To create a category item which is not yet saved call ItemCollection.createItem() and set the hierarchy fields like GUID.UID_CAT_PARENT_IDmanually.

Parameters:

name - The name of the newly created category item.

Returns:

The newly created category item.

Throws:

PermissionDeniedException - if you do not have the permissions necessary for this operation.

CumulusException - on other errors.

createCategoryItems

public CategoryItem createCategoryItems(java.lang.String categoryTreePath)
                                 throws PermissionDeniedException,
                                        CumulusException

Create category items along the given path and return the bottom-most category item. This method returns the category item even if it did not have to create any new category item. All category items of the given path that were not existent will be created and implicitly saved to respect the category tree hierarchy.

Parameters:

categoryTreePath - The path that describes the categories to be created.

Returns:

The category item that the given path specifies.

Throws:

PermissionDeniedException - if you do not have the permissions necessary for this operation.

CumulusException - on other errors.

createRelatedCategoryItem

public CategoryItem createRelatedCategoryItem(CategoryItem original,
                                     java.lang.String name)
                                       throws PermissionDeniedException,
                                              CumulusException

Create a related category item for the given original category. This created category item is implicitly saved to respect the category tree hierarchy. You only need to call Item.save() to save additional changes to this category item.

Parameters:

original - The original category item that the newly created related category item should refer to.

name - The name of the newly created category item.

Returns:

The newly created category item.

Throws:

PermissionDeniedException - if you do not have the permissions necessary for this operation.

CumulusException - on other errors.

createDirectoryCategoryItem

public CategoryItem createDirectoryCategoryItem(int volID,
                                       int dirID,
                                       java.lang.String name)
                                         throws PermissionDeniedException,
                                                CumulusException

Create a new category item that represents a Mac OS directory on disk. This created category item is implicitly saved to respect the category tree hierarchy. You only need to call Item.save() to save additional changes to this category item.

Parameters:

volID - The ID of the volume that this category item represents.

dirID - The ID of the directory that this category item represents.

name - The name of the newly created category item.

Returns:

The newly created category item.

Throws:

PermissionDeniedException - if you do not have the permissions necessary for this operation.

CumulusException - on other errors.

createPathDirectoryCategoryItem

public CategoryItem createPathDirectoryCategoryItem(java.lang.String path,
                                           java.lang.String name)
                                             throws PermissionDeniedException,
                                                    CumulusException

Create a new category item that represents a Windows directory on disk. This created category item is implicitly saved to respect the category tree hierarchy. You only need to call Item.save() to save additional changes to this category item.

Parameters:

path - The path of the directory that this category item represents.

name - The name of the newly created category item.

Returns:

The newly created category item.

Throws:

PermissionDeniedException - if you do not have the permissions necessary for this operation.

CumulusException - on other errors.

createURLDirectoryCategoryItem

public CategoryItem createURLDirectoryCategoryItem(java.lang.String URL,
                                          java.lang.String name)
                                            throws PermissionDeniedException,
                                                   CumulusException

Create a new category item that represents a URL or Unix directory on disk. This created category item is implicitly saved to respect the category tree hierarchy. You only need to call Item.save() to save additional changes to this category item.

Parameters:

URL - The URL or Unix path of the directory that this category item represents.

name - The name of the newly created category item.

Returns:

The newly created category item.

Throws:

PermissionDeniedException - if you do not have the permissions necessary for this operation.

CumulusException - on other errors.