io.permazen

Class JReferenceField

java.lang.Object

io.permazen.JSchemaObject

io.permazen.JField

io.permazen.JSimpleField

io.permazen.JReferenceField

public class JReferenceField
extends JSimpleField

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

Method Summary

Modifier and Type	Method and Description
Converter<ObjId,JObject>	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.
String[]	getForwardCascades() Get this field's forward copy cascades.
String[]	getInverseCascades() Get this field's inverse copy cascades.
DeleteAction	getOnDelete() Get the DeleteAction configured for this field.
JObject	getValue(JObject jobj) Get the Java value of this field in the given Java model object.
boolean	isAllowDeleted() Determine whether this field allows assignment to deleted objects in normal transactions.
boolean	isAllowDeletedSnapshot() Determine whether this field allows assignment to deleted objects in snapshot transactions.
boolean	isCascadeDelete() Determine whether the referred-to object should be deleted when an object containing this field is deleted.
<R> R	visit(JFieldSwitch<R> target) Apply visitor pattern.

Methods inherited from class io.permazen.JSimpleField

getDeclaringAnnotation, getFieldType, getParentField, getSetter, getTypeToken, isIndexed, setValue

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

getValue

public JObject 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.

Overrides:

getValue in class JSimpleField

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.

Overrides:

visit in class JSimpleField

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<ObjId,JObject> 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.

Overrides:

getConverter in class JSimpleField

Parameters:

jtx - transaction

Returns:

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

getOnDelete

public DeleteAction getOnDelete()

Get the DeleteAction configured for this field.

Returns:

this field's DeleteAction

isCascadeDelete

public boolean isCascadeDelete()

Determine whether the referred-to object should be deleted when an object containing this field is deleted.

Returns:

this field's delete cascade setting

isAllowDeleted

public boolean isAllowDeleted()

Determine whether this field allows assignment to deleted objects in normal transactions.

Returns:

this field's deleted assignment setting for normal transactions

isAllowDeletedSnapshot

public boolean isAllowDeletedSnapshot()

Determine whether this field allows assignment to deleted objects in snapshot transactions.

Returns:

this field's deleted assignment setting for snapshot transactions

getForwardCascades

public String[] getForwardCascades()

Get this field's forward copy cascades.

The returned array is a copy; modifications to it have no effect.

Returns:

zero or more forward copy cascade names

getInverseCascades

public String[] getInverseCascades()

Get this field's inverse copy cascades.

The returned array is a copy; modifications to it have no effect.

Returns:

zero or more inverse copy cascade names