Package org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn

Class ReTypeRelationship

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.AbstractTransactionFunction

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.ReTypeInstance

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.ReTypeRelationship

public class ReTypeRelationship
extends ReTypeInstance

Transaction function for changing a relationship's type.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ReTypeRelationship(Long txId, clojure.lang.PersistentHashMap existing, String userId, String relationshipGUID, String newTypeDefName, String metadataCollectionId)	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 Relationship	transact(XTDBOMRSRepositoryConnector xtdb, String userId, String relationshipGUID, TypeDefSummary newTypeDef)	Change the type of the provided relatinship instance in the XTDB repository by pushing the transaction down into the repository itself.

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.ReTypeInstance

reTypeInstance, validate

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.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 Details

FUNCTION_NAME

public static final clojure.lang.Keyword FUNCTION_NAME

Constructor Details

ReTypeRelationship

public ReTypeRelationship(Long txId,
 clojure.lang.PersistentHashMap existing,
 String userId,
 String relationshipGUID,
 String newTypeDefName,
 String metadataCollectionId)
                   throws Exception

Constructor used to execute the transaction function.

Parameters:

txId - the transaction ID of this function invocation

existing - XTDB document to update

userId - doing the update

relationshipGUID - of the relationship to update

newTypeDefName - unique identifier of the new type to apply

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

Throws:

Exception - on any error

Method Details

transact

public static Relationship transact(XTDBOMRSRepositoryConnector xtdb,
 String userId,
 String relationshipGUID,
 TypeDefSummary newTypeDef)
                             throws RelationshipNotKnownException,
PropertyErrorException,
TypeErrorException,
InvalidParameterException,
RepositoryErrorException

Change the type of the provided relatinship instance in the XTDB repository by pushing the transaction down into the repository itself.

Parameters:

xtdb - connectivity

userId - doing the update

relationshipGUID - of the relationship on which to change the type

newTypeDef - to apply to the relationship

Returns:

Relationship the relationship with the new type applied

Throws:

RelationshipNotKnownException - if the relationship cannot be found

PropertyErrorException - the properties in the instance are incompatible with the requested type

InvalidParameterException - if the relationship exists but cannot be updated (deleted, reference copy, etc)

TypeErrorException - the requested type is not known or supported by the repository

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