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

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

Class PrometheusDataSet

java.lang.Object

io.github.tonywasher.joceanus.prometheus.data.PrometheusDataSet

All Implemented Interfaces:

MetisDataItem.MetisDataObjectFormat, MetisFieldItem, PrometheusDataList.PrometheusDataListSet

public abstract class PrometheusDataSet
extends Object
implements MetisFieldItem, PrometheusDataList.PrometheusDataListSet

DataSet definition and list. A DataSet is a set of DataLists backed by the three security lists.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PrometheusDataSet.PrometheusCryptographyDataType	Cryptography Data Enum Types.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	HASH_PRIME	The Hash prime.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusDataSet(PrometheusDataSet pSource)	Constructor for a cloned DataSet.
protected	PrometheusDataSet(PrometheusToolkit pToolkit)	Constructor for new empty DataSet.

Method Summary

Modifier and Type	Method	Description
protected void	addList(MetisListKey pListType, PrometheusDataList<?> pList)	Add DataList to list of lists.
protected void	buildEmptyCloneSet(PrometheusDataSet pSource)	Build an empty clone dataSet.
void	checkSecurity(TethysUIThreadStatusReport pReport)	Check Security for incomplete security operations.
abstract PrometheusDataSet	deriveCloneSet()	Construct a Clone for a DataSet.
protected void	deriveCloneSet(PrometheusDataSet pSource)	Construct a Clone for a DataSet.
protected void	deriveDifferences(TethysUIThreadStatusReport pReport, PrometheusDataSet pNew, PrometheusDataSet pOld)	Construct a difference extract between two DataSets.
abstract PrometheusDataSet	deriveUpdateSet()	Construct an update extract for a FinanceData Set.
protected void	deriveUpdateSet(PrometheusDataSet pSource)	Construct an update extract for a DataSet.
Iterator<Map.Entry<MetisListKey,PrometheusDataList<?>>>	entryIterator()	Obtain list iterator.
boolean	equals(Object pThat)
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
PrometheusControlData	getControl()	Get the control record.
PrometheusControlData.PrometheusControlDataList	getControlData()	Get ControlData.
PrometheusControlKey	getControlKey()	Get the active control key.
PrometheusControlKey.PrometheusControlKeyList	getControlKeys()	Get ControlKeys.
PrometheusControlKeySet.PrometheusControlKeySetList	getControlKeySets()	Get ControlKeySets.
OceanusDataFormatter	getDataFormatter()	Obtain the data formatter.
PrometheusDataKeySet.PrometheusDataKeySetList	getDataKeySets()	Get DataKeySets.
<L extends PrometheusDataList<?>> L	getDataList(MetisListKey pListType, Class<L> pListClass)	Obtain the list for a class.
<L extends PrometheusDataList<?>> L	getDataList(Class<L> pListClass)	Obtain DataList for an list class.
abstract PrometheusDataSet	getDifferenceSet(TethysUIThreadStatusReport pReport, PrometheusDataSet pOld)	Construct a difference extract between two DataSets.
GordianFactory.GordianFactoryLock	getFactoryLock()	Get the Password Hash.
protected Object	getFieldListValue(MetisListKey pListType)	Obtain debug value for list.
GordianKeySetSpec	getKeySetSpec()	Get KeySetSpec.
protected Map<MetisListKey,PrometheusDataList<?>>	getListMap()	Get List Map.
int	getNumActiveKeySets()	Get Number of activeKeySets.
PrometheusSecurityPasswordManager	getPasswordMgr()	Get Password Manager.
(package private) PrometheusDataValidator	getValidator(MetisListKey pItemType)	Obtain a validator fot=r the itemType.
int	getVersion()	Get Version.
boolean	hasDataType(MetisListKey pDataType)	Does this list have the dataType?
int	hashCode()
boolean	hasUpdates()	Determine whether the Data-set has updates.
void	initialiseSecurity(TethysUIThreadStatusReport pReport, PrometheusDataSet pBase)	Initialise Security from database (if present).
boolean	isEmpty()	Determine whether a DataSet has entries.
Iterator<PrometheusDataList<?>>	iterator()	Obtain list iterator.
Iterator<MetisListKey>	keyIterator()	Obtain listKey iterator.
void	reBase(TethysUIThreadStatusReport pReport, PrometheusDataSet pOld)	ReBase this data set against an earlier version.
void	renewSecurity(TethysUIThreadStatusReport pReport)	Renew Security.
void	resetChanges()	Reset changes in a dataSet.
void	rewindToVersion(int pVersion)	Rewind items to the required version.
void	setValidatorFactory(PrometheusDataValidator.PrometheusDataValidatorFactory pFactory)	Set the validator factory.
void	setVersion(int pVersion)	Set Version.
void	undoLastChange()	Undo changes in a dataSet.
void	updateFactoryLock(TethysUIThreadStatusReport pReport, String pSource)	Update data with a new password.
void	updateSecurity(TethysUIThreadStatusReport pReport)	Update Security.

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.field.MetisFieldItem

