Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.field

Class MetisFieldVersionedItem

java.lang.Object

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

All Implemented Interfaces:

MetisDataItem.MetisDataDeletableItem, MetisDataItem.MetisDataIndexedItem, MetisDataItem.MetisDataObjectFormat, MetisFieldItem, MetisFieldItem.MetisFieldTableItem, MetisFieldVersion.MetisFieldUpdatableItem, MetisFieldVersion.MetisFieldVersionedItemCtl

Direct Known Subclasses:

PrometheusDataItem

public abstract class MetisFieldVersionedItem
extends Object
implements MetisFieldVersion.MetisFieldVersionedItemCtl

Data Version Control.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem

MetisFieldItem.MetisFieldDef, MetisFieldItem.MetisFieldItemType, MetisFieldItem.MetisFieldSetCtl<T extends MetisFieldItem>, MetisFieldItem.MetisFieldSetDef, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldVersionedDef

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetisFieldVersionedItem()	Constructor.
protected	MetisFieldVersionedItem(MetisFieldVersionValues pValues)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addError(String pError, MetisDataItem.MetisDataFieldId pFieldId)	Add an error for this item.
void	adjustState()	Adjust State of item.
boolean	checkForHistory()	Check to see whether any changes were made.
void	clearErrors()	Clear all errors for this item.
void	clearHistory()	Clear history.
void	condenseHistory(int pNewVersion)	Condense history.
MetisDataDifference	fieldChanged(MetisDataItem.MetisDataFieldId pField)	Determines whether a particular field has changed.
MetisDataDifference	fieldChanged(MetisFieldItem.MetisFieldDef pField)	Determines whether a particular field has changed.
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
MetisDataEditState	getEditState()	Obtain the editState of item.
String	getFieldErrors(MetisDataItem.MetisDataFieldId pField)	Obtain error details for a field.
String	getFieldErrors(MetisDataItem.MetisDataFieldId[] pFields)	Obtain error details for a set of fields.
MetisFieldValidation.MetisFieldError	getFirstError()	Get the first error element for an item.
Integer	getIndexedId()	Get the Id to index the list.
MetisFieldItem.MetisFieldItemType	getItemType()	Obtain the itemType.
MetisFieldVersionValues	getOriginalValues()	Obtain original Object ValueSet.
Integer	getOriginalVersion()	Obtain the original Version of item.
MetisDataState	getState()	Obtain the State of item.
MetisFieldValidation	getValidation()	Obtain the Validation.
MetisFieldVersionValues	getValues()	Obtain Object ValueSet.
MetisFieldVersionHistory	getValuesHistory()	Obtain Object ValueSet History.
Integer	getVersion()	Obtain the Version of item.
MetisFieldItem.MetisFieldVersionedDef	getVersionedField(MetisDataItem.MetisDataFieldId pId)	Obtain a versioned field.
boolean	hasChanges()	Determine whether the item has Changes.
boolean	hasErrors()	Determine whether the item has Errors.
boolean	hasErrors(MetisDataItem.MetisDataFieldId pFieldId)	Determine whether a particular field has Errors.
boolean	hasHistory()	Is there any history.
boolean	isDeleted()	Is this item deleted?
boolean	isValid()	Determine whether the item is Valid.
boolean	maybePopHistory()	popItem from the history if equal to current.
protected MetisFieldVersionValues	newVersionValues()	Obtain new version values.
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	pushHistory(int pVersion)	Push history to a specific version.
void	resetHistory()	Reset history.
void	rewindToVersion(int pVersion)	Rewind item to the required version.
void	setDeleted(boolean pFlag)	Set the deleted flags for the item.
protected void	setEditState(MetisDataEditState pState)	Set the Edit State.
void	setHistory(MetisFieldVersionValues pBase)	Set history explicitly.
void	setIndexedId(Integer pId)	Set Id.
void	setItemType(MetisFieldItem.MetisFieldItemType pItemType)	Set ItemType.
void	setValues(MetisFieldVersionValues pValues)	Initialise the current values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataDeletableItem

isActive

Methods inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldVersion.MetisFieldUpdatableItem

getNextVersion, isEditable, skipField

Constructor Details

MetisFieldVersionedItem

protected MetisFieldVersionedItem()

Constructor.

MetisFieldVersionedItem

protected MetisFieldVersionedItem(MetisFieldVersionValues pValues)

Constructor.

Parameters:

pValues - the initial values

Method Details

newVersionValues

protected MetisFieldVersionValues newVersionValues()

Obtain new version values.

Returns:

new values

getIndexedId

public Integer getIndexedId()

Description copied from interface: MetisDataItem.MetisDataIndexedItem

Get the Id to index the list.

Specified by:

getIndexedId in interface MetisDataItem.MetisDataIndexedItem

Returns:

the Id

setIndexedId

public void setIndexedId(Integer pId)

Set Id.

Parameters:

pId - the Id

getItemType

public MetisFieldItem.MetisFieldItemType getItemType()

Obtain the itemType.

Returns:

the item type

setItemType

public void setItemType(MetisFieldItem.MetisFieldItemType pItemType)

Set ItemType.

Parameters:

pItemType - the itemType

getState

public MetisDataState getState()

Obtain the State of item.

Returns:

the state

getEditState

public MetisDataEditState getEditState()

Obtain the editState of item.

Returns:

the editState

getValuesHistory

public MetisFieldVersionHistory getValuesHistory()

Description copied from interface: MetisFieldVersion.MetisFieldUpdatableItem

Obtain Object ValueSet History.

Specified by:

getValuesHistory in interface MetisFieldVersion.MetisFieldUpdatableItem

Returns:

