Package io.permazen

Class PermazenMapField

java.lang.Object

io.permazen.PermazenSchemaItem

io.permazen.PermazenField

io.permazen.PermazenComplexField

io.permazen.PermazenMapField

public class PermazenMapField
extends PermazenComplexField

Represents a map field in a PermazenClass.

Method Summary

Modifier and Type	Method	Description
io.permazen.NavigableMapConverter<?,?,?,?>	getConverter(PermazenTransaction ptx)	Get a Converter that converts this field's value from what the core database returns to what the Java application expects, or null if no conversion is needed.
PermazenMapField	getDeclaringAnnotation()	Get the Annotation that declared this field.
PermazenSimpleField	getKeyField()	Get the key sub-field.
MapField<?,?>	getSchemaItem()	Get the corresonding core API database instance.
List<PermazenSimpleField>	getSubFields()	Get the sub-fields associated with this field.
TypeToken<?>	getTypeToken()	Get the type of this field.
NavigableMap<?,?>	getValue(PermazenObject pobj)	Get the Java value of this field in the given Java model object.
PermazenSimpleField	getValueField()	Get the value sub-field.
<R> R	visit(PermazenFieldSwitch<R> target)	Apply visitor pattern.

Methods inherited from class io.permazen.PermazenComplexField

getSubField

Methods inherited from class io.permazen.PermazenField

getFullName, getGetter, getKey, getPermazenClass

Methods inherited from class io.permazen.PermazenSchemaItem

getName, getSchemaId, getStorageId, toString

Methods inherited from class java.lang.Object

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

Method Details

getDeclaringAnnotation

public PermazenMapField getDeclaringAnnotation()

Description copied from class: PermazenField

Get the Annotation that declared this field.

If this field was auto-generated from an abstract method with no annotation, a non-null Annotation is still returned; it will have all default values.

Overrides:

getDeclaringAnnotation in class PermazenField

Returns:

declaring annotation

getKeyField

public PermazenSimpleField getKeyField()

Get the key sub-field.

Returns:

this field's key sub-field

getValueField

public PermazenSimpleField getValueField()

Get the value sub-field.

Returns:

this field's value sub-field

getValue

public NavigableMap<?,?> getValue(PermazenObject pobj)

Description copied from class: PermazenField

Get the Java value of this field in the given Java model object. Does not alter the schema of the object.

Specified by:

getValue in class PermazenField

Parameters:

pobj - object containing this field

Returns:

this field's value in pobj

visit

public <R> R visit(PermazenFieldSwitch<R> target)

Description copied from class: PermazenField

Apply visitor pattern.

Specified by:

visit in class PermazenField

Type Parameters:

R - visit return type

Parameters:

target - target to invoke

Returns:

value from the method of target corresponding to this instance's type

getSubFields

public List<PermazenSimpleField> getSubFields()

Description copied from class: PermazenComplexField

Get the sub-fields associated with this field.

Specified by:

getSubFields in class PermazenComplexField

Returns:

this instance's sub-fields (in order)

getSchemaItem

public MapField<?,?> getSchemaItem()

Description copied from class: PermazenSchemaItem

Get the corresonding core API database instance.

Overrides:

getSchemaItem in class PermazenComplexField

Returns:

this instance's correpsonding SchemaItem

getTypeToken

public TypeToken<?> getTypeToken()

Description copied from class: PermazenField

Get the type of this field.

Specified by:

getTypeToken in class PermazenField

Returns:

this field's type

getConverter

public io.permazen.NavigableMapConverter<?,?,?,?> getConverter(PermazenTransaction ptx)

Description copied from class: PermazenField

Get a Converter that converts this field's value from what the core database returns to what the Java application expects, or null if no conversion is needed.

Specified by:

getConverter in class PermazenField

Parameters:

ptx - transaction

Returns:

Converter from core API to Java, or null if no conversion is required