com.canto.cumulus.prefs

Class PreferencesImpl

java.lang.Object

com.canto.cumulus.prefs.PreferencesImpl

All Implemented Interfaces:

Preferences

public class PreferencesImpl
extends java.lang.Object
implements Preferences

The Preferences object allows you to access the user preferences of Cumulus.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PreferencesImpl.ItemIDProvider
static class	PreferencesImpl.NopPackListener
static class	PreferencesImpl.SaverAdapter

Constructor Summary

Constructors

Constructor and Description
PreferencesImpl(CumulusSession session)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPreferencesChangeListener(PreferencesChangeListener preferencesChangeListener, java.lang.String listenerPath) Add a listener for preferences changes for the specified path.
AssetAction	getAssetAction(java.lang.String name) Returns the asset action with the specified name.
java.util.Collection<java.lang.String>	getAssetActionNames() Returns a collection of all asset action names available.
java.util.Collection<AssetAction>	getAssetActions() Returns a collection of all asset actions available.
AssetHandlingSet	getAssetHandlingSet(java.lang.String name) Returns the asset handling set with the specified name.
java.util.Collection<java.lang.String>	getAssetHandlingSetNames() Returns a collection of all asset handling set names available.
java.util.Collection<AssetHandlingSet>	getAssetHandlingSets() Returns a collection of all asset handling sets available.
CatalogTemplate	getCatalogTemplate(java.lang.String name) Returns the catalog template with the specified name.
java.util.Collection<java.lang.String>	getCatalogTemplateNames() Returns a collection of all catalog template names available.
java.util.Collection<Query>	getCategoryQueries() Returns a collection of all category queries available.
Query	getCategoryQuery(java.lang.String name) Returns the category query with the specified name.
java.util.Collection<java.lang.String>	getCategoryQueryNames() Returns a collection of all category query names available.
CategoryViewSet	getCategoryViewSet(java.lang.String name) Returns the category view set with the specified name.
java.util.Collection<java.lang.String>	getCategoryViewSetNames() Returns a collection of all category view set names available.
CollectionSet	getCollectionSet(java.lang.String name) Returns the collection set with the specified name.
java.util.Collection<java.lang.String>	getCollectionSetNames() Returns a collection of all collection names available.
java.util.Collection<CollectionSet>	getCollectionSets() Returns all collection sets.
CropTemplate	getCropTemplate(java.lang.String name) Returns the crop template with the specified name.
java.util.Collection<java.lang.String>	getCropTemplateNames() Returns a collection of all crop template names available.
java.util.Collection<CropTemplate>	getCropTemplates() Returns a collection of all crop templates available.
CumulusApplicationDisplayPrefs	getCumulusApplicationDisplayPrefs() Returns a read-only instance of the Cumulus application display preferences.
CumulusApplicationGeneralPrefs	getCumulusApplicationGeneralPrefs() Returns a read-only instance of the Cumulus application general preferences.
CumulusApplicationSearchPrefs	getCumulusApplicationSearchPrefs() Returns a read-only instance of the Cumulus application search preferences.
CumulusSession	getCumulusSession() Returns the current CumulusSession object.
java.lang.String	getDefaultAssetAction() Returns the default asset action name.
java.lang.String	getDefaultAssetHandlingSet() Returns the default asset handling set name.
java.lang.String	getDefaultAssetHandlingSet(java.lang.String catalogName, boolean forCataloging) Returns the name of the currently chosen Asset Handling Set for the given catalog.
java.lang.String	getDefaultCropTemplate() Returns the name of the default crop template name.
java.lang.String	getDefaultMetadataTemplate() Returns the default metadata template name.
java.lang.String	getDefaultPermissionTemplate() Returns the default permission template name.
java.lang.String	getDefaultPermissionTemplate(java.lang.String catalogName) Returns the name of the currently chosen Permission Template for the given catalog.
java.lang.String	getDefaultPrintSet() Returns the name of the default print set name.
java.lang.String	getDefaultRecordViewSet() Returns the default record view set name.
MetadataTemplate	getMetadataTemplate(java.lang.String name) Returns the metadata template with the specified name.
java.util.Collection<java.lang.String>	getMetadataTemplateNames() Returns a collection of all metadata template names available.
java.util.Collection<MetadataTemplate>	getMetadataTemplates() Returns all available metadata templates.
JPack	getModulePreferences(java.lang.String moduleUID, boolean sharedSettings) Return the general preferences for the given module.
PermissionTemplate	getPermissionTemplate(java.lang.String name) Returns the permission template with the specified name.
java.util.Collection<java.lang.String>	getPermissionTemplateNames() Returns a collection of all permission template names available.
java.util.Collection<PermissionTemplate>	getPermissionTemplates() Returns all available permission templates.
java.lang.Object	getPreferences(java.lang.String path) Returns the managing instance for the specified part of the preferences.
PrintSet	getPrintSet(java.lang.String name) Returns the print set with the specified name.
java.util.Collection<java.lang.String>	getPrintSetNames() Returns a collection of all print set names available.
java.util.Collection<PrintSet>	getPrintSets() Returns a collection of all print sets available.
Query	getQuery(java.lang.String name) Returns the record query with the specified name.
RecordFilter	getRecordFilter(java.lang.String name) Returns the record filter with the specified name.
java.util.Collection<java.lang.String>	getRecordFilterNames() Returns a collection of all record filter names available.
java.util.Collection<Query>	getRecordQueries() Returns a collection of all record queries available.
Query	getRecordQuery(java.lang.String name) Returns the record query with the specified name.
java.util.Collection<java.lang.String>	getRecordQueryNames() Returns a collection of all record query names available.
RecordViewSet	getRecordViewSet(java.lang.String name) Returns the record view set with the specified name.
java.util.Collection<java.lang.String>	getRecordViewSetNames() Returns a collection of all record view set names available.
ReportSet	getReportSet(java.lang.String name) Returns the report set with the specified name.
java.util.Collection<java.lang.String>	getReportSetNames() Returns a collection of all report set names available.
User	getUserSettings() Returns the user settings for the current user.
Workspace	getWorkspace(java.lang.String name) Returns the workspace with the specified name.
java.util.Collection<java.lang.String>	getWorkspaceNames() Returns a collection of all workspaces names available.
void	removePreferencesChangeListener(PreferencesChangeListener preferencesChangeListener, java.lang.String listenerPath) Removes a listener for preferences changes for the specified path.
static <T extends Item> java.util.List<T>	restrictItemsToCatalog(java.util.Collection<T> items, MultiItemCollection multiItemCollection, PreferencesImpl.ItemIDProvider itemIDProvider)
void	setItemSharing(Item item, ItemManager itemManagerOld, ItemManager itemManagerNew) Set the sharing flag for the given item.
void	setItemSharing(java.lang.String itemID, ItemManager itemManagerOld, ItemManager itemManagerNew) Set the sharing flag for the item with the given id.
void	setModulePreferences(java.lang.String moduleUID, boolean sharedSettings, JPack preferencesPack) Sets the general preferences for the given module.
void	writePreferencesForLocalUser() Writes all available preferences to the local preferences store.

