Module io.github.tonywasher.joceanus.metis

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

Class MetisFieldSet<T extends MetisFieldItem>

java.lang.Object

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

Type Parameters:

T - the data type

All Implemented Interfaces:

MetisFieldItem.MetisFieldSetDef

Direct Known Subclasses:

MetisFieldVersionedSet

public class MetisFieldSet<T extends MetisFieldItem>
extends Object
implements MetisFieldItem.MetisFieldSetDef

Metis Data FieldSet.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Integer	FIELD_NO_MAXLENGTH	No Maximum Length.
static final int	HASH_PRIME	Hash Prime.

Constructor Summary

Constructors

Constructor	Description
MetisFieldSet(Class<T> pClazz, MetisFieldItem.MetisFieldSetDef pParent, boolean pStatic)	Constructor.

Method Summary

Modifier and Type	Method	Description
<E extends Enum<E> & MetisDataItem.MetisDataFieldId> Map<MetisDataItem.MetisDataFieldId,E>	buildFieldMap(Class<E> pClass, BiFunction<T,MetisDataItem.MetisDataFieldId,Object> pValueLookup)	Build field set for enum class.
protected void	checkUniqueName(MetisDataItem.MetisDataFieldId pId)	Check uniqueness of Id.
MetisField<T>	declareCalculatedField(MetisDataItem.MetisDataFieldId pId)	Declare field used for calculation.
MetisField<T>	declareLocalField(MetisDataItem.MetisDataFieldId pId, BiFunction<T,MetisDataItem.MetisDataFieldId,Object> pValue)	Declare local field not used for equality.
MetisField<T>	declareLocalField(MetisDataItem.MetisDataFieldId pId, Function<T,Object> pValue)	Declare local field not used for equality.
MetisField<T>	declareLocalField(String pName, Function<T,Object> pValue)	Declare local field not used for equality.
<E extends Enum<E>> Map<E,MetisFieldItem.MetisFieldDef>	declareLocalFieldsForEnum(Class<E> pClazz, BiFunction<T,E,Object> pValue)	Declare local non-equality fields one for each Enum.
boolean	equals(Object pThat)
Iterator<MetisFieldItem.MetisFieldDef>	fieldIterator()	Obtain the iterator over the fields.
Integer	getAnchorId()	Obtain the anchorId.
MetisFieldItem.MetisFieldDef	getField(MetisDataItem.MetisDataFieldId pId)	Obtain field from fieldId.
protected Class<T>	getFieldClass()	Obtain the field class.
MetisFieldItem.MetisFieldItemType	getItemType()	Obtain the itemType.
String	getName()	Obtain the name of the fieldSet.
protected Integer	getNextIndex()	Obtain next value index.
Integer	getNumVersioned()	Obtain the number of versioned fields.
int	hashCode()
boolean	hasVersions()	Does the item have versioned values?
boolean	isLocked()	Is this fieldSet locked?
boolean	isStatic()	Is this a static fieldSet?
static <T extends MetisFieldItem> MetisFieldSet<T>	lookUpFieldSet(Class<T> pClazz)	LookUp a static FieldSet.
static MetisFieldItem.MetisFieldSetDef	lookUpParentFieldSet(Class<?> pClazz)	LookUp a Parent FieldSet.
static <T extends MetisFieldItem> MetisFieldSet<T>	newFieldSet(Class<T> pClazz)	Declare a static fieldSet.
static <T extends MetisFieldItem> MetisFieldSet<T>	newFieldSet(T pObject)	Declare a local fieldSet.
protected void	registerField(MetisField<T> pField)	Register the field.
protected static void	registerFieldSet(Class<?> pClazz, MetisFieldSet<?> pFieldSet)	Register a fieldSet.
static <E extends Enum<E>> Map<E,MetisDataItem.MetisDataFieldId>	reverseFieldMap(Map<MetisDataItem.MetisDataFieldId,E> pSourceMap, Class<E> pClass)	Reverse field set to enum map.
void	setItemType(MetisFieldItem.MetisFieldItemType pItemType)	Set the itemType.
void	setLocked()	Lock the fieldSet.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem.MetisFieldSetDef

hasLinks, hasPairedLinks

Field Details

HASH_PRIME

public static final int HASH_PRIME

Hash Prime.

See Also:

• Constant Field Values

FIELD_NO_MAXLENGTH

protected static final Integer FIELD_NO_MAXLENGTH

No Maximum Length.

Constructor Details

MetisFieldSet

MetisFieldSet(Class<T> pClazz,
 MetisFieldItem.MetisFieldSetDef pParent,
 boolean pStatic)

Constructor.

Parameters:

pClazz - the class of the item

pParent - the parent fields

pStatic - is this a static fieldSet?

Method Details

newFieldSet

public static <T extends MetisFieldItem>
MetisFieldSet<T> newFieldSet(Class<T> pClazz)

Declare a static fieldSet.

Type Parameters:

T - the itemType

Parameters:

pClazz - the class of the fieldSet

Returns:

the fieldSet.

lookUpParentFieldSet

public static MetisFieldItem.MetisFieldSetDef lookUpParentFieldSet(Class<?> pClazz)

LookUp a Parent FieldSet.

Parameters:

pClazz - the class of the fieldSet

Returns:

the fieldSet.

lookUpFieldSet

public static <T extends MetisFieldItem>
MetisFieldSet<T> lookUpFieldSet(Class<T> pClazz)

LookUp a static FieldSet.

Type Parameters:

T - the itemType

Parameters:

pClazz - the class of the fieldSet

Returns:

the fieldSet.

registerFieldSet

