com.canto.cumulus.prefs

Class MetadataTemplateEntryList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.MetadataTemplateEntryList

public class MetadataTemplateEntryList
extends ListPackManager

This class manages a list of metadata template entries. Each entry describes a catalog field and assigns a value to it.

See Also:

MetadataTemplate.getMetadataTemplateEntryList(), MetadataTemplateEntry

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
int	countEntries() Returns the number of contained entries.
MetadataTemplateEntry	createEntry(FieldDefinition fieldDefinition) Creates a new entry for the given field or returns the existing entry matching the field.
MetadataTemplateEntry	createEntry(java.lang.String uid, java.lang.String name, int fieldType, int valueInterpretation) Creates a new entry for the given UID or returns the existing entry matching the UID.
void	delete(MetadataTemplateEntry templateEntry) Deletes the given entry.
java.util.List<MetadataTemplateEntry>	getEntries() Returns a list of all MetadataTemplateEntry instances contained in this list.
MetadataTemplateEntry	getEntry(java.lang.String uid) Returns the entry found for the given UID.
java.util.Set<GUID>	getEntryGUIDs() Returns a list of entry GUIDs contained in this list.
java.util.List<java.lang.String>	getEntryUIDs() Returns a list of entry UIDs contained in this list.

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

countEntries

public int countEntries()

Returns the number of contained entries.

Returns:

number of entries

getEntryUIDs

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

Returns a list of entry UIDs contained in this list.

Returns:

list of String instances

getEntryGUIDs

public java.util.Set<GUID> getEntryGUIDs()

Returns a list of entry GUIDs contained in this list.

Returns:

list of GUID instances

Since:

8.5.2

getEntries

public java.util.List<MetadataTemplateEntry> getEntries()

Returns a list of all MetadataTemplateEntry instances contained in this list.

Returns:

list of all MetadataTemplateEntry instances

getEntry

public MetadataTemplateEntry getEntry(java.lang.String uid)

Returns the entry found for the given UID.

Parameters:

uid - the UID for the entry to get

Returns:

the entry or null if no entry was found for the specified UID

createEntry

public MetadataTemplateEntry createEntry(java.lang.String uid,
                                java.lang.String name,
                                int fieldType,
                                int valueInterpretation)

Creates a new entry for the given UID or returns the existing entry matching the UID. This method should only be used if no FieldDefinition is available as it cannot make sure that multiple languages fields are handled correctly. With a FieldDefinition available use createEntry(com.canto.cumulus.FieldDefinition) instead.

Parameters:

uid - UID for the entry to create

name - display name of the entry to create

fieldType - field type of the entry to create

valueInterpretation - value interpretation of the entry to create

Returns:

the new created or found entry

createEntry

public MetadataTemplateEntry createEntry(FieldDefinition fieldDefinition)

Creates a new entry for the given field or returns the existing entry matching the field.

Parameters:

fieldDefinition - the field to add to this metadata template

Returns:

the new created or found entry

Since:

8.6

delete

public void delete(MetadataTemplateEntry templateEntry)

Deletes the given entry.

Parameters:

templateEntry - the entry to delete