Methods inherited from class java.lang.Object

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

Constructor Detail

PreferencesImpl

public PreferencesImpl(CumulusSession session)

Method Detail

getCumulusSession

public CumulusSession getCumulusSession()

Returns the current CumulusSession object.

Specified by:

getCumulusSession in interface Preferences

Returns:

The current CumulusSession object.

getPreferences

public java.lang.Object getPreferences(java.lang.String path)

Description copied from interface: Preferences

Returns the managing instance for the specified part of the preferences. Please see the package description for more information.

Specified by:

getPreferences in interface Preferences

Parameters:

path - the path to get the preferences for.

Returns:

the object representing the preferences or null

getDefaultPermissionTemplate

public java.lang.String getDefaultPermissionTemplate(java.lang.String catalogName)

Description copied from interface: Preferences

Returns the name of the currently chosen Permission Template for the given catalog. This reads the user settings for the current user.

Specified by:

getDefaultPermissionTemplate in interface Preferences

Parameters:

catalogName - name of the catalog to find the corresponding permission template

Returns:

name of the corresponding permission template

getDefaultAssetHandlingSet

public java.lang.String getDefaultAssetHandlingSet(java.lang.String catalogName,
                                          boolean forCataloging)

Description copied from interface: Preferences

Returns the name of the currently chosen Asset Handling Set for the given catalog. This reads the user settings for the current user.

