Module io.github.tonywasher.joceanus.metis

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

Class MetisFieldVersionValues

java.lang.Object

io.github.tonywasher.joceanus.metis.field.MetisFieldVersionValues

All Implemented Interfaces:

MetisFieldVersion.MetisFieldVersionValuesCtl

Direct Known Subclasses:

PrometheusEncryptedValues

public class MetisFieldVersionValues
extends Object
implements MetisFieldVersion.MetisFieldVersionValuesCtl

Set of dataValues.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ERROR_NOTVERSIONED	The versioned error.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetisFieldVersionValues(MetisFieldVersion.MetisFieldVersionedItemCtl pItem)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	checkValueType(MetisFieldItem.MetisFieldDef pField, Object pValue)	Check the value.
MetisFieldVersionValues	cloneIt()	Clone this ValueSet.
void	copyFrom(MetisFieldVersionValues pPrevious)	Initialise values from a previous set.
MetisDataDifference	differs(MetisFieldVersionValues pOriginal)	Check for differences.
boolean	equals(Object pThat)
MetisDataDifference	fieldChanged(MetisDataItem.MetisDataFieldId pFieldId, MetisFieldVersionValues pOriginal)	Check for a difference in a particular field.
MetisDataDifference	fieldChanged(MetisFieldItem.MetisFieldDef pField, MetisFieldVersionValues pOriginal)	Check for a difference in a particular field.
MetisFieldItem.MetisFieldSetDef	getFields()	Obtain the field definitions.
protected MetisFieldVersion.MetisFieldVersionedItemCtl	getItem()	Obtain the underlying item.
Object	getValue(MetisDataItem.MetisDataFieldId pFieldId)	Get the value.
<X> X	getValue(MetisDataItem.MetisDataFieldId pFieldId, Class<X> pClazz)	Get the value.
Object	getValue(MetisFieldItem.MetisFieldDef pField)	Get the value.
<X> X	getValue(MetisFieldItem.MetisFieldDef pField, Class<X> pClazz)	Get the value as an object type.
int	getVersion()	Obtain the version # of the values.
int	hashCode()
boolean	isDeletion()	Determine if this object is a record of a deletion event.
void	setDeletion(boolean pDeletion)	Adjust deletion flag.
void	setUncheckedValue(MetisDataItem.MetisDataFieldId pFieldId, Object pValue)	Set the value.
void	setUncheckedValue(MetisFieldItem.MetisFieldDef pField, Object pValue)	Set the unchecked value.
void	setValue(MetisDataItem.MetisDataFieldId pFieldId, Object pValue)	Set the value.
void	setValue(MetisFieldItem.MetisFieldDef pField, Object pValue)	Set the value.
void	setVersion(int pVersion)	Set the version # of the values.

Methods inherited from class java.lang.Object

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

Field Details

ERROR_NOTVERSIONED

protected static final String ERROR_NOTVERSIONED

The versioned error.

See Also:

• Constant Field Values

Constructor Details

MetisFieldVersionValues

protected MetisFieldVersionValues(MetisFieldVersion.MetisFieldVersionedItemCtl pItem)

Constructor.

Parameters:

pItem - the associated item

Method Details

getFields

public MetisFieldItem.MetisFieldSetDef getFields()

Obtain the field definitions.

Returns:

the field definitions

getItem

protected MetisFieldVersion.MetisFieldVersionedItemCtl getItem()

Obtain the underlying item.

Returns:

the item

getVersion

public int getVersion()

Obtain the version # of the values.

Returns:

the version #

setVersion

public void setVersion(int pVersion)

Set the version # of the values.

Parameters:

pVersion - the version #

isDeletion

public boolean isDeletion()

Determine if this object is a record of a deletion event.

Returns:

true/false

setDeletion

public void setDeletion(boolean pDeletion)

Adjust deletion flag.

Parameters:

pDeletion - true/false

cloneIt

public MetisFieldVersionValues cloneIt()

Clone this ValueSet.

Returns:

the cloned set

copyFrom

public void copyFrom(MetisFieldVersionValues pPrevious)

Initialise values from a previous set.

Parameters:

pPrevious - the previous valueSet

setValue

public void setValue(MetisDataItem.MetisDataFieldId pFieldId,
 Object pValue)
              throws OceanusException

Set the value.

Parameters:

pFieldId - the fieldId

pValue - the value

Throws:

OceanusException - on error

setValue

public void setValue(MetisFieldItem.MetisFieldDef pField,
 Object pValue)
              throws OceanusException

Set the value.

Parameters:

pField - the field

pValue - the value

Throws:

OceanusException - on error

setUncheckedValue

public void setUncheckedValue(MetisDataItem.MetisDataFieldId pFieldId,
 Object pValue)

Set the value.

Parameters:

pFieldId - the fieldId

pValue - the value

setUncheckedValue

public void setUncheckedValue(MetisFieldItem.MetisFieldDef pField,
 Object pValue)

Set the unchecked value.

Parameters:

pField - the field

pValue - the value

getValue

public Object getValue(MetisDataItem.MetisDataFieldId pFieldId)

Get the value.

Parameters:

pFieldId - the fieldId

Returns:

the value

getValue

public Object getValue(MetisFieldItem.MetisFieldDef pField)

Get the value.

Parameters:

pField - the field

Returns:

the value

getValue

public <X> X getValue(MetisDataItem.MetisDataFieldId pFieldId,
 Class<X> pClazz)

Get the value.

Type Parameters:

X - the required type

Parameters:

pFieldId - the fieldId

pClazz - the class

Returns:

the value

getValue

public <X> X getValue(MetisFieldItem.MetisFieldDef pField,
 Class<X> pClazz)

Get the value as an object type.

Type Parameters:

X - the required type

Parameters:

pField - the field

pClazz - the class

Returns:

the value

equals

public boolean equals(Object pThat)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

differs

public MetisDataDifference differs(MetisFieldVersionValues pOriginal)

Check for differences.

Parameters:

pOriginal - the object to check for differences

Returns:

the difference

fieldChanged

public MetisDataDifference fieldChanged(MetisDataItem.MetisDataFieldId pFieldId,
 MetisFieldVersionValues pOriginal)

Check for a difference in a particular field.

Parameters:

pFieldId - the field to check for differences

pOriginal - the original value set

Returns:

the difference

fieldChanged

public MetisDataDifference fieldChanged(MetisFieldItem.MetisFieldDef pField,
 MetisFieldVersionValues pOriginal)

Check for a difference in a particular field.

Parameters:

pField - the field to check for differences

pOriginal - the original value set

Returns:

the difference

checkValueType

protected void checkValueType(MetisFieldItem.MetisFieldDef pField,
 Object pValue)
                       throws OceanusException

Check the value.

Parameters:

pField - the field

pValue - the value

Throws:

OceanusException - on error