getDataFieldSet

Field Details

HASH_PRIME

protected static final int HASH_PRIME

The Hash prime.

See Also:

• Constant Field Values

Constructor Details

PrometheusDataSet

protected PrometheusDataSet(PrometheusToolkit pToolkit)

Constructor for new empty DataSet.

Parameters:

pToolkit - the toolkit set

PrometheusDataSet

protected PrometheusDataSet(PrometheusDataSet pSource)

Constructor for a cloned DataSet.

Parameters:

pSource - the source DataSet

Method Details

formatObject

public String formatObject(OceanusDataFormatter pFormatter)

Description copied from interface: MetisDataItem.MetisDataObjectFormat

Obtain Object summary.

Specified by:

formatObject in interface MetisDataItem.MetisDataObjectFormat

Parameters:

pFormatter - the data formatter

Returns:

the display summary of the object

getDataFormatter

public OceanusDataFormatter getDataFormatter()

Obtain the data formatter.

Returns:

the formatter

setValidatorFactory

public void setValidatorFactory(PrometheusDataValidator.PrometheusDataValidatorFactory pFactory)

Set the validator factory.

Parameters:

pFactory - the validator factory

getValidator

PrometheusDataValidator getValidator(MetisListKey pItemType)

Obtain a validator fot=r the itemType.

Parameters:

pItemType - the itemType

Returns:

the validator.

getPasswordMgr

public PrometheusSecurityPasswordManager getPasswordMgr()

Get Password Manager.

Returns:

the password manager

getControlKeys

public PrometheusControlKey.PrometheusControlKeyList getControlKeys()

Get ControlKeys.

Returns:

the controlKeys

getControlKeySets

public PrometheusControlKeySet.PrometheusControlKeySetList getControlKeySets()

Get ControlKeySets.

Returns:

the controlKeySets

getDataKeySets

public PrometheusDataKeySet.PrometheusDataKeySetList getDataKeySets()

Get DataKeySets.

Returns:

the dataKeySets

getControlData

public PrometheusControlData.PrometheusControlDataList getControlData()

Get ControlData.

Returns:

the controlData

getVersion

public int getVersion()

Get Version.

Returns:

the version

getNumActiveKeySets

public int getNumActiveKeySets()

Get Number of activeKeySets.

Returns:

the # active KeySets

getKeySetSpec

public GordianKeySetSpec getKeySetSpec()

Get KeySetSpec.

Returns:

the keySetSpec

getListMap

protected Map<MetisListKey,PrometheusDataList<?>> getListMap()

Get List Map.

Returns:

the list map

hasDataType

public boolean hasDataType(MetisListKey pDataType)

Description copied from interface: PrometheusDataList.PrometheusDataListSet

Does this list have the dataType?

Specified by:

hasDataType in interface PrometheusDataList.PrometheusDataListSet

Parameters:

pDataType - the dataType

Returns:

true/false

deriveCloneSet

public abstract PrometheusDataSet deriveCloneSet()
                                          throws OceanusException

Construct a Clone for a DataSet.

Returns:

the extract

Throws:

OceanusException - on error

buildEmptyCloneSet

protected void buildEmptyCloneSet(PrometheusDataSet pSource)
                           throws OceanusException

Build an empty clone dataSet.

Parameters:

pSource - the source DataSet

Throws:

OceanusException - on error

deriveCloneSet

protected void deriveCloneSet(PrometheusDataSet pSource)
                       throws OceanusException

Construct a Clone for a DataSet.

Parameters:

pSource - the source DataSet

Throws:

OceanusException - on error

deriveUpdateSet

public abstract PrometheusDataSet deriveUpdateSet()
                                           throws OceanusException

Construct an update extract for a FinanceData Set.

Returns:

the extract

Throws:

OceanusException - on error

deriveUpdateSet

protected void deriveUpdateSet(PrometheusDataSet pSource)
                        throws OceanusException

Construct an update extract for a DataSet.

Parameters:

pSource - the source of the extract

Throws:

OceanusException - on error

getDifferenceSet

public abstract PrometheusDataSet getDifferenceSet(TethysUIThreadStatusReport pReport,
 PrometheusDataSet pOld)
                                            throws OceanusException

