com.canto.cumulus.prefs

Class BaseManager

java.lang.Object

com.canto.cumulus.prefs.BaseManager

Direct Known Subclasses:

AssetAction, AssetActionProcessor, AssetHandlingSet, AssetHandlingSetModuleEntry, AssetHandlingSetWorkflow, AssetRelation, AuthenticationManager.ServerSettings, BackupJob, BackupJobConfiguration, BackupJobStatistics, CatalogField, CatalogFieldEnumListSort, CatalogFieldEnumListSortOrders, CatalogFieldEnumListValueContainer, CatalogFieldEnumListValueContainerCoreValue, CatalogFieldValidatorConfiguration, CatalogInfo, CatalogLinkedField, CatalogLiveFilter, CatalogLiveFilterQuery, CatalogTemplate, CatalogTemplateLayout, CategoryViewSetTable, CollectionSet, CropTemplate, CustomData, DBMirroring, EmailClass, EmailClassPlaceholder, EmailClassTemplate, EmailLayout, EmailLayoutAttachment, EntityRestrictor, FieldValue, FilterListModuleEntry, FontDetail, FormatListModuleEntry, ListPackManager, MetadataTemplate, MetadataTemplateEntry, MetadataTemplateTable, ModulePreferences, OpenCatalogClientGroup, PermissionsListTable, PermissionTemplate, PrintSet, PrintSetAdvanced, PrintSetDocumentBlib, PrintSetTabStop, Product, Query, QueryCondition, QueryConditionBase, RecordField, RecordFieldOptions, RecordFilter, RecordView, RecordViewSetTable, ReportSet, Role, RolePermissions, SchedulerJob, SchedulerJobConfiguration, SchedulerJobStatistics, ServerPermissions, ServerRoot, ServerSettings, SolrIntegrationConfiguration, TableConfigurations, TableSubscriptionConfiguration, TableValidatorConfiguration, User, User, UserFieldDefinition, UserFieldDefinition.FieldNames, UserFieldDefinition.StringEnums, UserModuleLRU, WeakFieldReference, Workflow, WorkflowActivities, WorkflowActivity, WorkflowState, WorkflowStates, Workspace

public class BaseManager
extends java.lang.Object

This class manages all the base work for preferences access. Usually one doesn't work with this class but one of the subclasses instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseManager.PackEntryChangeListener
static class	BaseManager.RegistryEntry This class manages a single entry of the tree structure of the cumulus preferences.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_EJP
static int	TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(BaseManager.PackEntryChangeListener changeListener)
void	addChangeListener(int key, BaseManager.PackEntryChangeListener changeListener)
void	addGlobalChangeListener(Saver.ChangeListener changeListener)
void	addPackListener(PackListener listener) Adds a pack listener for the pack behind this class to get a notification when the pack behind this class shall be saved.
void	forgetPush() This deletes the state on top of the stack.
JPack	getPack() Saves all changes back into the pack and returns that pack.
boolean	isShared()
void	popPack() This overrides the current state of this class with the state on top of the stack.
void	pushPack() This stores the current state of this class on the stack.
void	removeChangeListener(BaseManager.PackEntryChangeListener changeListener)
void	removeChangeListener(int key, BaseManager.PackEntryChangeListener changeListener)
void	removeGlobalChangeListener(Saver.ChangeListener changeListener)
void	removePackListener(PackListener listener) Removes listener previously registered with addPackListener(PackListener).
void	save() Saves the changes below this class back to the server.
void	save(boolean forceSave) Overrides the internal changes structure.
java.lang.String	toString() Returns a XML representation of this class.
void	writeAsXML(java.io.Writer writer) Writes the state of this pack as XML into the given writer instance.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NATIVE

public static final int TYPE_NATIVE

See Also:

Constant Field Values

TYPE_EJP

public static final int TYPE_EJP

See Also:

Constant Field Values

Method Detail

pushPack

public void pushPack()

This stores the current state of this class on the stack.

See Also:

popPack(), forgetPush()

popPack

public void popPack()

This overrides the current state of this class with the state on top of the stack.

See Also:

pushPack()

forgetPush

public void forgetPush()

This deletes the state on top of the stack.

See Also:

pushPack()

save

public void save()

Saves the changes below this class back to the server.

save

public void save(boolean forceSave)

Overrides the internal changes structure. Only for internal use!

Parameters:

forceSave - true if saving should be forced

addPackListener

public void addPackListener(PackListener listener)

Adds a pack listener for the pack behind this class to get a notification when the pack behind this class shall be saved.

Parameters:

listener - the listener to register

removePackListener

public void removePackListener(PackListener listener)

Removes listener previously registered with addPackListener(PackListener).

Parameters:

listener - the listener to remove

getPack

public JPack getPack()

Saves all changes back into the pack and returns that pack.

Returns:

the pack containing all changes.

isShared

public boolean isShared()

writeAsXML

public void writeAsXML(java.io.Writer writer)
                throws java.io.IOException

Writes the state of this pack as XML into the given writer instance. This does not include the changes made.

Parameters:

writer - to writer to write the XML to

Throws:

java.io.IOException - in case of an error writing the XML

toString

public java.lang.String toString()

Returns a XML representation of this class.

Overrides:

toString in class java.lang.Object

Returns:

XML representation

addGlobalChangeListener

public void addGlobalChangeListener(Saver.ChangeListener changeListener)

removeGlobalChangeListener

public void removeGlobalChangeListener(Saver.ChangeListener changeListener)

addChangeListener

public void addChangeListener(BaseManager.PackEntryChangeListener changeListener)

removeChangeListener

public void removeChangeListener(BaseManager.PackEntryChangeListener changeListener)

addChangeListener

public void addChangeListener(int key,
                     BaseManager.PackEntryChangeListener changeListener)

removeChangeListener

public void removeChangeListener(int key,
                        BaseManager.PackEntryChangeListener changeListener)