io.permazen

Class JMapField

java.lang.Object

io.permazen.JSchemaObject

io.permazen.JField

io.permazen.JComplexField

io.permazen.JMapField

public class JMapField
extends JComplexField

Represents a map field in a JClass.

Method Summary

Modifier and Type	Method and Description
io.permazen.NavigableMapConverter<?,?,?,?>	getConverter(JTransaction jtx) 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.
JMapField	getDeclaringAnnotation() Get the Annotation that declared this field.
JSimpleField	getKeyField() Get the key sub-field.
JSimpleField	getSubField(String name) Get the sub-field with the given name.
List<JSimpleField>	getSubFields() Get the sub-fields associated with this field.
TypeToken<?>	getTypeToken() Get the type of this field.
NavigableMap<?,?>	getValue(JObject jobj) Get the Java value of this field in the given Java model object.
JSimpleField	getValueField() Get the value sub-field.
<R> R	visit(JFieldSwitch<R> target) Apply visitor pattern.

Methods inherited from class io.permazen.JField

getGetter

Methods inherited from class io.permazen.JSchemaObject

getName, getPermazen, getStorageId, toString

Methods inherited from class java.lang.Object

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

Method Detail

getDeclaringAnnotation

public JMapField getDeclaringAnnotation()

Description copied from class: JField

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 JField

Returns:

declaring annotation

getKeyField

public JSimpleField getKeyField()

Get the key sub-field.

Returns:

this field's key sub-field

getValueField

public JSimpleField getValueField()

Get the value sub-field.

Returns:

this field's value sub-field

getValue

public NavigableMap<?,?> getValue(JObject jobj)

Description copied from class: JField

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

Specified by:

getValue in class JField

Parameters:

jobj - object containing this field

Returns:

this field's value in jobj

visit

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

Description copied from class: JField

Apply visitor pattern.

Specified by:

visit in class JField

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<JSimpleField> getSubFields()

Description copied from class: JComplexField

Get the sub-fields associated with this field.

Specified by:

getSubFields in class JComplexField

Returns:

this instance's sub-fields (in order)

getSubField

public JSimpleField getSubField(String name)

Description copied from class: JComplexField

Get the sub-field with the given name.

Specified by:

getSubField in class JComplexField

Parameters:

name - sub-field name

Returns:

the sub-field with the specified name

getTypeToken

public TypeToken<?> getTypeToken()

Description copied from class: JField

Get the type of this field.

Specified by:

getTypeToken in class JField

Returns:

this field's type

getConverter

public io.permazen.NavigableMapConverter<?,?,?,?> getConverter(JTransaction jtx)

Description copied from class: JField

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 JField

Parameters:

jtx - transaction

Returns:

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