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

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

Class PrometheusDataInfoLinkSet<T extends 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

io.github.tonywasher.joceanus.prometheus.data.PrometheusDataInfoLinkSet<T>

Type Parameters:

T - the data type

All Implemented Interfaces:

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

public class PrometheusDataInfoLinkSet<T extends PrometheusDataInfoItem>
extends PrometheusDataInfoItem

Representation of a set of DataInfo links for a DataItem.

Author:

Tony Washer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PrometheusDataInfoLinkSet.PrometheusInfoSetValueList	Value List.

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

PrometheusDataInfoItem.PrometheusDataInfoList<T extends PrometheusDataInfoItem>

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	ITEM_SEP	Item separator.

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

DATALEN, ERROR_BADDATA, ERROR_BADDATATYPE, ERROR_BADINFOCLASS

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	PrometheusDataInfoLinkSet(PrometheusDataInfoItem.PrometheusDataInfoList<T> pList, PrometheusDataInfoLinkSet<T> pSet)	Constructor.
protected	PrometheusDataInfoLinkSet(PrometheusDataInfoItem.PrometheusDataInfoList<T> pList, PrometheusDataItem pOwner, PrometheusStaticDataItem pInfoType)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addNewLinks(List<? extends PrometheusDataItem> pActive)	Add/restore all required links.
boolean	checkForHistory()	Check to see whether any changes were made.
void	clearAllLinks()	Clear all the links.
void	clearUnnecessaryLinks(List<? extends PrometheusDataItem> pActive)	Clear all unnecessary links.
MetisDataDifference	fieldChanged()	Determine whether any item has changed in this edit view.
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
List<Object>	getActive()	Obtain Active Links.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
PrometheusDataInfoClass	getInfoClass()	Obtain InfoClass.
PrometheusStaticDataItem	getInfoType()	Obtain InfoType.
T	getItemForValue(PrometheusDataItem pValue)	Obtain item linked to value.
PrometheusDataItem	getOwner()	Obtain Owner.
MetisDataState	getState()	Get the State for this infoSet.
boolean	hasHistory()	Is there any history.
boolean	isEmpty()	Is the link list empty?
boolean	isExisting()	Is there active values for the infoClass?
boolean	isItemLinked(T pItem)	Check whether an item is linked.
Iterator<T>	iterator()	Obtain an iterator through the list.
void	linkItem(T pItem)	Add link to Item.
void	popHistory()	Remove the last changes for the history buffer and restore values from it.
void	pushHistory()	Push current values into history buffer ready for changes to be made.
void	setDeleted(boolean bDeleted)	Set the deleted flags for the item.
protected void	sortLinks()	Sort the list.
void	touchOnUpdate()	Adjust touches on update.
void	touchUnderlyingItems()	Touch underlying items that are referenced by this item.
void	unlinkItem(T pItem)	Remove link to Item.

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

compareValues, getField, getField, getInfoTypeId, getLink, getLink, getLinkName, getOwnerId, getValue, getValue, getValueBytes, markDeleted, rewindInfoLinkSet, rewindToVersion, setValue, setValueBytes, setValueInfoType, setValueInfoType, setValueInfoType, setValueLink, setValueLink, setValueOwner, setValueOwner, setValueOwner, setValueValue, setValueValue, toString

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, removeItem, resolveDataLink, setBase, setHeader, setHistory, setNewVersion, setValidEdit, touchItem, unLink, updateMaps, validate, validString

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

adjustState, clearErrors, clearHistory, condenseHistory, fieldChanged, getEditState, getFieldErrors, getFieldErrors, getFirstError, getIndexedId, getOriginalVersion, getValidation, getValuesHistory, getVersion, getVersionedField, hasChanges, hasErrors, hasErrors, isDeleted, isValid, maybePopHistory, pushHistory, resetHistory, 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

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

getFieldErrors, getFieldErrors, getValuesHistory, hasErrors, skipField

Field Details

ITEM_SEP

public static final String ITEM_SEP

Item separator.

See Also:

• Constant Field Values

Constructor Details

PrometheusDataInfoLinkSet

protected PrometheusDataInfoLinkSet(PrometheusDataInfoItem.PrometheusDataInfoList<T> pList,
 PrometheusDataItem pOwner,
 PrometheusStaticDataItem pInfoType)

Constructor.

Parameters:

pList - the infoList

pOwner - the set owner

pInfoType - the info type

PrometheusDataInfoLinkSet

protected PrometheusDataInfoLinkSet(PrometheusDataInfoItem.PrometheusDataInfoList<T> pList,
 PrometheusDataInfoLinkSet<T> pSet)

Constructor.