Specified by:

getDefaultAssetHandlingSet in interface Preferences

Parameters:

catalogName - name of the catalog to find the corresponding asset handling set

forCataloging - if true the asset handling set for cataloging will be returned otherwise the asset handling set for asset access

Returns:

name of the corresponding asset handling set

getCumulusApplicationGeneralPrefs

public CumulusApplicationGeneralPrefs getCumulusApplicationGeneralPrefs()

Description copied from interface: Preferences

Returns a read-only instance of the Cumulus application general preferences.

Specified by:

getCumulusApplicationGeneralPrefs in interface Preferences

Returns:

read-only instance of the Cumulus application general preferences

getCumulusApplicationDisplayPrefs

public CumulusApplicationDisplayPrefs getCumulusApplicationDisplayPrefs()

Description copied from interface: Preferences

Returns a read-only instance of the Cumulus application display preferences.

Specified by:

getCumulusApplicationDisplayPrefs in interface Preferences

Returns:

read-only instance of the Cumulus application display preferences

getCumulusApplicationSearchPrefs

public CumulusApplicationSearchPrefs getCumulusApplicationSearchPrefs()

Description copied from interface: Preferences

Returns a read-only instance of the Cumulus application search preferences.

Specified by:

getCumulusApplicationSearchPrefs in interface Preferences

Returns:

read-only instance of the Cumulus application search preferences

getDefaultAssetHandlingSet

public java.lang.String getDefaultAssetHandlingSet()

Description copied from interface: Preferences

Returns the default asset handling set name.

Specified by:

getDefaultAssetHandlingSet in interface Preferences

Returns:

default asset handling set name

getAssetHandlingSetNames

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

Description copied from interface: Preferences

Returns a collection of all asset handling set names available.

Specified by:

getAssetHandlingSetNames in interface Preferences

Returns:

collection of all asset handling set names available

getAssetHandlingSets

public java.util.Collection<AssetHandlingSet> getAssetHandlingSets()

Description copied from interface: Preferences

Returns a collection of all asset handling sets available.

Specified by:

getAssetHandlingSets in interface Preferences

Returns:

collection of all asset handling sets available

getAssetHandlingSet

public AssetHandlingSet getAssetHandlingSet(java.lang.String name)

Description copied from interface: Preferences

Returns the asset handling set with the specified name.

Specified by:

getAssetHandlingSet in interface Preferences

Parameters:

name - the name of the set to get

Returns:

the set instance or null if not found

getDefaultRecordViewSet

public java.lang.String getDefaultRecordViewSet()

Description copied from interface: Preferences

Returns the default record view set name.

Specified by:

getDefaultRecordViewSet in interface Preferences

Returns:

default record view set name

getRecordViewSetNames

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

Description copied from interface: Preferences

Returns a collection of all record view set names available.

Specified by:

getRecordViewSetNames in interface Preferences

Returns:

collection of all record view set names available

getRecordViewSet

public RecordViewSet getRecordViewSet(java.lang.String name)

Description copied from interface: Preferences

Returns the record view set with the specified name.

Specified by:

getRecordViewSet in interface Preferences

Parameters:

name - the name of the set to get

Returns:

the set instance or null if not found

getRecordFilter

public RecordFilter getRecordFilter(java.lang.String name)

Description copied from interface: Preferences

Returns the record filter with the specified name.

Specified by:

getRecordFilter in interface Preferences

Parameters:

name - the name of the filter to get

Returns:

the filter instance or null if not found

getCategoryViewSet

public CategoryViewSet getCategoryViewSet(java.lang.String name)

Description copied from interface: Preferences

Returns the category view set with the specified name.

Specified by:

getCategoryViewSet in interface Preferences

