com.canto.cumulus.prefs

Class CatalogFieldList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.CatalogFieldList

public class CatalogFieldList
extends ListPackManager

This class manages a list of fields. This usually is the list of record fields from CatalogTemplateLayout.getCatalogRecordFieldList() or the list of category fields from CatalogTemplateLayout.getCatalogCategoryFieldList().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogFieldList.FieldListMode

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
CatalogField	createCatalogField(FieldDescriptor fieldDescriptor) Adds a new field to this list for the given field descriptor.
CatalogField	createCatalogField(FieldDescriptor fieldDescriptor, boolean forceCreation)
CatalogField	createCatalogField(GUID uid, int fieldType, int valueInterpretation) Adds a new field to this list for the given field UID, field type and field value interpretation.
CatalogField	getCatalogField(java.lang.String guid) Returns the field for the given UID.
java.util.List<java.lang.String>	getCatalogFieldGUIDs() Returns a list of all field GUIDs currently contained in this list.
java.util.List<CatalogField>	getCatalogFields() Returns a list of all fields currently contained in this list.
java.util.Set<GUID>	getCatalogFieldUIDs() Returns a set of all field GUIDs currently contained in this list.
CatalogFieldList.FieldListMode	getFieldListMode()
java.lang.String	getTableName()
boolean	isTopLevelFieldList()
void	remove(CatalogField catalogTemplateField) Removes the given field from 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

isTopLevelFieldList

public boolean isTopLevelFieldList()

getTableName

public java.lang.String getTableName()

getFieldListMode

public CatalogFieldList.FieldListMode getFieldListMode()

createCatalogField

public CatalogField createCatalogField(GUID uid,
                              int fieldType,
                              int valueInterpretation)

Adds a new field to this list for the given field UID, field type and field value interpretation.

Parameters:

uid - the UID of the new field to add

fieldType - the field type of the new field

valueInterpretation - the value interpretation of the new field

Returns:

the new created field or the existing one

createCatalogField

public CatalogField createCatalogField(FieldDescriptor fieldDescriptor)

Adds a new field to this list for the given field descriptor.

Parameters:

fieldDescriptor - the field descriptor specifying the new fields properties

Returns:

the new created field or the existing one if the given UID already matches an existing field

Since:

9.2

createCatalogField

public CatalogField createCatalogField(FieldDescriptor fieldDescriptor,
                              boolean forceCreation)

getCatalogFields

public java.util.List<CatalogField> getCatalogFields()

Returns a list of all fields currently contained in this list.

Returns:

list of CatalogField instances

getCatalogFieldGUIDs

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

Returns a list of all field GUIDs currently contained in this list.

Returns:

list of String instances

getCatalogFieldUIDs

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

Returns a set of all field GUIDs currently contained in this list.

Returns:

set of GUID instances

Since:

8.5.2

getCatalogField

public CatalogField getCatalogField(java.lang.String guid)

Returns the field for the given UID.

Parameters:

guid - the UID of the field to get

Returns:

the found field or null if not found

remove

public void remove(CatalogField catalogTemplateField)

Removes the given field from this list.

Parameters:

catalogTemplateField - the field to remove