Construct a difference extract between two DataSets. The difference extract will only contain items that differ between the two DataSets. Items that are in the new list, but not in the old list will be viewed as inserted. Items that are in the old list but not in the new list will be viewed as deleted. Items that are in both list but differ will be viewed as changed

Parameters:

pReport - the report

pOld - The old list to extract from

Returns:

the difference set

Throws:

OceanusException - on error

deriveDifferences

protected void deriveDifferences(TethysUIThreadStatusReport pReport,
 PrometheusDataSet pNew,
 PrometheusDataSet pOld)
                          throws OceanusException

Construct a difference extract between two DataSets. The difference extract will only contain items that differ between the two DataSets. Items that are in the new list, but not in the old list will be viewed as inserted. Items that are in the old list but not in the new list will be viewed as deleted. Items that are in both list but differ will be viewed as changed

Parameters:

pReport - the report

pNew - The new list to compare

pOld - The old list to compare

Throws:

OceanusException - on error

reBase

public void reBase(TethysUIThreadStatusReport pReport,
 PrometheusDataSet pOld)
            throws OceanusException

ReBase this data set against an earlier version.

Parameters:

pReport - the report

pOld - The old data to reBase against

Throws:

OceanusException - on error

addList

protected void addList(MetisListKey pListType,
 PrometheusDataList<?> pList)

Add DataList to list of lists.

Parameters:

pListType - the list type

pList - the list to add

getDataList

public <L extends PrometheusDataList<?>> L getDataList(MetisListKey pListType,
 Class<L> pListClass)

Description copied from interface: PrometheusDataList.PrometheusDataListSet

Obtain the list for a class.

Specified by:

getDataList in interface PrometheusDataList.PrometheusDataListSet

Type Parameters:

L - the list type

Parameters:

pListType - the data type

pListClass - the list class

Returns:

the list

getFieldListValue

protected Object getFieldListValue(MetisListKey pListType)

Obtain debug value for list.

Parameters:

pListType - the list type

Returns:

true/false

getDataList

public <L extends PrometheusDataList<?>> L getDataList(Class<L> pListClass)

Obtain DataList for an list class.

Type Parameters:

L - the List type

Parameters:

pListClass - the class of the list

Returns:

the list of items

setVersion

public void setVersion(int pVersion)

Set Version.

Parameters:

pVersion - the version

rewindToVersion

public void rewindToVersion(int pVersion)

Rewind items to the required version.

Parameters:

pVersion - the version to rewind to

equals

public boolean equals(Object pThat)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Determine whether a DataSet has entries.

Returns:

true if the DataSet has entries

hasUpdates

public boolean hasUpdates()

Determine whether the Data-set has updates.

Returns:

true if the Data-set has updates, false if not

getControl

public PrometheusControlData getControl()

Get the control record.

Returns:

the control record

getControlKey

public PrometheusControlKey getControlKey()

Get the active control key.

Returns:

the control key

initialiseSecurity

public void initialiseSecurity(TethysUIThreadStatusReport pReport,
 PrometheusDataSet pBase)
                        throws OceanusException

Initialise Security from database (if present).

Parameters:

pReport - the report

pBase - the database data

Throws:

OceanusException - on error

renewSecurity

public void renewSecurity(TethysUIThreadStatusReport pReport)
                   throws OceanusException

Renew Security.

Parameters:

pReport - the report

Throws:

OceanusException - on error

checkSecurity

public void checkSecurity(TethysUIThreadStatusReport pReport)
                   throws OceanusException

Check Security for incomplete security operations.

Parameters:

pReport - the report

Throws:

OceanusException - on error

updateSecurity

public void updateSecurity(TethysUIThreadStatusReport pReport)
                    throws OceanusException

Update Security.

Parameters:

pReport - the report

Throws:

OceanusException - on error

getFactoryLock

public GordianFactory.GordianFactoryLock getFactoryLock()
                                                 throws OceanusException

Get the Password Hash.

Returns:

the password hash

Throws:

OceanusException - on error

updateFactoryLock

public void updateFactoryLock(TethysUIThreadStatusReport pReport,
 String pSource)
                       throws OceanusException

Update data with a new password.

Parameters:

pReport - the report

pSource - the source of the data

Throws:

OceanusException - on error

undoLastChange

public void undoLastChange()

Undo changes in a dataSet.

resetChanges

public void resetChanges()

Reset changes in a dataSet.

iterator

public Iterator<PrometheusDataList<?>> iterator()

Obtain list iterator.

Returns:

the iterator

entryIterator

public Iterator<Map.Entry<MetisListKey,PrometheusDataList<?>>> entryIterator()

Obtain list iterator.

Returns:

the iterator

keyIterator

public Iterator<MetisListKey> keyIterator()

Obtain listKey iterator.

Returns:

the iterator