io.permazen.schema

Class ReferenceSchemaField

java.lang.Object

io.permazen.util.AbstractXMLStreaming

io.permazen.schema.AbstractSchemaItem

io.permazen.schema.SchemaField

io.permazen.schema.SimpleSchemaField

io.permazen.schema.ReferenceSchemaField

All Implemented Interfaces:

DiffGenerating<SimpleSchemaField>, Cloneable

public class ReferenceSchemaField
extends SimpleSchemaField

A reference field in a SchemaObjectType.

Constructor Summary

Constructors

Constructor and Description
ReferenceSchemaField()

Method Summary

Modifier and Type	Method and Description
ReferenceSchemaField	clone() Deep-clone this instance.
Diffs	differencesFrom(SimpleSchemaField other) Detect the differences of this instance when compared to the given instance.
boolean	equals(Object obj)
NavigableSet<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.
int	hashCode()
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.
boolean	isLockedDown() Determine whether this instance is locked down.
void	lockDown() Lock down this instance.
void	setAllowDeleted(boolean allowDeleted)
void	setAllowDeletedSnapshot(boolean allowDeletedSnapshot)
void	setCascadeDelete(boolean cascadeDelete)
void	setObjectTypes(NavigableSet<Integer> objectTypes)
void	setOnDelete(DeleteAction onDelete)
<R> R	visit(SchemaFieldSwitch<R> target) Apply visitor pattern.

Methods inherited from class io.permazen.schema.SimpleSchemaField

getEncodingSignature, getType, isIndexed, setEncodingSignature, setIndexed, setType, toString

Methods inherited from class io.permazen.schema.AbstractSchemaItem

differencesFrom, getName, getStorageId, setName, setStorageId

Methods inherited from class io.permazen.util.AbstractXMLStreaming

expect, expectClose, getAttr, getAttr, getBooleanAttr, getBooleanAttr, getIntAttr, getIntAttr, getLongAttr, newInvalidAttributeException, next, skip, writeElement

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReferenceSchemaField

public ReferenceSchemaField()

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

setOnDelete

public void setOnDelete(DeleteAction onDelete)

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

setCascadeDelete

public void setCascadeDelete(boolean cascadeDelete)

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

setAllowDeleted

public void setAllowDeleted(boolean allowDeleted)

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

setAllowDeletedSnapshot

public void setAllowDeletedSnapshot(boolean allowDeletedSnapshot)

getObjectTypes

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

setObjectTypes

public void setObjectTypes(NavigableSet<Integer> objectTypes)

visit

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

Description copied from class: SchemaField

Apply visitor pattern.

Overrides:

visit in class SimpleSchemaField

Type Parameters:

R - visitor return type

Parameters:

target - target to invoke

Returns:

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

differencesFrom

public Diffs differencesFrom(SimpleSchemaField other)

Description copied from interface: DiffGenerating

Detect the differences of this instance when compared to the given instance.

Specified by:

differencesFrom in interface DiffGenerating<SimpleSchemaField>

Overrides:

differencesFrom in class SimpleSchemaField

Parameters:

other - other instance

Returns:

differences; will be empty if there are none detected

equals

public boolean equals(Object obj)

Overrides:

equals in class SimpleSchemaField

hashCode

public int hashCode()

Overrides:

hashCode in class SimpleSchemaField

clone

public ReferenceSchemaField clone()

Deep-clone this instance.

The returned instance will not be locked down.

Overrides:

clone in class SimpleSchemaField

lockDown

public void lockDown()

Lock down this instance.

Once locked down, any attempts to modify this instance (and all associated objects) will result in a IllegalStateException.

isLockedDown

public boolean isLockedDown()

Determine whether this instance is locked down.

Returns:

true if instance is locked down, otherwise false