protected static void registerFieldSet(Class<?> pClazz,
 MetisFieldSet<?> pFieldSet)

Register a fieldSet.

Parameters:

pClazz - the class of the fieldSet

pFieldSet - the fieldSet

newFieldSet

public static <T extends MetisFieldItem>
MetisFieldSet<T> newFieldSet(T pObject)

Declare a local fieldSet.

Type Parameters:

T - the itemType

Parameters:

pObject - the object

Returns:

the fieldSet.

getAnchorId

public Integer getAnchorId()

Obtain the anchorId.

Returns:

the id

getName

public String getName()

Description copied from interface: MetisFieldItem.MetisFieldSetDef

Obtain the name of the fieldSet.

Specified by:

getName in interface MetisFieldItem.MetisFieldSetDef

Returns:

the name of the fieldSet.

getFieldClass

protected Class<T> getFieldClass()

Obtain the field class.

Returns:

the field class

getNextIndex

protected Integer getNextIndex()

Obtain next value index.

Returns:

the next index

getNumVersioned

public Integer getNumVersioned()

Description copied from interface: MetisFieldItem.MetisFieldSetDef

Obtain the number of versioned fields.

Specified by:

getNumVersioned in interface MetisFieldItem.MetisFieldSetDef

Returns:

the number of fields.

hasVersions

public boolean hasVersions()

Description copied from interface: MetisFieldItem.MetisFieldSetDef

Does the item have versioned values?

Specified by:

hasVersions in interface MetisFieldItem.MetisFieldSetDef

Returns:

true/false

isStatic

public boolean isStatic()

Is this a static fieldSet?

Returns:

true/false

isLocked

public boolean isLocked()

Is this fieldSet locked?

Returns:

true/false

setLocked

public void setLocked()

Description copied from interface: MetisFieldItem.MetisFieldSetDef

Lock the fieldSet.

Specified by:

setLocked in interface MetisFieldItem.MetisFieldSetDef

getItemType

public MetisFieldItem.MetisFieldItemType getItemType()

Description copied from interface: MetisFieldItem.MetisFieldSetDef

Obtain the itemType.

Specified by:

getItemType in interface MetisFieldItem.MetisFieldSetDef

Returns:

the itemType

setItemType

public void setItemType(MetisFieldItem.MetisFieldItemType pItemType)

Set the itemType.

Parameters:

pItemType - the itemType

fieldIterator

public Iterator<MetisFieldItem.MetisFieldDef> fieldIterator()

Description copied from interface: MetisFieldItem.MetisFieldSetDef

Obtain the iterator over the fields.

Specified by:

fieldIterator in interface MetisFieldItem.MetisFieldSetDef

Returns:

the iterator

declareLocalField

public MetisField<T> declareLocalField(MetisDataItem.MetisDataFieldId pId,
 Function<T,Object> pValue)

Declare local field not used for equality.

Parameters:

pId - the id of the field

pValue - the value supplier

Returns:

the field

declareLocalField

public MetisField<T> declareLocalField(MetisDataItem.MetisDataFieldId pId,
 BiFunction<T,MetisDataItem.MetisDataFieldId,Object> pValue)

Declare local field not used for equality.

Parameters:

pId - the id of the field

pValue - the value supplier

Returns:

the field

declareLocalFieldsForEnum

public <E extends Enum<E>>
Map<E,MetisFieldItem.MetisFieldDef> declareLocalFieldsForEnum(Class<E> pClazz,
 BiFunction<T,E,Object> pValue)

Declare local non-equality fields one for each Enum.

Type Parameters:

E - the Enum

Parameters:

pClazz - the class of the Enum

pValue - the value supplier

Returns:

map of class to fields

declareCalculatedField

public MetisField<T> declareCalculatedField(MetisDataItem.MetisDataFieldId pId)

Declare field used for calculation.

Parameters:

pId - the fieldId

Returns:

the field

declareLocalField

public MetisField<T> declareLocalField(String pName,
 Function<T,Object> pValue)

Declare local field not used for equality.

Parameters:

pName - the name of the field

pValue - the value supplier

Returns:

the field

registerField

protected void registerField(MetisField<T> pField)

Register the field.

Parameters:

pField - the field

checkUniqueName

protected void checkUniqueName(MetisDataItem.MetisDataFieldId pId)

Check uniqueness of Id.

Parameters:

pId - the id to check.

Throws:

IllegalArgumentException - if name is present

getField

public MetisFieldItem.MetisFieldDef getField(MetisDataItem.MetisDataFieldId pId)

Description copied from interface: MetisFieldItem.MetisFieldSetDef

Obtain field from fieldId.

Specified by:

getField in interface MetisFieldItem.MetisFieldSetDef

Parameters:

pId - the fieldId.

Returns:

the corresponding field

equals

public boolean equals(Object pThat)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

buildFieldMap

public <E extends Enum<E> & MetisDataItem.MetisDataFieldId>
Map<MetisDataItem.MetisDataFieldId,E> buildFieldMap(Class<E> pClass,
 BiFunction<T,MetisDataItem.MetisDataFieldId,Object> pValueLookup)

Build field set for enum class.

Type Parameters:

E - the enum type

Parameters:

pClass - the enum class

pValueLookup - the Lookup Function

Returns:

the map from field to enum.

reverseFieldMap

public static <E extends Enum<E>>
Map<E,MetisDataItem.MetisDataFieldId> reverseFieldMap(Map<MetisDataItem.MetisDataFieldId,E> pSourceMap,
 Class<E> pClass)

Reverse field set to enum map.

Type Parameters:

E - the enum type

Parameters:

pSourceMap - the source map

pClass - the enum class

Returns:

the map from field to enum.