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

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

Class PrometheusControlKeySet

java.lang.Object

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

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

io.github.tonywasher.joceanus.prometheus.data.PrometheusControlKeySet

All Implemented Interfaces:

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

public class PrometheusControlKeySet
extends PrometheusDataItem

ControlKeySet definition and list. The controlKeySet secures a set of dataKeySets.

Author:

Tony Washer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusControlKeySet.PrometheusControlKeySetList	DataKeySet List.

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	LIST_NAME	List name.
static final String	OBJECT_NAME	Object name.
static final int	WRAPLEN	KeySetWrapLength.

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	PrometheusControlKeySet(PrometheusControlKeySet.PrometheusControlKeySetList pList, PrometheusControlKey pControlKey)	Constructor for a new DataKeySet.
protected	PrometheusControlKeySet(PrometheusControlKeySet.PrometheusControlKeySetList pList, PrometheusControlKeySet pSource)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
int	compareValues(PrometheusDataItem pThat)	compareTo another dataItem.
protected void	deleteControlKeySet()	Delete the old ControlKeySet and DataKeySets.
PrometheusControlKeySet	getBase()	Get the base item for this item.
final PrometheusControlKey	getControlKey()	Get the ControlKey.
Integer	getControlKeyId()	Get the ControlKeyId for this item.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
GordianKeySet	getKeySet()	Get the KeySet.
PrometheusControlKeySet.PrometheusControlKeySetList	getList()	Obtain the list.
(package private) PrometheusDataKeySet	getNextDataKeySet()	Obtain the next DataKeySet.
final byte[]	getSecuredKeySetDef()	Get the securedKeySetDef.
(package private) GordianFactory	getSecurityFactory()	Obtain the security factory.
(package private) void	registerDataKeySet(PrometheusDataKeySet pKeySet)	Register DataKeySet.
void	resolveDataSetLinks()	Resolve all references to current dataSet.

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

addError, adjustMapForItem, applyChanges, byteLength, clearActive, clearTouches, compareId, compareTo, deRegister, equals, fieldChanged, formatObject, getBaseState, getDataSet, getFieldState, getItemState, getItemType, getNextVersion, getStyle, getTouchStatus, getValueSetVersion, hashCode, includeXmlField, indexOf, isActive, isDisabled, 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, getOriginalValues, getOriginalVersion, getState, getValidation, getValues, getValuesHistory, getVersion, getVersionedField, hasChanges, hasErrors, hasErrors, hasHistory, isDeleted, isValid, maybePopHistory, newVersionValues, pushHistory, pushHistory, resetHistory, setDeleted, setEditState, setHistory, setIndexedId, setItemType, setValues

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, 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, getOriginalValues, getValues, getValuesHistory, hasErrors, pushHistory, skipField

Field Details

OBJECT_NAME

public static final String OBJECT_NAME

Object name.

LIST_NAME

public static final String LIST_NAME

List name.

WRAPLEN

public static final int WRAPLEN

KeySetWrapLength.

Constructor Details

PrometheusControlKeySet

protected PrometheusControlKeySet(PrometheusControlKeySet.PrometheusControlKeySetList pList,
 PrometheusControlKeySet pSource)

Copy Constructor.

Parameters:

pList - the list the copy belongs to

pSource - The Key to copy

PrometheusControlKeySet

protected PrometheusControlKeySet(PrometheusControlKeySet.PrometheusControlKeySetList pList,
 PrometheusControlKey pControlKey)
                           throws OceanusException

Constructor for a new DataKeySet.

Parameters:

pList - the list to which to add the keySet to

pControlKey - the control key

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

getSecurityFactory

GordianFactory getSecurityFactory()

Obtain the security factory.

Returns:

the security factory

getNextDataKeySet

PrometheusDataKeySet getNextDataKeySet()

Obtain the next DataKeySet.

Returns:

the next dataKeySet

getControlKey

public final PrometheusControlKey getControlKey()

Get the ControlKey.

Returns:

the controlKey

getControlKeyId

public Integer getControlKeyId()

Get the ControlKeyId for this item.

Returns:

the ControlKeyId

getSecuredKeySetDef

public final byte[] getSecuredKeySetDef()

Get the securedKeySetDef.

Returns:

the securedKeySetDef

getKeySet

public GordianKeySet getKeySet()

Get the KeySet.

Returns:

the keySet

getBase

public PrometheusControlKeySet getBase()

Description copied from class: PrometheusDataItem

Get the base item for this item.

Overrides:

getBase in class PrometheusDataItem

Returns:

the Base item or null

getList

public PrometheusControlKeySet.PrometheusControlKeySetList getList()

Description copied from class: PrometheusDataItem

Obtain the list.

Overrides:

getList in class PrometheusDataItem

Returns:

the list

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

resolveDataSetLinks

public void resolveDataSetLinks()
                         throws OceanusException

Description copied from class: PrometheusDataItem

Resolve all references to current dataSet.

Overrides:

resolveDataSetLinks in class PrometheusDataItem

Throws:

OceanusException - on error

deleteControlKeySet

protected void deleteControlKeySet()

Delete the old ControlKeySet and DataKeySets.

registerDataKeySet

void registerDataKeySet(PrometheusDataKeySet pKeySet)

Register DataKeySet.

Parameters:

pKeySet - the DataKeySet to register