Parameters:

name - the name of the set to get

Returns:

the set instance or null if not found

getCategoryViewSetNames

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

Description copied from interface: Preferences

Returns a collection of all category view set names available.

Specified by:

getCategoryViewSetNames in interface Preferences

Returns:

collection of all category view set names available

getDefaultAssetAction

public java.lang.String getDefaultAssetAction()

Description copied from interface: Preferences

Returns the default asset action name.

Specified by:

getDefaultAssetAction in interface Preferences

Returns:

the name of the current default asset action

Since:

6.5.1

getAssetActionNames

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

Description copied from interface: Preferences

Returns a collection of all asset action names available.

Specified by:

getAssetActionNames in interface Preferences

Returns:

collection of all asset action names available

getAssetActions

public java.util.Collection<AssetAction> getAssetActions()

Description copied from interface: Preferences

Returns a collection of all asset actions available.

Specified by:

getAssetActions in interface Preferences

Returns:

collection of all asset actions available

getAssetAction

public AssetAction getAssetAction(java.lang.String name)

Description copied from interface: Preferences

Returns the asset action with the specified name.

Specified by:

getAssetAction in interface Preferences

Parameters:

name - the name of the action to get

Returns:

action instance or null if not found

getDefaultMetadataTemplate

public java.lang.String getDefaultMetadataTemplate()

Description copied from interface: Preferences

Returns the default metadata template name.

Specified by:

getDefaultMetadataTemplate in interface Preferences

Returns:

default metadata template name

getDefaultPermissionTemplate

public java.lang.String getDefaultPermissionTemplate()

Description copied from interface: Preferences

Returns the default permission template name.

Specified by:

getDefaultPermissionTemplate in interface Preferences

Returns:

default permission template name or null if not found

getMetadataTemplateNames

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

Description copied from interface: Preferences

Returns a collection of all metadata template names available.

Specified by:

getMetadataTemplateNames in interface Preferences

Returns:

collection of all metadata template names available

getMetadataTemplates

public java.util.Collection<MetadataTemplate> getMetadataTemplates()

Description copied from interface: Preferences

Returns all available metadata templates.

Specified by:

getMetadataTemplates in interface Preferences

Returns:

all available metadata templates

getCatalogTemplateNames

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

Description copied from interface: Preferences

Returns a collection of all catalog template names available.

Specified by:

getCatalogTemplateNames in interface Preferences

Returns:

collection of all catalog template names available

getCatalogTemplate

public CatalogTemplate getCatalogTemplate(java.lang.String name)

Description copied from interface: Preferences

Returns the catalog template with the specified name.

Specified by:

getCatalogTemplate in interface Preferences

Parameters:

name - the name of the template to get

Returns:

the template instance or null if not found

getCollectionSet

public CollectionSet getCollectionSet(java.lang.String name)

Description copied from interface: Preferences

Returns the collection set with the specified name.

Specified by:

getCollectionSet in interface Preferences

Parameters:

name - the name of the set to get

Returns:

the set instance or null if not found

getCollectionSets

public java.util.Collection<CollectionSet> getCollectionSets()

Description copied from interface: Preferences

Returns all collection sets.

Specified by:

getCollectionSets in interface Preferences

Returns:

all set instances or an empty collection if no set could be found

getCollectionSetNames

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

Description copied from interface: Preferences

Returns a collection of all collection names available.

Specified by:

getCollectionSetNames in interface Preferences

Returns:

collection of all collection names available

getRecordQuery

public Query getRecordQuery(java.lang.String name)

Description copied from interface: Preferences

Returns the record query with the specified name.

Specified by:

getRecordQuery in interface Preferences

Parameters:

name - the name of the query to get

Returns:

query instance or null if not found

getRecordQueries

public java.util.Collection<Query> getRecordQueries()

Description copied from interface: Preferences

Returns a collection of all record queries available.

Specified by:

getRecordQueries in interface Preferences

Returns:

collection of all record queries available

getCategoryQueries

public java.util.Collection<Query> getCategoryQueries()

Description copied from interface: Preferences

Returns a collection of all category queries available.

