com.canto.cumulus.prefs

Class MetadataTemplate

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.MetadataTemplate

All Implemented Interfaces:

Item, java.lang.Iterable<MetadataTemplateEntry>

public class MetadataTemplate
extends BaseManager
implements Item, java.lang.Iterable<MetadataTemplateEntry>

This class stores the settings for a single metadata template.

See Also:

MetadataTemplatesList.getMetadataTemplate(String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetadataTemplate.ChangeCallback

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
JPack	exportSet() Exports this set into a JPack.
void	fill(Item item) Fill this template with the field values of the given item.
java.lang.String	getDescription(int languageID) Returns the description for the given language id.
java.lang.String	getDisplayName(int languageID, boolean fallbackToDefaultName) Returns the display name for the given language id.
java.lang.String	getID() Returns the UID of the item in the items namespace.
boolean	getIsDefault() Returns whether this is the default template.
MetadataTemplateEntryList	getMetadataTemplateEntryList() Returns the manager for the specific metadata template entries.
MetadataTemplateEntryList	getMetadataTemplateEntryList(java.lang.String tableName) Returns the manager for the specific metadata template entries for the given table.
MetadataTemplateTableList	getMetadataTemplateTableList() Returns the list if entries for tables other than the Cumulus.TABLE_NAME_ASSET_RECORDS.
java.lang.String	getName() Returns the name of this metadata template.
RestrictionsList	getRestrictionsList() Returns the list of roles and users that are allowed to view this set.
boolean	isDefault() Returns whether this item is the default item.
boolean	isSharingRestricted() Returns whether the set visibility is restricted to a group of users or roles.
java.util.Iterator<MetadataTemplateEntry>	iterator()
void	processItem(Item item, java.util.Set<GUID> restrictedFieldList, boolean saveItem, MetadataTemplate.ChangeCallback changeCallback) Applies this template on the given item.
void	setDescription(int languageID, java.lang.String description) Sets the description for the given language.
void	setDisplayName(int languageID, java.lang.String displayName) Sets the display name for the given language.
void	setSharingRestricted(boolean value) Sets whether the set visibility is restricted to a group of users or roles.
java.lang.String	toString() Returns a XML representation of this class.

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

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

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Returns the name of this metadata template.

Returns:

name of this metadata template

getIsDefault

public boolean getIsDefault()

Returns whether this is the default template.

Returns:

true if this is the default template

getID

public java.lang.String getID()

Description copied from interface: Item

Returns the UID of the item in the items namespace.

Specified by:

getID in interface Item

Returns:

item UID

isDefault

public boolean isDefault()

Description copied from interface: Item

Returns whether this item is the default item.

Specified by:

isDefault in interface Item

Returns:

true if this is the default item

getDescription

public java.lang.String getDescription(int languageID)

Returns the description for the given language id.

Specified by:

getDescription in interface Item

Parameters:

languageID - specifying the language for the description

Returns:

description text

Since:

8.0

setDescription

public void setDescription(int languageID,
                  java.lang.String description)

Sets the description for the given language.

Specified by:

setDescription in interface Item

Parameters:

languageID - the language to set the description for

description - the new description

Since:

8.0

getDisplayName

public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)

Returns the display name for the given language id.

Specified by:

getDisplayName in interface Item

Parameters:

languageID - specifying the language for the display name

fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null

Returns:

display name

Since:

8.5

setDisplayName

public void setDisplayName(int languageID,
                  java.lang.String displayName)

Sets the display name for the given language.

Specified by:

setDisplayName in interface Item

Parameters:

languageID - the language to set the display name for

displayName - the new display name

Since:

8.5

getMetadataTemplateEntryList

public MetadataTemplateEntryList getMetadataTemplateEntryList(java.lang.String tableName)

Returns the manager for the specific metadata template entries for the given table.

Returns:

manager for the specific metadata template entries for the given table

Since:

9.1

getMetadataTemplateEntryList

public MetadataTemplateEntryList getMetadataTemplateEntryList()

Returns the manager for the specific metadata template entries.

Returns:

manager for the specific metadata template entries

getMetadataTemplateTableList

public MetadataTemplateTableList getMetadataTemplateTableList()

Returns the list if entries for tables other than the Cumulus.TABLE_NAME_ASSET_RECORDS.

Returns:

list if entries for tables other than the Cumulus.TABLE_NAME_ASSET_RECORDS

Since:

9.1

See Also:

getMetadataTemplateEntryList()

exportSet

public JPack exportSet()

Exports this set into a JPack.

Specified by:

exportSet in interface Item

Returns:

exported data as JPack

Since:

8.1

See Also:

MetadataTemplatesList.importSet(com.canto.cumulus.utils.JPack, SetImportDuplicatesMode)

isSharingRestricted

public boolean isSharingRestricted()

Returns whether the set visibility is restricted to a group of users or roles.

Specified by:

isSharingRestricted in interface Item

Returns:

true if the set visibility is restricted to a group of users or roles

Since:

8.6

setSharingRestricted

public void setSharingRestricted(boolean value)

Sets whether the set visibility is restricted to a group of users or roles.

Specified by:

setSharingRestricted in interface Item

Parameters:

value - set to true if the set visibility should be restricted to a group of users or roles

Since:

8.6

getRestrictionsList

public RestrictionsList getRestrictionsList()

Returns the list of roles and users that are allowed to view this set. Only applicable for shared set and if isSharingRestricted() returns true.

Specified by:

getRestrictionsList in interface Item

Returns:

list of roles and users that are allowed to view this set

Since:

8.6

iterator

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

Specified by:

iterator in interface java.lang.Iterable<MetadataTemplateEntry>

toString

public java.lang.String toString()

Description copied from class: BaseManager

Returns a XML representation of this class.

Overrides:

toString in class BaseManager

Returns:

XML representation

processItem

public void processItem(Item item,
               java.util.Set<GUID> restrictedFieldList,
               boolean saveItem,
               MetadataTemplate.ChangeCallback changeCallback)
                 throws CumulusException

Applies this template on the given item. Optionally you can restrict the processed fields.

Parameters:

item - item to change

restrictedFieldList - list of fields, which are only allowed to be changed, or null if all fields of this template should be processed

saveItem - true if the given item should be automatically be saved, false otherwise

changeCallback - optional callback to get notifications about changed field values, can be null

Throws:

CumulusException - in case of an unexpected error

Since:

9.2

fill

public void fill(Item item)

Fill this template with the field values of the given item.

Parameters:

item - item providing the field values to use for this template

Since:

9.2