com.canto.cumulus.prefs

Class CollectionSetList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.CollectionSetList

All Implemented Interfaces:

ItemManager

public class CollectionSetList
extends ListPackManager
implements ItemManager

This class manages a list of collection sets. This can either be a list of server collection sets from calling ServerSettings.getCollectionsList() or a list of user collection sets from calling User.getCollectionsList().

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
Item	copy(java.lang.String newID, Item src, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given item with the specified UID.
CollectionSet	create(java.lang.String newName, CollectionType collectionType, MultiRecordItemCollection multiRecordItemCollection) Creates a new collection set using the given name.
CollectionSet	create(java.lang.String collectionSetName, CollectionType collectionType, java.util.Set<Catalog> catalogs, java.lang.String query, java.util.EnumSet<FindFlag> flags, java.util.Locale locale) Creates a new query based collection set using the given name and type (supported type is CollectionType.UPLOAD_COLLECTION).
void	delete(CollectionSet collectionSetToDelete) Deletes the given collection set.
void	delete(Item item) Deletes the given item.
CollectionSet	getCollectionSet(java.lang.String name) Returns the collection set for the given name.
java.util.List<java.lang.String>	getCollectionSetNames() Return a list of collection set names of this instance.
Item	getItem(java.lang.String id) Returns the item with the specified UID.
java.util.Collection<java.lang.String>	getItemIDs() Returns the list of item UIDs that are available by this manager instance.
int	getItemType() Returns the item type for the items of this manager.
java.lang.String	getPath() Returns the path for this item manager instance.
void	rename(java.lang.String newID, Item item, boolean keepDisplayNames, boolean keepDescriptions) Renames the given item to the new UID.
void	setAsDefault(Item item) Sets the given item to be the default item.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getCollectionSetNames

public java.util.List<java.lang.String> getCollectionSetNames()

Return a list of collection set names of this instance.

Returns:

a list of String

create

public CollectionSet create(java.lang.String newName,
                   CollectionType collectionType,
                   MultiRecordItemCollection multiRecordItemCollection)
                     throws CumulusException,
                            javax.naming.InvalidNameException

Creates a new collection set using the given name.

Parameters:

newName - the name of the new set

collectionType - the type of the new collection set

multiRecordItemCollection - the collection to store in the new collection set

Returns:

the new set

Throws:

CumulusException - in case of an error

javax.naming.InvalidNameException - in case of an invalid or already used name

create

public CollectionSet create(java.lang.String collectionSetName,
                   CollectionType collectionType,
                   java.util.Set<Catalog> catalogs,
                   java.lang.String query,
                   java.util.EnumSet<FindFlag> flags,
                   java.util.Locale locale)
                     throws CumulusException,
                            javax.naming.InvalidNameException

Creates a new query based collection set using the given name and type (supported type is CollectionType.UPLOAD_COLLECTION).

Parameters:

collectionSetName - the name of the new set

collectionType - type of the collection to create

catalogs - Catalog instances referenced in the query string

query - the query to execute when opening this collection

flags - The set of find flags to use for executing the query, see FindFlag

locale - Locale to use when parsing locale dependent string values or null for the default locale

Returns:

the new set

Throws:

CumulusException - in case of an error

javax.naming.InvalidNameException - in case of an invalid or already used name

Since:

9.0

delete

public void delete(CollectionSet collectionSetToDelete)
            throws CumulusException

Deletes the given collection set.

Parameters:

collectionSetToDelete - the set to delete

Throws:

CumulusException - in case of an error

getCollectionSet

public CollectionSet getCollectionSet(java.lang.String name)

Returns the collection set for the given name.

Parameters:

name - the name of the set to return

Returns:

the set or null if not found

copy

public Item copy(java.lang.String newID,
        Item src,
        boolean copyDisplayNames,
        boolean copyDescriptions)
          throws javax.naming.InvalidNameException,
                 CumulusException

Duplicates the given item with the specified UID.

Specified by:

copy in interface ItemManager

Parameters:

newID - the UID of the new item

src - the item to copy

copyDisplayNames - true if display names should be copied as well

copyDescriptions - true if descriptions should be copied as well

Returns:

the copied item instance

Throws:

javax.naming.InvalidNameException - if the name is already in use or invalid for another reason

CumulusException - in case of an error

Since:

8.6.1

delete

public void delete(Item item)
            throws CumulusException

Deletes the given item.

Specified by:

delete in interface ItemManager

Parameters:

item - the item to delete

Throws:

CumulusException - in case of an error

Since:

8.6.1

getItem

public Item getItem(java.lang.String id)

Returns the item with the specified UID.

Specified by:

getItem in interface ItemManager

Parameters:

id - the items UID to get

Returns:

the found item or null if not found

Since:

8.6.1

getItemIDs

public java.util.Collection<java.lang.String> getItemIDs()

Returns the list of item UIDs that are available by this manager instance.

Specified by:

getItemIDs in interface ItemManager

Returns:

list of item UIDs

rename

public void rename(java.lang.String newID,
          Item item,
          boolean keepDisplayNames,
          boolean keepDescriptions)
            throws javax.naming.InvalidNameException,
                   CumulusException

Renames the given item to the new UID.

Specified by:

rename in interface ItemManager

Parameters:

newID - the new item UID

item - the item to rename

keepDisplayNames - true if display names should be kept

keepDescriptions - true if descriptions should be kept

Throws:

javax.naming.InvalidNameException - in case of an invalid name

CumulusException - in case of another error

Since:

8.6.1

setAsDefault

public void setAsDefault(Item item)

Sets the given item to be the default item. This makes only sense for shared items.

Specified by:

setAsDefault in interface ItemManager

Parameters:

item - the item to be the default

Since:

8.6.1

getPath

public java.lang.String getPath()

Description copied from interface: ItemManager

Returns the path for this item manager instance.

Specified by:

getPath in interface ItemManager

Returns:

path for this item manager instance

getItemType

public int getItemType()

Description copied from interface: ItemManager

Returns the item type for the items of this manager.

Specified by:

getItemType in interface ItemManager

Returns:

item type for the items of this manager