io.permazen.core

Class ReferenceField

java.lang.Object

io.permazen.core.SchemaItem

io.permazen.core.Field<T>

io.permazen.core.SimpleField<ObjId>

io.permazen.core.ReferenceField

public class ReferenceField
extends SimpleField<ObjId>

A field that references another Database object.

Null values sort last.

Reference fields are always indexed.

Field Summary

Fields inherited from class io.permazen.core.SchemaItem

NAME_PATTERN

Method Summary

Modifier and Type	Method and Description
SortedSet<Integer>	getObjectTypes() Get the object types this field is allowed to reference, if so restricted.
DeleteAction	getOnDelete() Get the desired behavior when an object referred to by this field is deleted.
boolean	isAllowDeleted() Determine whether this field accepts references to deleted objects in normal (non-snapshot) transactions.
boolean	isAllowDeletedSnapshot() Determine whether this field accepts references 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.
protected ObjId	remapObjectId(ObjIdMap<ObjId> objectIdMap, ObjId srcId)
protected boolean	remapsObjectId()
String	toString()
<R> R	visit(FieldSwitch<R> target) Apply visitor pattern.

Methods inherited from class io.permazen.core.SimpleField

getFieldType, getValue, hasDefaultValue, isIndexed, setValue

Methods inherited from class io.permazen.core.Field

getTypeToken

Methods inherited from class io.permazen.core.SchemaItem

getName, getSchema, getStorageId

Methods inherited from class java.lang.Object

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

Method Detail

getOnDelete

public DeleteAction getOnDelete()

Get the desired behavior when an object referred to by this field is deleted.

Returns:

desired behavior when a referenced object is deleted

isCascadeDelete

public boolean isCascadeDelete()

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

Returns:

whether deletion should cascade to the referred-to object

isAllowDeleted

public boolean isAllowDeleted()

Determine whether this field accepts references to deleted objects in normal (non-snapshot) transactions.

Returns:

whether deleted objects are allowed in normal transactions

isAllowDeletedSnapshot

public boolean isAllowDeletedSnapshot()

Determine whether this field accepts references to deleted objects in snapshot transactions.

Returns:

whether deleted objects are allowed in snapshot transactions

getObjectTypes

public SortedSet<Integer> getObjectTypes()

Get the object types this field is allowed to reference, if so restricted.

Returns:

storage IDs of allowed object types, or null if there is no restriction

visit

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

Description copied from class: Field

Apply visitor pattern.

Overrides:

visit in class SimpleField<ObjId>

Type Parameters:

R - visitor return type

Parameters:

target - target to invoke

Returns:

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

toString

public String toString()

Overrides:

toString in class SimpleField<ObjId>

remapsObjectId

protected boolean remapsObjectId()

Overrides:

remapsObjectId in class SimpleField<ObjId>

remapObjectId

protected ObjId remapObjectId(ObjIdMap<ObjId> objectIdMap,
                              ObjId srcId)

Overrides:

remapObjectId in class SimpleField<ObjId>