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

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

Class PrometheusDataInfoItem

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.PrometheusDataInfoItem

All Implemented Interfaces:

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

Direct Known Subclasses:

PrometheusDataInfoLinkSet

public abstract class PrometheusDataInfoItem
extends PrometheusEncryptedDataItem

Representation of an information extension of a DataItem.

Author:

Tony Washer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusDataInfoItem.PrometheusDataInfoList<T extends PrometheusDataInfoItem>	List class for DataInfo.

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 int	DATALEN	Maximum DataLength.
protected static final String	ERROR_BADDATA	Invalid Data Error.
protected static final String	ERROR_BADDATATYPE	Invalid Data Type Error.
protected static final String	ERROR_BADINFOCLASS	Invalid Info Class 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	PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList)	Edit Constructor.
protected	PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList, PrometheusDataInfoItem pInfo)	Copy Constructor.
protected	PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList, PrometheusDataValues pValues)	Basic constructor.
protected	PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList, Integer uId, PrometheusStaticDataItem pInfoType, PrometheusDataItem pOwner)	Basic constructor.
protected	PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList, Integer uId, Integer uKeySetId, Integer uInfoTypeId, Integer uOwnerId)	Secure constructor.

Method Summary

Modifier and Type	Method	Description
int	compareValues(PrometheusDataItem pThat)	compareTo another dataItem.
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
PrometheusEncryptedPair	getField()	Obtain Value as underlying object.
static PrometheusEncryptedPair	getField(PrometheusEncryptedValues pValueSet)	Obtain Value as encrypted field.
abstract PrometheusDataInfoClass	getInfoClass()	Obtain InfoClass.
abstract PrometheusStaticDataItem	getInfoType()	Obtain InfoType.
Integer	getInfoTypeId()	Obtain InfoTypeId.
protected PrometheusDataItem	getLink()	Obtain Link.
<X extends PrometheusDataItem> X	getLink(Class<X> pClass)	Obtain Link.
String	getLinkName()	Get Link name.
abstract PrometheusDataItem	getOwner()	Obtain Owner.
Integer	getOwnerId()	Obtain OwnerId.
static <X> X	getValue(PrometheusEncryptedValues pValueSet, Class<X> pClass)	Obtain Value as object.
<X> X	getValue(Class<X> pClass)	Obtain Value as object.
byte[]	getValueBytes()	Obtain Encrypted Bytes.
void	markDeleted()	Mark deleted.
void	rewindInfoLinkSet()	rewind any infoSet links.
void	rewindToVersion(int pVersion)	Rewind item to the required version.
protected void	setValue(Object pValue)	Set Value.
protected <X> void	setValueBytes(byte[] pBytes, Class<X> pClass)	Set Object Value.
protected final void	setValueInfoType(PrometheusStaticDataItem pValue)	Set InfoType.
protected final void	setValueInfoType(Integer pId)	Set InfoType Id.
protected final void	setValueInfoType(String pName)	Set InfoType Name.
protected void	setValueLink(PrometheusDataItem pLink)	Set link.
protected void	setValueLink(String pName)	Set link name.
protected final void	setValueOwner(PrometheusDataItem pValue)	Set Owner.
protected final void	setValueOwner(Integer pId)	Set Owner id.
protected final void	setValueOwner(String pName)	Set Owner name.
protected void	setValueValue(PrometheusEncryptedPair pValue)	Set value.
protected void	setValueValue(Object pValue)	Set Value.
String	toString()
void	touchUnderlyingItems()	Touch underlying items that are referenced by this item.

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

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

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

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

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

adjustState, checkForHistory, clearErrors, clearHistory, condenseHistory, fieldChanged, getDataFieldSet, 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

getDataFieldSet

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

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

Field Details

DATALEN

public static final int DATALEN

Maximum DataLength.

See Also:

• Constant Field Values

ERROR_BADDATATYPE

protected static final String ERROR_BADDATATYPE

Invalid Data Type Error.

ERROR_BADDATA

protected static final String ERROR_BADDATA

Invalid Data Error.

ERROR_BADINFOCLASS

protected static final String ERROR_BADINFOCLASS

Invalid Info Class Error.

Constructor Details

PrometheusDataInfoItem

protected PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList,
 PrometheusDataInfoItem pInfo)

Copy Constructor.

Parameters:

pList - the list

pInfo - The Info to copy

PrometheusDataInfoItem

protected PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList)

Edit Constructor.

Parameters:

pList - the list

PrometheusDataInfoItem

protected PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList,
 Integer uId,
 Integer uKeySetId,
 Integer uInfoTypeId,
 Integer uOwnerId)
                          throws OceanusException

Secure constructor.

Parameters:

pList - the list

uId - the id

uKeySetId - the keySet id

uInfoTypeId - the info id

uOwnerId - the owner id

Throws:

OceanusException - on error

