Module io.github.tonywasher.joceanus.metis

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

Class MetisField<T extends MetisFieldItem>

java.lang.Object

io.github.tonywasher.joceanus.metis.field.MetisField<T>

Type Parameters:

T - the data type

All Implemented Interfaces:

MetisFieldItem.MetisFieldDef

Direct Known Subclasses:

MetisFieldVersioned

public class MetisField<T extends MetisFieldItem>
extends Object
implements MetisFieldItem.MetisFieldDef

Metis Data Field.

Constructor Summary

Constructors

Constructor	Description
MetisField(MetisFieldSet<T> pAnchor, MetisDataItem.MetisDataFieldId pId)	Constructor.
MetisField(MetisFieldSet<T> pAnchor, MetisDataItem.MetisDataFieldId pId, MetisDataType pDataType, Integer pMaxLength)	Constructor.
MetisField(MetisFieldSet<T> pAnchor, MetisDataItem.MetisDataFieldId pId, BiFunction<T,MetisDataItem.MetisDataFieldId,Object> pValue)	Constructor.
MetisField(MetisFieldSet<T> pAnchor, MetisDataItem.MetisDataFieldId pId, Function<T,Object> pValue)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	checkValidity()	Check validity of Field Definition.
boolean	equals(Object pThat)
MetisFieldSet<T>	getAnchor()	Obtain the anchor for the field.
MetisDataType	getDataType()	Get the dataType of the field.
MetisDataItem.MetisDataFieldId	getFieldId()	Obtain the id of the field.
Object	getFieldValue(Object pObject)	Obtain the value of a field.
<X> X	getFieldValue(Object pObject, Class<X> pClazz)	Obtain the value of a field cast to a particular class.
Integer	getMaxLength()	Get the maximum length.
int	hashCode()
boolean	isCalculated()	Is the field calculated?
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

MetisField

MetisField(MetisFieldSet<T> pAnchor,
 MetisDataItem.MetisDataFieldId pId,
 MetisDataType pDataType,
 Integer pMaxLength)

Constructor.

Parameters:

pAnchor - the anchor

pId - the id of the field

pDataType - the dataType of the field

pMaxLength - the maximum length of the field

MetisField

MetisField(MetisFieldSet<T> pAnchor,
 MetisDataItem.MetisDataFieldId pId)

Constructor.

Parameters:

pAnchor - the anchor

pId - the id of the field

MetisField

MetisField(MetisFieldSet<T> pAnchor,
 MetisDataItem.MetisDataFieldId pId,
 Function<T,Object> pValue)

Constructor.

Parameters:

pAnchor - the anchor

pId - the id of the field

pValue - the value supplier

MetisField

MetisField(MetisFieldSet<T> pAnchor,
 MetisDataItem.MetisDataFieldId pId,
 BiFunction<T,MetisDataItem.MetisDataFieldId,Object> pValue)

Constructor.

Parameters:

pAnchor - the anchor

pId - the id of the field

pValue - the value supplier

Method Details

getFieldId

public MetisDataItem.MetisDataFieldId getFieldId()

Description copied from interface: MetisFieldItem.MetisFieldDef

Obtain the id of the field.

Specified by:

getFieldId in interface MetisFieldItem.MetisFieldDef

Returns:

the name of the field.

getDataType

public MetisDataType getDataType()

Description copied from interface: MetisFieldItem.MetisFieldDef

Get the dataType of the field.

Specified by:

getDataType in interface MetisFieldItem.MetisFieldDef

Returns:

the dataType

getMaxLength

public Integer getMaxLength()

Description copied from interface: MetisFieldItem.MetisFieldDef

Get the maximum length.

Specified by:

getMaxLength in interface MetisFieldItem.MetisFieldDef

Returns:

the maxLength

getAnchor

public MetisFieldSet<T> getAnchor()

Obtain the anchor for the field.

Returns:

the anchor

isCalculated

public boolean isCalculated()

Description copied from interface: MetisFieldItem.MetisFieldDef

Is the field calculated?

Specified by:

isCalculated in interface MetisFieldItem.MetisFieldDef

Returns:

true/false

checkValidity

protected void checkValidity()

Check validity of Field Definition.

equals

public boolean equals(Object pThat)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getFieldValue

public Object getFieldValue(Object pObject)

Description copied from interface: MetisFieldItem.MetisFieldDef

Obtain the value of a field.

Specified by:

getFieldValue in interface MetisFieldItem.MetisFieldDef

Parameters:

pObject - the object

Returns:

the value

getFieldValue

public <X> X getFieldValue(Object pObject,
 Class<X> pClazz)

Description copied from interface: MetisFieldItem.MetisFieldDef

Obtain the value of a field cast to a particular class.

Specified by:

getFieldValue in interface MetisFieldItem.MetisFieldDef

Type Parameters:

X - the value type

Parameters:

pObject - the object

pClazz - the class of the value

Returns:

the value