org.jsimpledb

Class JSimpleField

java.lang.Object

org.jsimpledb.JSchemaObject

org.jsimpledb.JField

org.jsimpledb.JSimpleField

Direct Known Subclasses:

JEnumField, JReferenceField

public class JSimpleField
extends JField

Represents a simple field in a JClass or a simple sub-field of a complex field in a JClass.

Method Summary

Modifier and Type	Method and Description
Converter<?,?>	getConverter(JTransaction jtx) Get a Converter that converts this field values between core API type and Java model type.
FieldType<?>	getFieldType() Get the FieldType used by the core API to encode this field's values.
JComplexField	getParentField() Get the JComplexField of which this instance is a sub-field, if any.
Method	getSetter() Get the setter method associated with this field.
TypeToken<?>	getTypeToken() Get the type of this field.
Object	getValue(JObject jobj) Get the Java value of this field in the given Java model object.
boolean	isIndexed() Get whether this field is indexed.
void	setValue(JObject jobj, Object value) Set the Java value of this field in the given object.
<R> R	visit(JFieldSwitch<R> target) Apply visitor pattern.

Methods inherited from class org.jsimpledb.JField

getGetter

Methods inherited from class org.jsimpledb.JSchemaObject

getJSimpleDB, getName, getStorageId, toString

Methods inherited from class java.lang.Object

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

Method Detail

getParentField

public JComplexField getParentField()

Get the JComplexField of which this instance is a sub-field, if any.

Returns:

parent JComplexField, or null if this instance is not a sub-field

getTypeToken

public TypeToken<?> getTypeToken()

Get the type of this field.

Returns:

this field's Java type

getFieldType

public FieldType<?> getFieldType()

Get the FieldType used by the core API to encode this field's values.

Note that for Enum and reference fields, the core API uses a different type than the Java model classes (EnumValue and ObjId, respectively). Values can always be properly converted using the Converter returned by getConverter().

Returns:

this field's core-layer type definition

isIndexed

public boolean isIndexed()

Get whether this field is indexed.

Returns:

whether this field is indexed

getSetter

public Method getSetter()

Get the setter method associated with this field.

Returns:

field property setter method, or null if this field is a sub-field of a complex field

getValue

public Object 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

getConverter

public Converter<?,?> getConverter(JTransaction jtx)

Get a Converter that converts this field values between core API type and Java model type. Only Enum and reference types require conversion; for all other types, this returns an identity converter.

Parameters:

jtx - transaction

Returns:

Converter from core API field type to Java model field type

setValue

public void setValue(JObject jobj,
                     Object value)

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

Parameters:

jobj - object containing this field

value - new value

Throws:

DeletedObjectException - if jobj does not exist in its associated JTransaction

StaleTransactionException - if the JTransaction associated with jobj is no longer usable

IllegalArgumentException - if value is not an appropriate value for this field

IllegalArgumentException - if jobj is null