Parameters:

pList - the infoList

pSet - the infoLinkSet to clone

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 PrometheusDataInfoItem

Parameters:

pFormatter - the data formatter

Returns:

the display summary of the object

getOwner

public PrometheusDataItem getOwner()

Description copied from class: PrometheusDataInfoItem

Obtain Owner.

Specified by:

getOwner in class PrometheusDataInfoItem

Returns:

the Owner

getInfoType

public PrometheusStaticDataItem getInfoType()

Description copied from class: PrometheusDataInfoItem

Obtain InfoType.

Specified by:

getInfoType in class PrometheusDataInfoItem

Returns:

the InfoTypeId

getInfoClass

public PrometheusDataInfoClass getInfoClass()

Description copied from class: PrometheusDataInfoItem

Obtain InfoClass.

Specified by:

getInfoClass in class PrometheusDataInfoItem

Returns:

the InfoClass

getActive

public List<Object> getActive()

Obtain Active Links.

Returns:

the Owner

isEmpty

public boolean isEmpty()

Is the link list empty?

Returns:

true/false

linkItem

public void linkItem(T pItem)

Add link to Item.

Parameters:

pItem - the item to link to

unlinkItem

public void unlinkItem(T pItem)

Remove link to Item.

Parameters:

pItem - the item to unlink

isItemLinked

public boolean isItemLinked(T pItem)

Check whether an item is linked.

Parameters:

pItem - the item to check

Returns:

true/false

getItemForValue

public T getItemForValue(PrometheusDataItem pValue)

Obtain item linked to value.

Parameters:

pValue - the value to check

Returns:

true/false

clearAllLinks

public void clearAllLinks()

Clear all the links.

addNewLinks

public void addNewLinks(List<? extends PrometheusDataItem> pActive)
                 throws OceanusException

Add/restore all required links.

Parameters:

pActive - the active items

Throws:

OceanusException - on error

clearUnnecessaryLinks

public void clearUnnecessaryLinks(List<? extends PrometheusDataItem> pActive)

Clear all unnecessary links.

Parameters:

pActive - the active items

sortLinks

protected void sortLinks()

Sort the list.

fieldChanged

public MetisDataDifference fieldChanged()

Determine whether any item has changed in this edit view.

Returns:

true/false

hasHistory

public boolean hasHistory()

Description copied from class: MetisFieldVersionedItem

Is there any history.

Overrides:

hasHistory in class MetisFieldVersionedItem

Returns:

whether there are entries in the history list

pushHistory

public void pushHistory()

Description copied from interface: MetisFieldItem.MetisFieldUpdatableItem

Push current values into history buffer ready for changes to be made.

Specified by:

pushHistory in interface MetisFieldItem.MetisFieldUpdatableItem

Overrides:

pushHistory in class MetisFieldVersionedItem

popHistory

public void popHistory()

Description copied from interface: MetisFieldItem.MetisFieldUpdatableItem

Remove the last changes for the history buffer and restore values from it.

Specified by:

popHistory in interface MetisFieldItem.MetisFieldUpdatableItem

Overrides:

popHistory in class PrometheusDataItem

checkForHistory

public boolean checkForHistory()

Description copied from interface: MetisFieldItem.MetisFieldUpdatableItem

Check to see whether any changes were made. If no changes were made remove last saved history since it is not needed.

Specified by:

checkForHistory in interface MetisFieldItem.MetisFieldUpdatableItem

Overrides:

checkForHistory in class MetisFieldVersionedItem

Returns:

true if changes were made, false otherwise

getState

public MetisDataState getState()

Get the State for this infoSet.

Overrides:

getState in class MetisFieldVersionedItem

Returns:

the State

isExisting

public boolean isExisting()

Is there active values for the infoClass?

Returns:

true/false

setDeleted

public void setDeleted(boolean bDeleted)

Description copied from interface: MetisDataItem.MetisDataDeletableItem

Set the deleted flags for the item.

Specified by:

setDeleted in interface MetisDataItem.MetisDataDeletableItem

Overrides:

setDeleted in class MetisFieldVersionedItem

Parameters:

bDeleted - true/false

touchUnderlyingItems

public void touchUnderlyingItems()

Description copied from class: PrometheusDataItem

Touch underlying items that are referenced by this item.

Overrides:

touchUnderlyingItems in class PrometheusDataInfoItem

touchOnUpdate

public void touchOnUpdate()

Description copied from class: PrometheusDataItem

Adjust touches on update.

Overrides:

touchOnUpdate in class PrometheusDataItem

iterator

public Iterator<T> iterator()

Obtain an iterator through the list.

Returns:

the iterator