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

Package io.github.tonywasher.joceanus.prometheus.maps

Class PrometheusMapsTouchCtl

java.lang.Object

io.github.tonywasher.joceanus.prometheus.maps.PrometheusMapsTouchCtl

All Implemented Interfaces:

MetisDataItem.MetisDataObjectFormat, MetisFieldItem

public class PrometheusMapsTouchCtl
extends Object
implements MetisFieldItem

DataTouchMap for data/EditSet.

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
PrometheusMapsTouchCtl()	Constructor.

Method Summary

Modifier and Type	Method	Description
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
(package private) boolean	isTouched(PrometheusDataItem pItem)	Is the item touched?
(package private) void	recordTouch(PrometheusDataItem pTouchedItem, PrometheusDataItem pTouchingItem)	Record touch.
(package private) void	resetMap()	Reset the map.
(package private) void	setVersion(Integer pVersion)	Set version.

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusMapsTouchCtl

PrometheusMapsTouchCtl()

Constructor.

Method Details

getDataFieldSet

public MetisFieldItem.MetisFieldSetDef 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

setVersion

void setVersion(Integer pVersion)

Set version.

Parameters:

pVersion - the version

recordTouch

void recordTouch(PrometheusDataItem pTouchedItem,
 PrometheusDataItem pTouchingItem)

Record touch.

Parameters:

pTouchedItem - the item that is touched

pTouchingItem - the item that touches

isTouched

boolean isTouched(PrometheusDataItem pItem)

Is the item touched?

Parameters:

pItem - the item

Returns:

true/false

resetMap

void resetMap()

Reset the map.