Module io.github.tonywasher.joceanus.prometheus.core

Package io.github.tonywasher.joceanus.prometheus.data

Class PrometheusStaticDataItem

java.lang.Object

io.github.tonywasher.joceanus.metis.field.MetisFieldVersionedItem

io.github.tonywasher.joceanus.prometheus.data.PrometheusDataItem

io.github.tonywasher.joceanus.prometheus.data.PrometheusEncryptedDataItem

io.github.tonywasher.joceanus.prometheus.data.PrometheusStaticDataItem

All Implemented Interfaces:

MetisDataItem.MetisDataDeletableItem, MetisDataItem.MetisDataIndexedItem, MetisDataItem.MetisDataNamedItem, MetisDataItem.MetisDataObjectFormat, MetisFieldItem, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldUpdatableItem, PrometheusTableItem, Comparable<Object>

public abstract class PrometheusStaticDataItem
extends PrometheusEncryptedDataItem
implements MetisDataItem.MetisDataNamedItem

Template for a Static Data item and List.

Author:

Tony Washer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusStaticDataItem.PrometheusStaticDataMap<T extends PrometheusStaticDataItem>	The dataMap class.
static class	PrometheusStaticDataItem.PrometheusStaticList<T extends PrometheusStaticDataItem>	Represents a list of StaticData objects.

Nested classes/interfaces inherited from class io.github.tonywasher.joceanus.prometheus.data.PrometheusEncryptedDataItem

PrometheusEncryptedDataItem.PrometheusEncryptedList<T extends PrometheusEncryptedDataItem>

Nested classes/interfaces inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem

MetisFieldItem.MetisFieldDef, MetisFieldItem.MetisFieldItemType, MetisFieldItem.MetisFieldSetDef, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldUpdatableItem, MetisFieldItem.MetisFieldVersionedDef

Nested classes/interfaces inherited from interface io.github.tonywasher.joceanus.prometheus.data.PrometheusTableItem

PrometheusTableItem.PrometheusTableList<T extends PrometheusTableItem>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_BADID	BadId error.
static final String	ERROR_BADNAME	BadName error.

Fields inherited from class io.github.tonywasher.joceanus.prometheus.data.PrometheusDataItem

DESCLEN, ERROR_CREATEITEM, ERROR_DISABLED, ERROR_DUPLICATE, ERROR_EXIST, ERROR_INVALIDCHAR, ERROR_LENGTH, ERROR_MISSING, ERROR_MULT, ERROR_NEGATIVE, ERROR_POSITIVE, ERROR_RANGE, ERROR_RESOLUTION, ERROR_UNKNOWN, ERROR_VALIDATION, ERROR_ZERO, NAMELEN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusStaticDataItem(PrometheusStaticDataItem.PrometheusStaticList<?> pList, PrometheusDataValues pValues)	Values constructor.
protected	PrometheusStaticDataItem(PrometheusStaticDataItem.PrometheusStaticList<?> pList, PrometheusStaticDataClass pClass)	Basic Constructor.
protected	PrometheusStaticDataItem(PrometheusStaticDataItem.PrometheusStaticList<?> pList, PrometheusStaticDataItem pSource)	Copy Constructor.
protected	PrometheusStaticDataItem(PrometheusStaticDataItem.PrometheusStaticList<?> pList, String pValue)	Basic Constructor.

Method Summary

Modifier and Type	Method	Description
void	adjustMapForItem()	Adjust map for this item.
protected void	applyBasicChanges(PrometheusStaticDataItem pData)	Apply basic changes.
boolean	applyChanges(PrometheusDataItem pData)	Apply changes to the item from a changed version.
int	compareValues(PrometheusDataItem pThat)	compareTo another dataItem.
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
final String	getDesc()	Return the description of the Static Data.
final byte[]	getDescBytes()	Return the encrypted description of the Static Data.
final boolean	getEnabled()	Is the Static item enabled.
protected final Class<? extends PrometheusStaticDataClass>	getEnumClass()	Obtain the Enum class of this Static Data.
PrometheusStaticDataItem.PrometheusStaticList<?>	getList()	Obtain the list.
final String	getName()	Get the Name.
final byte[]	getNameBytes()	Return the encrypted name of the Static Data.
final Integer	getOrder()	Return the sort order of the Static Data.
final PrometheusStaticDataClass	getStaticClass()	Return the Static class of the Static Data.
boolean	includeXmlField(MetisDataItem.MetisDataFieldId pField)	Is the item to be included in output XML?
boolean	isDisabled()	Is the item disabled?
void	setDescription(String pDesc)	Set a new description.
void	setEnabled(boolean isEnabled)	Set Enabled indicator.
void	setName(String pName)	Set a new name.
void	setOrder(int iOrder)	Set Order indicator.
protected final void	setValueDesc(String pValue)	Set the Description.
protected final void	setValueEnabled(Boolean isEnabled)	Set the Enabled flag.
String	toString()