the ValueSet of the object

getValidation

public MetisFieldValidation getValidation()

Obtain the Validation.

Returns:

the validation

getValues

public MetisFieldVersionValues getValues()

Description copied from interface: MetisFieldVersion.MetisFieldUpdatableItem

Obtain Object ValueSet.

Specified by:

getValues in interface MetisFieldVersion.MetisFieldUpdatableItem

Returns:

the ValueSet of the object

getOriginalValues

public MetisFieldVersionValues getOriginalValues()

Description copied from interface: MetisFieldVersion.MetisFieldUpdatableItem

Obtain original Object ValueSet.

Specified by:

getOriginalValues in interface MetisFieldVersion.MetisFieldUpdatableItem

Returns:

the ValueSet of the object

getVersion

public Integer getVersion()

Obtain the Version of item.

Returns:

the version

getOriginalVersion

public Integer getOriginalVersion()

Obtain the original Version of item.

Returns:

the version

isDeleted

public boolean isDeleted()

Description copied from interface: MetisDataItem.MetisDataDeletableItem

Is this item deleted?

Specified by:

isDeleted in interface MetisDataItem.MetisDataDeletableItem

Returns:

true/false

setDeleted

public void setDeleted(boolean pFlag)

Description copied from interface: MetisDataItem.MetisDataDeletableItem

Set the deleted flags for the item.

Specified by:

setDeleted in interface MetisDataItem.MetisDataDeletableItem

Parameters:

pFlag - true/false

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

setEditState

protected void setEditState(MetisDataEditState pState)

Set the Edit State.

Parameters:

pState - the Edit Status

hasErrors

public boolean hasErrors()

Determine whether the item has Errors.

Returns:

true/false

hasChanges

public boolean hasChanges()

Determine whether the item has Changes.

Returns:

true/false

isValid

public boolean isValid()

Determine whether the item is Valid.

Returns:

true/false

hasErrors

public boolean hasErrors(MetisDataItem.MetisDataFieldId pFieldId)

Description copied from interface: MetisFieldVersion.MetisFieldUpdatableItem

Determine whether a particular field has Errors.

Specified by:

hasErrors in interface MetisFieldVersion.MetisFieldUpdatableItem

Parameters:

pFieldId - the particular field

Returns:

true/false

addError

public void addError(String pError,
 MetisDataItem.MetisDataFieldId pFieldId)

Add an error for this item.

Parameters:

pError - the error text

pFieldId - the associated field

clearErrors

public void clearErrors()

Clear all errors for this item.

getFirstError

public MetisFieldValidation.MetisFieldError getFirstError()

Get the first error element for an item.

Returns:

the first error (or null)

getFieldErrors

public String getFieldErrors(MetisDataItem.MetisDataFieldId pField)

Description copied from interface: MetisFieldVersion.MetisFieldUpdatableItem

Obtain error details for a field.

Specified by:

getFieldErrors in interface MetisFieldVersion.MetisFieldUpdatableItem

Parameters:

pField - the field

Returns:

the error details

getFieldErrors

public String getFieldErrors(MetisDataItem.MetisDataFieldId[] pFields)

Description copied from interface: MetisFieldVersion.MetisFieldUpdatableItem

Obtain error details for a set of fields.

Specified by:

getFieldErrors in interface MetisFieldVersion.MetisFieldUpdatableItem

Parameters:

pFields - the fields

Returns:

the error details

setValues

public void setValues(MetisFieldVersionValues pValues)

Initialise the current values.

Parameters:

pValues - the current values

pushHistory

public void pushHistory()

Description copied from interface: MetisFieldVersion.MetisFieldUpdatableItem

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

Specified by:

pushHistory in interface MetisFieldVersion.MetisFieldUpdatableItem

pushHistory

public void pushHistory(int pVersion)

Push history to a specific version.

Parameters:

pVersion - the version

popHistory

public void popHistory()

Description copied from interface: MetisFieldVersion.MetisFieldUpdatableItem

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

Specified by:

popHistory in interface MetisFieldVersion.MetisFieldUpdatableItem

maybePopHistory

public boolean maybePopHistory()

popItem from the history if equal to current.

Returns:

was a change made

hasHistory

public boolean hasHistory()

Is there any history.

Returns:

whether there are entries in the history list

clearHistory

public void clearHistory()

Clear history.

resetHistory

public void resetHistory()

Reset history.

setHistory

public void setHistory(MetisFieldVersionValues pBase)

Set history explicitly.

Parameters:

pBase - the base item

checkForHistory

public boolean checkForHistory()

Description copied from interface: MetisFieldVersion.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 MetisFieldVersion.MetisFieldUpdatableItem

Returns:

true if changes were made, false otherwise

condenseHistory

public void condenseHistory(int pNewVersion)

Condense history.

Parameters:

pNewVersion - the new maximum version

rewindToVersion

public void rewindToVersion(int pVersion)

Rewind item to the required version.

Parameters:

pVersion - the version to rewind to

fieldChanged

public MetisDataDifference fieldChanged(MetisDataItem.MetisDataFieldId pField)

Determines whether a particular field has changed.

Parameters:

pField - the field

Returns:

the difference

fieldChanged

public MetisDataDifference fieldChanged(MetisFieldItem.MetisFieldDef pField)

Determines whether a particular field has changed.

Parameters:

pField - the field

Returns:

the difference

adjustState

public void adjustState()

Adjust State of item.

getVersionedField

public MetisFieldItem.MetisFieldVersionedDef getVersionedField(MetisDataItem.MetisDataFieldId pId)

Obtain a versioned field.

Parameters:

pId - the field id

Returns:

the versioned field