Specified by:

getCategoryQueries in interface Preferences

Returns:

collection of all category queries available

getRecordQueryNames

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

Description copied from interface: Preferences

Returns a collection of all record query names available.

Specified by:

getRecordQueryNames in interface Preferences

Returns:

collection of all record query names available

getCategoryQueryNames

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

Description copied from interface: Preferences

Returns a collection of all category query names available.

Specified by:

getCategoryQueryNames in interface Preferences

Returns:

collection of all category query names available

getDefaultPrintSet

public java.lang.String getDefaultPrintSet()

Description copied from interface: Preferences

Returns the name of the default print set name.

Specified by:

getDefaultPrintSet in interface Preferences

Returns:

default print set name

getPrintSetNames

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

Description copied from interface: Preferences

Returns a collection of all print set names available.

Specified by:

getPrintSetNames in interface Preferences

Returns:

collection of all print set names available

getPrintSet

public PrintSet getPrintSet(java.lang.String name)

Description copied from interface: Preferences

Returns the print set with the specified name.

Specified by:

getPrintSet in interface Preferences

Parameters:

name - the name of the set to get

Returns:

the set instance or null if not found

getPrintSets

public java.util.Collection<PrintSet> getPrintSets()

Description copied from interface: Preferences

Returns a collection of all print sets available.

Specified by:

getPrintSets in interface Preferences

Returns:

collection of all print sets available

getDefaultCropTemplate

public java.lang.String getDefaultCropTemplate()

Description copied from interface: Preferences

Returns the name of the default crop template name.

Specified by:

getDefaultCropTemplate in interface Preferences

Returns:

default crop template name

getCropTemplateNames

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

Description copied from interface: Preferences

Returns a collection of all crop template names available.

Specified by:

getCropTemplateNames in interface Preferences

Returns:

collection of all crop template names available

getCropTemplate

public CropTemplate getCropTemplate(java.lang.String name)

Description copied from interface: Preferences

Returns the crop template with the specified name.

Specified by:

getCropTemplate in interface Preferences

Parameters:

name - the name of the crop template to get

Returns:

the crop template instance or null if not found

getCropTemplates

public java.util.Collection<CropTemplate> getCropTemplates()

Description copied from interface: Preferences

Returns a collection of all crop templates available.

Specified by:

getCropTemplates in interface Preferences

Returns:

collection of all crop templates available

getRecordFilterNames

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

Description copied from interface: Preferences

Returns a collection of all record filter names available.

Specified by:

getRecordFilterNames in interface Preferences

Returns:

collection of all record filter names available

getPermissionTemplateNames

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

Description copied from interface: Preferences

Returns a collection of all permission template names available.

Specified by:

getPermissionTemplateNames in interface Preferences

Returns:

collection of all permission template names available

getPermissionTemplates

public java.util.Collection<PermissionTemplate> getPermissionTemplates()

Description copied from interface: Preferences

Returns all available permission templates.

Specified by:

getPermissionTemplates in interface Preferences

Returns:

all available permission templates

getPermissionTemplate

public PermissionTemplate getPermissionTemplate(java.lang.String name)

Description copied from interface: Preferences

Returns the permission template with the specified name.

Specified by:

getPermissionTemplate in interface Preferences

Parameters:

name - the name of the template to get

Returns:

the template instance or null if not found

getWorkspaceNames

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

Description copied from interface: Preferences

Returns a collection of all workspaces names available.

Specified by:

getWorkspaceNames in interface Preferences

Returns:

collection of all workspaces names available

getReportSetNames

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

Description copied from interface: Preferences

Returns a collection of all report set names available.

Specified by:

getReportSetNames in interface Preferences

Returns:

collection of all report set names available

getReportSet

public ReportSet getReportSet(java.lang.String name)

Description copied from interface: Preferences

Returns the report set with the specified name.

Specified by:

getReportSet in interface Preferences

Parameters:

name - the name of the set to get

Returns:

the set instance or null if not found

getWorkspace

public Workspace getWorkspace(java.lang.String name)

Description copied from interface: Preferences

