io.permazen

Class CopyState

java.lang.Object

io.permazen.CopyState

All Implemented Interfaces:

Cloneable

@NotThreadSafe
public class CopyState
extends Object
implements Cloneable

Maintains state about a multi-object copy operation.

This class keeps tracks of which objects have already been copied when copying objects between transactions.

In addition, it supports assigning different object ID's to objects as they are copied into the destination transaction.

Instances are not thread safe.

See Also:

JObject.copyTo(), JObject.cascadeCopyTo()

Constructor Summary

Constructors

Constructor and Description
CopyState() Default constructor.
CopyState(ObjIdMap<ObjId> objectIdMap) Default remapping constructor.
CopyState(ObjIdSet copied, ObjIdMap<ObjId> objectIdMap) Primary constructor.

Method Summary

Modifier and Type	Method and Description
CopyState	clone()
ObjId	getDestinationId(ObjId srcId) Get the object ID to use in the destination transaction for the copy of the object with the given object ID in the source transaction.
ObjIdMap<ObjId>	getObjectIdMap() Get the mapping from object ID in the source transaction to object ID to use in the destination transaction.
boolean	isCopied(ObjId id) Determine if an object has been marked as copied.
boolean	isSuppressNotifications() Determine whether to suppress @OnCreate and @OnChange notifications in the destination transaction.
boolean	markCopied(ObjId id) Determine if an object has already been copied, and if not mark it so.
boolean	markTraversed(ObjId id, int[] fields) Determine if the specified reference path has already been traversed starting at the given object, and if not mark it so.
void	setSuppressNotifications(boolean suppressNotifications) Configure whether to suppress @OnCreate and @OnChange notifications in the destination transaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyState

public CopyState()

Default constructor.

Object ID's will not be remapped.

Equivalent to: CopyState(new ObjIdSet(), null).

CopyState

public CopyState(ObjIdMap<ObjId> objectIdMap)

Default remapping constructor.

Object ID's will be remapped based on objectIdMap.

Equivalent to: CopyState(new ObjIdSet(), objectIdMap).

Parameters:

objectIdMap - mapping from source object ID to destination object ID, or null to disable object ID remapping (i.e., use the same ID)

CopyState

public CopyState(ObjIdSet copied,
                 ObjIdMap<ObjId> objectIdMap)

Primary constructor.

This constructor allows an object ID map to be provided via objectIdMap, which specifies the destination transaction object ID to use when copying the corresponding source transaction object.

Parameters:

copied - the ID's of objects that have already been copied

objectIdMap - mapping from source object ID to destination object ID, or null to disable object ID remapping (i.e., use the same ID)

Throws:

IllegalArgumentException - if copied is null

Method Detail

markCopied

public boolean markCopied(ObjId id)

Determine if an object has already been copied, and if not mark it so.

Parameters:

id - object ID (in the source transaction) of the object being copied

Returns:

true if id was not previously marked copied, otherwise false

Throws:

IllegalArgumentException - if id is null

isCopied

public boolean isCopied(ObjId id)

Determine if an object has been marked as copied.

Parameters:

id - object ID (in the source transaction) of the object being copied

Returns:

true if id has been marked copied, otherwise false

Throws:

IllegalArgumentException - if id is null

isSuppressNotifications

public boolean isSuppressNotifications()

Determine whether to suppress @OnCreate and @OnChange notifications in the destination transaction.

Note that for notifications to be delivered in a SnapshotJTransaction, these annotations must also have snapshotTransactions = true, even if this property is set to false.

Default is false.

Returns:

true if @OnCreate and @OnChange notifications should be suppressed, otherwise false

setSuppressNotifications

public void setSuppressNotifications(boolean suppressNotifications)

Configure whether to suppress @OnCreate and @OnChange notifications in the destination transaction.

Note that for notifications to be delivered in a SnapshotJTransaction, these annotations must also have snapshotTransactions = true, even if this property is set to false.

Parameters:

suppressNotifications - true if @OnCreate and @OnChange notifications should be suppressed, otherwise false

markTraversed

public boolean markTraversed(ObjId id,
                             int[] fields)

Determine if the specified reference path has already been traversed starting at the given object, and if not mark it so.

Parameters:

id - object ID (in the source transaction) of the object being copied

fields - reference path storage IDs

Returns:

true if fields was not previously marked as traversed from id, otherwise false

Throws:

IllegalArgumentException - if either parameter is null

IllegalArgumentException - if fields has length zero

getObjectIdMap

public ObjIdMap<ObjId> getObjectIdMap()

Get the mapping from object ID in the source transaction to object ID to use in the destination transaction.

This method returns the objectIdMap parameter given to the constructor, if any.

Returns:

mapping from source transaction object ID to destination transaction object ID, or null if none configured

getDestinationId

public ObjId getDestinationId(ObjId srcId)

Get the object ID to use in the destination transaction for the copy of the object with the given object ID in the source transaction.

The implementation in CopyState behaves as follows: if a null objectIdMap parameter was given to the constructor, objectIdMap does not contain srcId, or the corresponding value is null, it returns srcId. Otherwise, the corresponding value from objectIdMap is returned.

Parameters:

srcId - source transaction object ID

Returns:

corresponding destination transaction object ID

Throws:

IllegalArgumentException - if srcId is null

clone

public CopyState clone()

Overrides:

clone in class Object