PrometheusDataInfoItem

protected PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList,
 Integer uId,
 PrometheusStaticDataItem pInfoType,
 PrometheusDataItem pOwner)

Basic constructor.

Parameters:

pList - the list

uId - the id

pInfoType - the info type

pOwner - the owner

PrometheusDataInfoItem

protected PrometheusDataInfoItem(PrometheusDataInfoItem.PrometheusDataInfoList<?> pList,
 PrometheusDataValues pValues)
                          throws OceanusException

Basic constructor.

Parameters:

pList - the list

pValues - the values

Throws:

OceanusException - on error

Method Details

toString

public String toString()

Overrides:

toString in class Object

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

getInfoType

public abstract PrometheusStaticDataItem getInfoType()

Obtain InfoType.

Returns:

the InfoTypeId

getInfoClass

public abstract PrometheusDataInfoClass getInfoClass()

Obtain InfoClass.

Returns:

the InfoClass

getInfoTypeId

public Integer getInfoTypeId()

Obtain InfoTypeId.

Returns:

the InfoTypeId

getOwner

public abstract PrometheusDataItem getOwner()

Obtain Owner.

Returns:

the Owner

getOwnerId

public Integer getOwnerId()

Obtain OwnerId.

Returns:

the OwnerId

getLink

public <X extends PrometheusDataItem> X getLink(Class<X> pClass)

Obtain Link.

Type Parameters:

X - the link type

Parameters:

pClass - the class of the link

Returns:

the Link

getLinkName

public String getLinkName()

Get Link name.

Returns:

the link name

getLink

protected PrometheusDataItem getLink()

Obtain Link.

Returns:

the Link

getValue

public <X> X getValue(Class<X> pClass)

Obtain Value as object.

Type Parameters:

X - the object type

Parameters:

pClass - the object class

Returns:

the Value

getField

public PrometheusEncryptedPair getField()

Obtain Value as underlying object.

Returns:

the Value

getValueBytes

public byte[] getValueBytes()

Obtain Encrypted Bytes.

Returns:

the Bytes

getValue

public static <X> X getValue(PrometheusEncryptedValues pValueSet,
 Class<X> pClass)

Obtain Value as object.

Type Parameters:

X - the object type

Parameters:

pValueSet - the valueSet

pClass - the object class

Returns:

the Value

getField

public static PrometheusEncryptedPair getField(PrometheusEncryptedValues pValueSet)

Obtain Value as encrypted field.

Parameters:

pValueSet - the valueSet

Returns:

the Value

setValueInfoType

protected final void setValueInfoType(PrometheusStaticDataItem pValue)

Set InfoType.

Parameters:

pValue - the info Type

setValueInfoType

protected final void setValueInfoType(Integer pId)

Set InfoType Id.

Parameters:

pId - the info Type id

setValueInfoType

protected final void setValueInfoType(String pName)

Set InfoType Name.

Parameters:

pName - the info Type name

setValueOwner

protected final void setValueOwner(PrometheusDataItem pValue)

Set Owner.

Parameters:

pValue - the owner

setValueOwner

protected final void setValueOwner(Integer pId)

Set Owner id.

Parameters:

pId - the owner id

setValueOwner

protected final void setValueOwner(String pName)

Set Owner name.

Parameters:

pName - the owner name

setValueValue

protected void setValueValue(Object pValue)
                      throws OceanusException

Set Value.

Parameters:

pValue - the value

Throws:

OceanusException - on error

setValueValue

protected void setValueValue(PrometheusEncryptedPair pValue)

Set value.

Parameters:

pValue - the value

setValueBytes

protected <X> void setValueBytes(byte[] pBytes,
 Class<X> pClass)
                          throws OceanusException

Set Object Value.

Type Parameters:

X - the object type

Parameters:

pBytes - the value

pClass - the object class

Throws:

OceanusException - on error

setValueLink

protected void setValueLink(PrometheusDataItem pLink)

Set link.

Parameters:

pLink - the link

setValueLink

protected void setValueLink(String pName)

Set link name.

Parameters:

pName - the linkName

markDeleted

public void markDeleted()

Mark deleted.

touchUnderlyingItems

public void touchUnderlyingItems()

Description copied from class: PrometheusDataItem

Touch underlying items that are referenced by this item.

Overrides:

touchUnderlyingItems in class PrometheusDataItem

setValue

protected void setValue(Object pValue)
                 throws OceanusException

Set Value.

Parameters:

pValue - the Value

Throws:

OceanusException - on error

rewindToVersion

public void rewindToVersion(int pVersion)

Description copied from class: MetisFieldVersionedItem

Rewind item to the required version.

Overrides:

rewindToVersion in class PrometheusDataItem

Parameters:

pVersion - the version to rewind to

rewindInfoLinkSet

public void rewindInfoLinkSet()

rewind any infoSet links.

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