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

Package io.github.tonywasher.joceanus.prometheus.views

Class PrometheusEditSet

java.lang.Object

io.github.tonywasher.joceanus.prometheus.views.PrometheusEditSet

All Implemented Interfaces:

MetisDataItem.MetisDataObjectFormat, MetisFieldItem, OceanusEventRegistrar.OceanusEventProvider<PrometheusDataEvent>, PrometheusDataList.PrometheusDataListSet

public class PrometheusEditSet
extends Object
implements MetisFieldItem, OceanusEventRegistrar.OceanusEventProvider<PrometheusDataEvent>, PrometheusDataList.PrometheusDataListSet

Provides control of a set of update-able DataLists.

Nested Class Summary

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

Constructor Summary

Constructors

Constructor	Description
PrometheusEditSet(PrometheusDataControl pControl)	Constructor for an update list.
PrometheusEditSet(PrometheusDataControl pControl, PrometheusDataSet pDataSet)	Constructor for an update list.

Method Summary

Modifier and Type	Method	Description
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
MetisFieldSet<PrometheusEditSet>	getDataFieldSet()	Obtain the fieldSet.
<L extends PrometheusDataList<?>> L	getDataList(MetisListKey pDataType, Class<L> pClass)	Obtain the list for a class.
PrometheusDataSet	getDataSet()	Obtain the dataSet.
MetisDataEditState	getEditState()	Get the edit state of this set of tables.
OceanusEventRegistrar<PrometheusDataEvent>	getEventRegistrar()	Obtain registration object for listeners.
int	getVersion()	Obtain the version.
boolean	hasDataType(MetisListKey pDataType)	Does this list have the dataType?
boolean	hasErrors()	Has this UpdateSet got errors?
boolean	hasUpdates()	Has this UpdateSet got updates?
void	incrementVersion()	Increment Version.
Boolean	isEditing()	Is the item editing?
Iterator<MetisListKey>	keyIterator()	Obtain an iterator over the listKeys.
Iterator<PrometheusEditEntry<?>>	listIterator()	Obtain an iterator over the listKeys.
void	processCommand(PrometheusUIEvent pCmd, MetisErrorPanel pError)	Process Save command.
void	processEditCommand(PrometheusUIEvent pCmd, int pVersion, MetisErrorPanel pError)	Process Edit command.
<T extends PrometheusDataItem> PrometheusEditEntry<T>	registerType(MetisListKey pDataType)	Register an entry for a class.
void	setDataSet(PrometheusDataSet pDataSet)	Set the dataSet.
<T extends PrometheusDataItem> void	setEditEntryList(MetisListKey pDataType, PrometheusDataList<T> pList)	Set the editEntry for a type.
void	setEditing(Boolean pFlag)	Set editing flag.
void	validate()	Validate the updateSet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrometheusEditSet

public PrometheusEditSet(PrometheusDataControl pControl)

Constructor for an update list.

Parameters:

pControl - the Data Control

PrometheusEditSet

public PrometheusEditSet(PrometheusDataControl pControl,
 PrometheusDataSet pDataSet)

Constructor for an update list.

Parameters:

pControl - the Data Control

pDataSet - the DataSet

Method Details

getDataFieldSet

public MetisFieldSet<PrometheusEditSet> getDataFieldSet()

Description copied from interface: MetisFieldItem

Obtain the fieldSet.

Specified by:

getDataFieldSet in interface MetisFieldItem

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

Parameters:

pFormatter - the data formatter

Returns:

the display summary of the object

getEventRegistrar

public OceanusEventRegistrar<PrometheusDataEvent> getEventRegistrar()

Description copied from interface: OceanusEventRegistrar.OceanusEventProvider

Obtain registration object for listeners.

Specified by:

getEventRegistrar in interface OceanusEventRegistrar.OceanusEventProvider<PrometheusDataEvent>

Returns:

the registrar

setEditing

public void setEditing(Boolean pFlag)

Set editing flag.

Parameters:

pFlag - the editing flag

isEditing

public Boolean isEditing()

Is the item editing?

Returns:

true/false

getVersion

public int getVersion()

Obtain the version.

Returns:

the version

getDataSet

public PrometheusDataSet getDataSet()

Obtain the dataSet.

Returns:

the dataSet

setDataSet

public void setDataSet(PrometheusDataSet pDataSet)

Set the dataSet.

Parameters:

pDataSet - the dataSet

registerType

public <T extends PrometheusDataItem>
PrometheusEditEntry<T> registerType(MetisListKey pDataType)

Register an entry for a class.

Type Parameters:

T - the object type

Parameters:

pDataType - the data type

Returns:

the list class entry

getDataList

public <L extends PrometheusDataList<?>> L getDataList(MetisListKey pDataType,
 Class<L> pClass)

Obtain the list for a class.

Will look first for the list in the updateSet and then in the underlying data.

Specified by:

getDataList in interface PrometheusDataList.PrometheusDataListSet

Type Parameters:

L - the list type

Parameters:

pDataType - the data type

pClass - the list class

Returns:

the list

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

setEditEntryList

public <T extends PrometheusDataItem> void setEditEntryList(MetisListKey pDataType,
 PrometheusDataList<T> pList)

Set the editEntry for a type.

Type Parameters:

T - the dataType

Parameters:

pDataType - the data type

pList - the list

keyIterator

public Iterator<MetisListKey> keyIterator()

Obtain an iterator over the listKeys.

Returns:

the iterator

listIterator

public Iterator<PrometheusEditEntry<?>> listIterator()

Obtain an iterator over the listKeys.

Returns:

the iterator

incrementVersion

public void incrementVersion()

Increment Version.

hasUpdates

public boolean hasUpdates()

Has this UpdateSet got updates?

Returns:

true/false

hasErrors

public boolean hasErrors()

Has this UpdateSet got errors?

Returns:

true/false

validate

public void validate()

Validate the updateSet.

getEditState

public MetisDataEditState getEditState()

Get the edit state of this set of tables.

Returns:

the edit state

processCommand

public void processCommand(PrometheusUIEvent pCmd,
 MetisErrorPanel pError)

Process Save command.

Parameters:

pCmd - the command.

pError - the error panel

processEditCommand

public void processEditCommand(PrometheusUIEvent pCmd,
 int pVersion,
 MetisErrorPanel pError)

Process Edit command.

Parameters:

pCmd - the command.

pVersion - the version

pError - the error panel