MetadataTemplateEntry (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.prefs.MetadataTemplateEntry

```
public class MetadataTemplateEntry
extends BaseManager
```
This class describes a single entry of a metadata template.

See Also:
MetadataTemplateEntryList.getEntry(String)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MetadataTemplateEntry.ValueFillMode
Describes the available fill modes for field values.
- Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager
  BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Nested Classes
Modifier and Type	Class and Description
`static class`	`MetadataTemplateEntry.ValueFillMode` Describes the available fill modes for field values.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FILL_MODE_OPTION_ADD` Deprecated. Use `MetadataTemplateEntry.ValueFillMode.ADD` instead.
`static int`	`FILL_MODE_OPTION_APPEND` Deprecated. Use `MetadataTemplateEntry.ValueFillMode.APPEND` instead.
`static int`	`FILL_MODE_OPTION_CLEAR_VALUE` Deprecated. Use `MetadataTemplateEntry.ValueFillMode.CLEAR_VALUE` instead.
`static int`	`FILL_MODE_OPTION_PREPEND` Deprecated. Use `FILL_MODE_OPTION_PREPEND` instead.
`static int`	`FILL_MODE_OPTION_REMOVE` Deprecated. Use `MetadataTemplateEntry.ValueFillMode.REMOVE` instead.
`static int`	`FILL_MODE_OPTION_REPLACE` Deprecated. Use `MetadataTemplateEntry.ValueFillMode.REPLACE` instead.
`static int`	`FILL_MODE_OPTION_REPLACE_IF_EMPTY` Deprecated. Use `MetadataTemplateEntry.ValueFillMode.REPLACE_IF_EMPTY` instead.
`static char`	`FORMULA_PLACEHOLDER_DATE_MODIFIER_DAYS`
`static char`	`FORMULA_PLACEHOLDER_DATE_MODIFIER_HOURS`
`static char`	`FORMULA_PLACEHOLDER_DATE_MODIFIER_MINUTES`
`static char`	`FORMULA_PLACEHOLDER_DATE_MODIFIER_SECONDS`
`static java.lang.String`	`FORMULA_PLACEHOLDER_DATE_NOW`
`static java.lang.String`	`FORMULA_PLACEHOLDER_DATE_TODAY`

Fields inherited from class com.canto.cumulus.prefs.BaseManager
TYPE_EJP, TYPE_NATIVE

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearValue()`
`boolean`	`fillField()` Returns whether this entry should be used when applying this metadata template.
`boolean`	`getBooleanValue()` Returns this entries value as a boolean value.
`java.util.Date`	`getDateValue()` Returns this entries value as a Date value.
`double`	`getDoubleValue()` Returns this entries value as a double value.
`java.lang.String`	`getFieldName()` Returns the display name of this field.
`int`	`getFieldType()` Returns the field type of this entry.
`java.lang.String`	`getFieldUID()` Returns the field UDI of this entry.
`int`	`getFillMode()` Deprecated. Use `getValueFillMode()` instead
`java.lang.String`	`getFormula()` Returns the formula of this entry if available.
`int`	`getIntValue()` Returns this entries value as a integer value.
`long`	`getLongValue()` Returns this entries value as a long value.
`java.lang.String`	`getName()` Returns the name of this metadata template entry.
`static java.lang.String[]`	`getPKValues(java.lang.String uid)`
`int[]`	`getStringEnumValue()` Returns this entries value as a string enum value.
`java.lang.String`	`getStringValue()` Returns this entries value as a string value.
`java.lang.Object`	`getValue()` Deprecated. Use one of the type-specific functions instead!
`MetadataTemplateEntry.ValueFillMode`	`getValueFillMode()` Returns the mode for applying this entry for string fields.
`int`	`getValueInterpretation()` Returns the value interpretation for this entry.
`int[]`	`getVocabularyValue()` Returns this entries value as a vocabulary value.
`boolean`	`hasFormula()` Returns whether this entry has a formula instead of a static value.
`void`	`setBooleanValue(boolean value)` Sets this entries value as a boolean value.
`void`	`setDateValue(java.util.Date value)` Sets this entries value as a Date value.
`void`	`setDateValue(java.util.Date value, boolean asDateTime64)` Sets this entries value as a Date value.
`void`	`setDoubleValue(double value)` Sets this entries value as an double value.
`void`	`setFillField(boolean value)` Configures whether this entry should be used when applying this metadata template.
`void`	`setFillMode(int mode)` Deprecated. Use `setValueFillMode(com.canto.cumulus.prefs.MetadataTemplateEntry.ValueFillMode)` instead
`void`	`setFormula(java.lang.String formula)` Sets a formula for this entry.
`void`	`setIntValue(int value)` Sets this entries value as an integer value.
`void`	`setLongValue(long value)` Sets this entries value as an long value.
`void`	`setStringEnumValue(int[] value)` Sets this entries value as an string enum value.
`void`	`setStringValue(java.lang.String value)` Sets this entries value as an string value.
`void`	`setValue(java.lang.Object value)` Deprecated. Use one of the type-specific functions instead!
`void`	`setValueFillMode(MetadataTemplateEntry.ValueFillMode mode)` Configures the mode for applying this entry for string fields.
`void`	`setVocabularyValue(int[] value)` Sets this entries value as an vocabulary value.

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

- Field Detail
  - FORMULA_PLACEHOLDER_DATE_NOW
```
public static final java.lang.String FORMULA_PLACEHOLDER_DATE_NOW
```
    See Also:
    Constant Field Values
  - FORMULA_PLACEHOLDER_DATE_TODAY
```
public static final java.lang.String FORMULA_PLACEHOLDER_DATE_TODAY
```
    See Also:
    Constant Field Values
  - FORMULA_PLACEHOLDER_DATE_MODIFIER_DAYS
```
public static final char FORMULA_PLACEHOLDER_DATE_MODIFIER_DAYS
```
    See Also:
    Constant Field Values
  - FORMULA_PLACEHOLDER_DATE_MODIFIER_HOURS
```
public static final char FORMULA_PLACEHOLDER_DATE_MODIFIER_HOURS
```
    See Also:
    Constant Field Values
  - FORMULA_PLACEHOLDER_DATE_MODIFIER_MINUTES
```
public static final char FORMULA_PLACEHOLDER_DATE_MODIFIER_MINUTES
```
    See Also:
    Constant Field Values
  - FORMULA_PLACEHOLDER_DATE_MODIFIER_SECONDS
```
public static final char FORMULA_PLACEHOLDER_DATE_MODIFIER_SECONDS
```
    See Also:
    Constant Field Values
  - FILL_MODE_OPTION_REPLACE
```
@Deprecated
public static final int FILL_MODE_OPTION_REPLACE
```
    Deprecated. Use MetadataTemplateEntry.ValueFillMode.REPLACE instead.
    
    See Also:
    Constant Field Values
  - FILL_MODE_OPTION_APPEND
```
@Deprecated
public static final int FILL_MODE_OPTION_APPEND
```
    Deprecated. Use MetadataTemplateEntry.ValueFillMode.APPEND instead.
    
    See Also:
    Constant Field Values
  - FILL_MODE_OPTION_PREPEND
```
@Deprecated
public static final int FILL_MODE_OPTION_PREPEND
```
    Deprecated. Use FILL_MODE_OPTION_PREPEND instead.
    
    See Also:
    Constant Field Values
  - FILL_MODE_OPTION_ADD
```
@Deprecated
public static final int FILL_MODE_OPTION_ADD
```
    Deprecated. Use MetadataTemplateEntry.ValueFillMode.ADD instead.
    
    See Also:
    Constant Field Values
  - FILL_MODE_OPTION_REMOVE
```
@Deprecated
public static final int FILL_MODE_OPTION_REMOVE
```
    Deprecated. Use MetadataTemplateEntry.ValueFillMode.REMOVE instead.
    
    See Also:
    Constant Field Values
  - FILL_MODE_OPTION_CLEAR_VALUE
```
@Deprecated
public static final int FILL_MODE_OPTION_CLEAR_VALUE
```
    Deprecated. Use MetadataTemplateEntry.ValueFillMode.CLEAR_VALUE instead.
    
    See Also:
    Constant Field Values
  - FILL_MODE_OPTION_REPLACE_IF_EMPTY
```
@Deprecated
public static final int FILL_MODE_OPTION_REPLACE_IF_EMPTY
```
    Deprecated. Use MetadataTemplateEntry.ValueFillMode.REPLACE_IF_EMPTY instead.
    
    See Also:
    Constant Field Values
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of this metadata template entry.
    
    Returns:
    name of this metadata template entry
  - fillField
```
public boolean fillField()
```
    Returns whether this entry should be used when applying this metadata template.
    
    Returns:
    true if this entry should be used
  - setFillField
```
public void setFillField(boolean value)
```
    Configures whether this entry should be used when applying this metadata template.
    
    Parameters:
    value - set to true if this entry should be used
  - getFieldName
```
public java.lang.String getFieldName()
```
    Returns the display name of this field.
    
    Returns:
    field name
  - getFieldUID
```
public java.lang.String getFieldUID()
```
    Returns the field UDI of this entry.
    
    Returns:
    field UID
  - getFieldType
```
public int getFieldType()
```
    Returns the field type of this entry.
    
    Returns:
    field type
  - getValueInterpretation
```
public int getValueInterpretation()
```
    Returns the value interpretation for this entry.
    
    Returns:
    value interpretation
  - getFillMode
```
@Deprecated
public int getFillMode()
```
    Deprecated. Use getValueFillMode() instead
    
    Returns the mode for applying this entry for string fields. Possible values are FILL_MODE_OPTION_APPEND, FILL_MODE_OPTION_PREPEND and FILL_MODE_OPTION_REPLACE. Defaults to FILL_MODE_OPTION_REPLACE.
    
    Returns:
    mode for applying the entry for string fields
  - getValueFillMode
```
public MetadataTemplateEntry.ValueFillMode getValueFillMode()
```
    Returns the mode for applying this entry for string fields. Possible values are FILL_MODE_OPTION_APPEND, FILL_MODE_OPTION_PREPEND and FILL_MODE_OPTION_REPLACE. Defaults to FILL_MODE_OPTION_REPLACE.
    
    Returns:
    mode for applying the entry for string fields
    Since:
    
    9.0
  - setFillMode
```
@Deprecated
public void setFillMode(int mode)
```
    Deprecated. Use setValueFillMode(com.canto.cumulus.prefs.MetadataTemplateEntry.ValueFillMode) instead
    
    Configures the mode for applying this entry for string fields. Possible values are FILL_MODE_OPTION_APPEND, FILL_MODE_OPTION_PREPEND and FILL_MODE_OPTION_REPLACE.
    
    Parameters:
    mode - mode for applying the entry for string fields
  - setValueFillMode
```
public void setValueFillMode(MetadataTemplateEntry.ValueFillMode mode)
```
    Configures the mode for applying this entry for string fields.
    
    Parameters:
    mode - mode for applying the entry
    Since:
    
    9.0
  - hasFormula
```
public boolean hasFormula()
```
    Returns whether this entry has a formula instead of a static value. To access the plain formula call getFormula(). Calling getValue() on a formula entry returns the result of the evaluated formula.
    
    Returns:
    true if this entry consists of a formula instead of a static value
    Since:
    
    8.0
  - getFormula
```
public java.lang.String getFormula()
```
    Returns the formula of this entry if available.
    
    Returns:
    the plain formula String or null otherwise
    Since:
    
    8.0
  - setFormula
```
public void setFormula(java.lang.String formula)
```
    Sets a formula for this entry.
    
    Parameters:
    formula - the formula to set
    Since:
    
    8.0
  - getBooleanValue
```
public boolean getBooleanValue()
```
    Returns this entries value as a boolean value.
    
    Returns:
    found boolean value
    Since:
    
    8.0
  - setBooleanValue
```
public void setBooleanValue(boolean value)
```
    Sets this entries value as a boolean value. This removes any available formula as well.
    
    Parameters:
    value - new value
    Since:
    
    8.0
  - getDateValue
```
public java.util.Date getDateValue()
```
    Returns this entries value as a Date value.
    
    Returns:
    found Date value
    Since:
    
    8.0
  - setDateValue
```
public void setDateValue(java.util.Date value)
```
    Sets this entries value as a Date value. This removes any available formula as well.
    
    Parameters:
    value - new value
    Since:
    
    8.0
  - setDateValue
```
public void setDateValue(java.util.Date value,
                boolean asDateTime64)
```
    Sets this entries value as a Date value. This removes any available formula as well.
    
    Parameters:
    value - new value
    asDateTime64 - indicates whether the value should be saved as double (true) value or as integer value (false)
    Since:
    
    10.2.1
  - getIntValue
```
public int getIntValue()
```
    Returns this entries value as a integer value.
    
    Returns:
    found integer value
    Since:
    
    8.0
  - setIntValue
```
public void setIntValue(int value)
```
    Sets this entries value as an integer value. This removes any available formula as well.
    
    Parameters:
    value - new value
    Since:
    
    8.0
  - getLongValue
```
public long getLongValue()
```
    Returns this entries value as a long value.
    
    Returns:
    found long value
    Since:
    
    8.0
  - setLongValue
```
public void setLongValue(long value)
```
    Sets this entries value as an long value. This removes any available formula as well.
    
    Parameters:
    value - new value
    Since:
    
    8.0
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns this entries value as a double value.
    
    Returns:
    found double value
    Since:
    
    8.0
  - setDoubleValue
```
public void setDoubleValue(double value)
```
    Sets this entries value as an double value. This removes any available formula as well.
    
    Parameters:
    value - new value
    Since:
    
    8.0
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns this entries value as a string value.
    
    Returns:
    found string value
    Since:
    
    8.0
  - setStringValue
```
public void setStringValue(java.lang.String value)
```
    Sets this entries value as an string value. This removes any available formula as well.
    
    Parameters:
    value - new value
    Since:
    
    8.0
  - getStringEnumValue
```
public int[] getStringEnumValue()
```
    Returns this entries value as a string enum value.
    
    Returns:
    found string enum value
    Since:
    
    8.0
  - setStringEnumValue
```
public void setStringEnumValue(int[] value)
```
    Sets this entries value as an string enum value. This removes any available formula as well.
    
    Parameters:
    value - new value
    Since:
    
    8.0
  - getVocabularyValue
```
public int[] getVocabularyValue()
```
    Returns this entries value as a vocabulary value.
    
    Returns:
    found string enum value
    Since:
    
    10.0.2
  - setVocabularyValue
```
public void setVocabularyValue(int[] value)
```
    Sets this entries value as an vocabulary value. This removes any available formula as well.
    
    Parameters:
    value - new value
    Since:
    
    10.0.2
  - clearValue
```
public void clearValue()
```
  - setValue
```
@Deprecated
public void setValue(java.lang.Object value)
```
    Deprecated. Use one of the type-specific functions instead!
    
    Sets the value for this entry. This removes any available formula as well.
    
    Parameters:
    value - new value
  - getValue
```
@Deprecated
public java.lang.Object getValue()
```
    Deprecated. Use one of the type-specific functions instead!
    
    Returns the value for this entry.
    
    Returns:
    value stored for this entry
  - getPKValues
```
public static java.lang.String[] getPKValues(java.lang.String uid)
```

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class MetadataTemplateEntry

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

FORMULA_PLACEHOLDER_DATE_NOW

FORMULA_PLACEHOLDER_DATE_TODAY

FORMULA_PLACEHOLDER_DATE_MODIFIER_DAYS

FORMULA_PLACEHOLDER_DATE_MODIFIER_HOURS

FORMULA_PLACEHOLDER_DATE_MODIFIER_MINUTES

FORMULA_PLACEHOLDER_DATE_MODIFIER_SECONDS

FILL_MODE_OPTION_REPLACE

FILL_MODE_OPTION_APPEND

FILL_MODE_OPTION_PREPEND

FILL_MODE_OPTION_ADD

FILL_MODE_OPTION_REMOVE

FILL_MODE_OPTION_CLEAR_VALUE

FILL_MODE_OPTION_REPLACE_IF_EMPTY

Method Detail

getName

fillField

setFillField

getFieldName

getFieldUID

getFieldType

getValueInterpretation

getFillMode

getValueFillMode

setFillMode

setValueFillMode

hasFormula

getFormula

setFormula

getBooleanValue

setBooleanValue

getDateValue

setDateValue

setDateValue

getIntValue

setIntValue

getLongValue

setLongValue

getDoubleValue

setDoubleValue

getStringValue

setStringValue

getStringEnumValue

setStringEnumValue

getVocabularyValue

setVocabularyValue

clearValue

setValue

getValue

getPKValues