Returns the workspace with the specified name.

Specified by:

getWorkspace in interface Preferences

Parameters:

name - the name of the workspace to get

Returns:

workspace instance or null if not found

getQuery

public Query getQuery(java.lang.String name)

Description copied from interface: Preferences

Returns the record query with the specified name.

Specified by:

getQuery in interface Preferences

Parameters:

name - the name of the record query to get

Returns:

the record query instance or null if not found

getCategoryQuery

public Query getCategoryQuery(java.lang.String name)

Description copied from interface: Preferences

Returns the category query with the specified name.

Specified by:

getCategoryQuery in interface Preferences

Parameters:

name - the name of the category query to get

Returns:

the category query instance or null if not found

getMetadataTemplate

public MetadataTemplate getMetadataTemplate(java.lang.String name)

Description copied from interface: Preferences

Returns the metadata template with the specified name.

Specified by:

getMetadataTemplate in interface Preferences

Parameters:

name - the name of the template to get

Returns:

the template instance or null if not found

getUserSettings

public User getUserSettings()

Description copied from interface: Preferences

Returns the user settings for the current user.

Specified by:

getUserSettings in interface Preferences

Returns:

the current users settings

getModulePreferences

public JPack getModulePreferences(java.lang.String moduleUID,
                         boolean sharedSettings)

Description copied from interface: Preferences

Return the general preferences for the given module.

Specified by:

getModulePreferences in interface Preferences

Parameters:

moduleUID - uid of the module to get the preferences for

sharedSettings - true for shared settings and false for user settings

Returns:

existing preferences or empty record pack

setModulePreferences

public void setModulePreferences(java.lang.String moduleUID,
                        boolean sharedSettings,
                        JPack preferencesPack)

Description copied from interface: Preferences

Sets the general preferences for the given module.

Specified by:

setModulePreferences in interface Preferences

Parameters:

moduleUID - uid of the module to set the preferences for

sharedSettings - true for shared settings and false for user settings

preferencesPack - the preferences to store

addPreferencesChangeListener

public void addPreferencesChangeListener(PreferencesChangeListener preferencesChangeListener,
                                java.lang.String listenerPath)

Description copied from interface: Preferences

Add a listener for preferences changes for the specified path. The listener gets a notification for any change in the preferences below the given path.

Specified by:

addPreferencesChangeListener in interface Preferences

Parameters:

preferencesChangeListener - the listener instance to be notified of changes

listenerPath - the path to listen for changes

removePreferencesChangeListener

public void removePreferencesChangeListener(PreferencesChangeListener preferencesChangeListener,
                                   java.lang.String listenerPath)

Description copied from interface: Preferences

Removes a listener for preferences changes for the specified path.

Specified by:

removePreferencesChangeListener in interface Preferences

Parameters:

preferencesChangeListener - the listener instance to remove

listenerPath - the path the listener to remove for

writePreferencesForLocalUser

public void writePreferencesForLocalUser()
                                  throws CumulusException

Writes all available preferences to the local preferences store. All existing local preferences will be replaced. These local preferences are used by a Cross Client. This function is only available for Cross Clients.

Throws:

CumulusException - will be thrown in case of an error.

Since:

7.0

setItemSharing

public void setItemSharing(java.lang.String itemID,
                  ItemManager itemManagerOld,
                  ItemManager itemManagerNew)

Set the sharing flag for the item with the given id.

Parameters:

itemID - id of the item to change

itemManagerOld - manager for the current sharing

itemManagerNew - manager for the new sharing

Since:

8.6

setItemSharing

public void setItemSharing(Item item,
                  ItemManager itemManagerOld,
                  ItemManager itemManagerNew)

Set the sharing flag for the given item.

Parameters:

item - item to change

itemManagerOld - manager for the current sharing

itemManagerNew - manager for the new sharing

Since:

8.6

restrictItemsToCatalog

public static <T extends Item> java.util.List<T> restrictItemsToCatalog(java.util.Collection<T> items,
                                                        MultiItemCollection multiItemCollection,
                                                        PreferencesImpl.ItemIDProvider itemIDProvider)