Methods inherited from class io.github.tonywasher.joceanus.prometheus.data.PrometheusEncryptedDataItem

adoptSecurity, getDataKeySet, getDataKeySetId, getDifference, getEncryptor, getOriginalValues, getValues, initialiseSecurity, newVersionValues, resolveDataSetLinks, setDataKeySet, setDataKeySet, setEncryptedValue, setEncryptedValue, setEncryptedValue, setNextDataKeySet, updateSecurity

Methods inherited from class io.github.tonywasher.joceanus.prometheus.data.PrometheusDataItem

addError, byteLength, clearActive, clearTouches, compareId, compareTo, deRegister, equals, fieldChanged, getBase, getBaseState, getDataSet, getFieldState, getItemState, getItemType, getNextVersion, getStyle, getTouchStatus, getValueSetVersion, hashCode, indexOf, isActive, isEditable, isHeader, isListLocked, isLocked, popHistory, removeItem, resolveDataLink, rewindToVersion, setBase, setHeader, setHistory, setNewVersion, setValidEdit, touchItem, touchOnUpdate, touchUnderlyingItems, unLink, updateMaps, validate, validString

Methods inherited from class io.github.tonywasher.joceanus.metis.field.MetisFieldVersionedItem

adjustState, checkForHistory, clearErrors, clearHistory, condenseHistory, fieldChanged, getEditState, getFieldErrors, getFieldErrors, getFirstError, getIndexedId, getOriginalVersion, getState, getValidation, getValuesHistory, getVersion, getVersionedField, hasChanges, hasErrors, hasErrors, hasHistory, isDeleted, isValid, maybePopHistory, pushHistory, pushHistory, resetHistory, setDeleted, setEditState, setHistory, setIndexedId, setItemType, setValues

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataDeletableItem

isDeleted, setDeleted

Methods inherited from interface io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataIndexedItem

getIndexedId

Methods inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem.MetisFieldUpdatableItem

checkForHistory, getFieldErrors, getFieldErrors, getValuesHistory, hasErrors, pushHistory, skipField

Field Details

ERROR_BADID

public static final String ERROR_BADID

BadId error.

ERROR_BADNAME

public static final String ERROR_BADNAME

BadName error.

Constructor Details

PrometheusStaticDataItem

protected PrometheusStaticDataItem(PrometheusStaticDataItem.PrometheusStaticList<?> pList,
 PrometheusStaticDataItem pSource)

Copy Constructor.

Parameters:

pList - The list to associate the Static Data with

pSource - The static data to copy

PrometheusStaticDataItem

protected PrometheusStaticDataItem(PrometheusStaticDataItem.PrometheusStaticList<?> pList,
 String pValue)
                            throws OceanusException

Basic Constructor.

Parameters:

pList - The list to associate the Static Data with

pValue - the name of the new item

Throws:

OceanusException - on error

PrometheusStaticDataItem

protected PrometheusStaticDataItem(PrometheusStaticDataItem.PrometheusStaticList<?> pList,
 PrometheusStaticDataClass pClass)
                            throws OceanusException

Basic Constructor.

Parameters:

pList - The list to associate the Static Data with

pClass - the class of the new item

Throws:

OceanusException - on error

PrometheusStaticDataItem

protected PrometheusStaticDataItem(PrometheusStaticDataItem.PrometheusStaticList<?> pList,
 PrometheusDataValues pValues)
                            throws OceanusException

Values constructor.

Parameters:

pList - the List to add to

pValues - the values constructor

Throws:

OceanusException - on error

Method Details

getDataFieldSet

