Package org.odpi.egeria.connectors.juxt.xtdb.txnfn

Class ReHomeEntity

java.lang.Object

org.odpi.egeria.connectors.juxt.xtdb.txnfn.AbstractTransactionFunction

org.odpi.egeria.connectors.juxt.xtdb.txnfn.ReHomeInstance

org.odpi.egeria.connectors.juxt.xtdb.txnfn.ReHomeEntity

public class ReHomeEntity
extends ReHomeInstance

Transaction function for updating an entity's home repository.

Field Summary

Fields

Modifier and Type	Field	Description
static clojure.lang.Keyword	FUNCTION_NAME

Constructor Summary

Constructors

Constructor	Description
ReHomeEntity(Long txId, clojure.lang.PersistentHashMap existing, String userId, String entityGUID, String metadataCollectionId, String newMetadataCollectionId, String newMetadataCollectionName)	Constructor used to execute the transaction function.

Method Summary

Modifier and Type	Method	Description
static void	create(xtdb.api.tx.Transaction.Builder tx)	Create the transaction function within XTDB.
clojure.lang.IPersistentMap	doc()	Interface that returns the updated document to write-back from the transaction.
static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail	transact(XtdbOMRSRepositoryConnector xtdb, String userId, String entityGUID, String newMetadataCollectionId, String newMetadataCollectionName)	Change the home repository of the provided entity instance in the XTDB repository by pushing the transaction down into the repository itself.

Methods inherited from class org.odpi.egeria.connectors.juxt.xtdb.txnfn.ReHomeInstance

reHomeInstance, validate

Methods inherited from class org.odpi.egeria.connectors.juxt.xtdb.txnfn.AbstractTransactionFunction

createTransactionFunction, getGUID, getInstanceProvenanceType, getMetadataCollectionId, getTxnTimeCalculation, getTypeDefForInstance, getTypeDefGUID, incrementVersion, incrementVersion

Methods inherited from class java.lang.Object

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

Field Detail

FUNCTION_NAME

public static final clojure.lang.Keyword FUNCTION_NAME

Constructor Detail

ReHomeEntity

public ReHomeEntity(Long txId,
                    clojure.lang.PersistentHashMap existing,
                    String userId,
                    String entityGUID,
                    String metadataCollectionId,
                    String newMetadataCollectionId,
                    String newMetadataCollectionName)
             throws Exception

Constructor used to execute the transaction function.

Parameters:

txId - the transaction ID of this function invocation

existing - XTDB document to re-home

userId - doing the update

entityGUID - of the entity to re-home

metadataCollectionId - of the metadata collection in which the transaction is running

newMetadataCollectionId - in which to re-home to the entity

newMetadataCollectionName - in which to re-home the entity

Throws:

Exception - on any error

Method Detail

transact

public static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail transact(XtdbOMRSRepositoryConnector xtdb,
                                                                                                                                            String userId,
                                                                                                                                            String entityGUID,
                                                                                                                                            String newMetadataCollectionId,
                                                                                                                                            String newMetadataCollectionName)
                                                                                                                                     throws org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException,
                                                                                                                                            org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                                                                                            org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException

Change the home repository of the provided entity instance in the XTDB repository by pushing the transaction down into the repository itself.

Parameters:

xtdb - connectivity

userId - doing the update

entityGUID - of the entity on which to change the home repository

newMetadataCollectionId - in which to re-home to the entity

newMetadataCollectionName - in which to re-home the entity

Returns:

EntityDetail the entity with the new home repository applied

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException - if the entity cannot be found

org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - if the entity exists but cannot be re-homed (i.e. not a reference copy)

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - on any other error

doc

public clojure.lang.IPersistentMap doc()

Interface that returns the updated document to write-back from the transaction.

Returns:

IPersistentMap giving the updated document in its entirety

create

public static void create(xtdb.api.tx.Transaction.Builder tx)

Create the transaction function within XTDB.

Parameters:

tx - transaction through which to create the function