public MetisFieldItem.MetisFieldSetDef getDataFieldSet()

Description copied from interface: MetisFieldItem

Obtain the fieldSet.

Specified by:

getDataFieldSet in interface MetisFieldItem

Overrides:

getDataFieldSet in class MetisFieldVersionedItem

Returns:

the fieldSet

formatObject

public String formatObject(OceanusDataFormatter pFormatter)

Description copied from interface: MetisDataItem.MetisDataObjectFormat

Obtain Object summary.

Specified by:

formatObject in interface MetisDataItem.MetisDataObjectFormat

Overrides:

formatObject in class PrometheusDataItem

Parameters:

pFormatter - the data formatter

Returns:

the display summary of the object

toString

public String toString()

Overrides:

toString in class Object

includeXmlField

public boolean includeXmlField(MetisDataItem.MetisDataFieldId pField)

Description copied from class: PrometheusDataItem

Is the item to be included in output XML?

Overrides:

includeXmlField in class PrometheusDataItem

Parameters:

pField - the field to check

Returns:

true/false

getName

public final String getName()

Description copied from interface: MetisDataItem.MetisDataNamedItem

Get the Name.

Specified by:

getName in interface MetisDataItem.MetisDataNamedItem

Returns:

the name

getNameBytes

public final byte[] getNameBytes()

Return the encrypted name of the Static Data.

Returns:

the encrypted name

getDesc

public final String getDesc()

Return the description of the Static Data.

Returns:

the description

getDescBytes

public final byte[] getDescBytes()

Return the encrypted description of the Static Data.

Returns:

the encrypted description

getOrder

public final Integer getOrder()

Return the sort order of the Static Data.

Returns:

the order

getStaticClass

public final PrometheusStaticDataClass getStaticClass()

Return the Static class of the Static Data.

Returns:

the class

getEnabled

public final boolean getEnabled()

Is the Static item enabled.

Returns:

true/false

isDisabled

public boolean isDisabled()

Description copied from class: PrometheusDataItem

Is the item disabled?

Overrides:

isDisabled in class PrometheusDataItem

Returns:

true/false

getEnumClass

protected final Class<? extends PrometheusStaticDataClass> getEnumClass()

Obtain the Enum class of this Static Data.

Returns:

the class

setValueDesc

protected final void setValueDesc(String pValue)
                           throws OceanusException

Set the Description.

Parameters:

pValue - the description

Throws:

OceanusException - on error

setValueEnabled

protected final void setValueEnabled(Boolean isEnabled)

Set the Enabled flag.

Parameters:

isEnabled - TRUE/FALSE

compareValues

public int compareValues(PrometheusDataItem pThat)

Description copied from class: PrometheusDataItem

compareTo another dataItem.

Specified by:

compareValues in class PrometheusDataItem

Parameters:

pThat - the DataItem to compare

Returns:

the order

getList

public PrometheusStaticDataItem.PrometheusStaticList<?> getList()

Description copied from class: PrometheusDataItem

Obtain the list.

Overrides:

getList in class PrometheusEncryptedDataItem

Returns:

the list

setName

public void setName(String pName)
             throws OceanusException

Set a new name.

Parameters:

pName - the name

Throws:

OceanusException - on error

setDescription

public void setDescription(String pDesc)
                    throws OceanusException

Set a new description.

Parameters:

pDesc - the description

Throws:

OceanusException - on error

setEnabled

public void setEnabled(boolean isEnabled)

Set Enabled indicator.

Parameters:

isEnabled - TRUE/FALSE

setOrder

public void setOrder(int iOrder)

Set Order indicator.

Parameters:

iOrder - the order

applyChanges

public boolean applyChanges(PrometheusDataItem pData)

Description copied from class: PrometheusDataItem

Apply changes to the item from a changed version. Overwritten by objects that have changes

Overrides:

applyChanges in class PrometheusDataItem

Parameters:

pData - the changed element.

Returns:

were changes made?

applyBasicChanges

protected void applyBasicChanges(PrometheusStaticDataItem pData)

Apply basic changes.

Parameters:

pData - the changed element

adjustMapForItem

public void adjustMapForItem()

Description copied from class: PrometheusDataItem

Adjust map for this item.

Overrides:

adjustMapForItem in class PrometheusDataItem