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

Class UpdateEntityProxyClassification

java.lang.Object

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

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

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

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

public class UpdateEntityProxyClassification
extends UpdateEntityClassification

Transaction function for updating InstanceProperties on a metadata instance.

Field Summary

Fields

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

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.txnfn.UpdateEntityClassification

xtdbDoc

Constructor Summary

Constructors

Constructor	Description
UpdateEntityProxyClassification(Long txId, clojure.lang.PersistentHashMap existing, clojure.lang.PersistentHashMap proxy, String userId, String entityGUID, String metadataCollectionId, String classificationName, InstanceProperties properties)	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 Classification	transact(XTDBOMRSRepositoryConnector xtdb, String userId, EntityProxy entityProxy, String classificationName, InstanceProperties properties)	Update the properties of the provided entity 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.UpdateInstanceProperties

updateInstanceProperties, updateInstanceProperties, 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

CLASS_NAME

public static final String CLASS_NAME

METHOD_NAME

public static final String METHOD_NAME

Constructor Details

UpdateEntityProxyClassification

public UpdateEntityProxyClassification(Long txId,
 clojure.lang.PersistentHashMap existing,
 clojure.lang.PersistentHashMap proxy,
 String userId,
 String entityGUID,
 String metadataCollectionId,
 String classificationName,
 InstanceProperties properties)
                                throws Exception

Constructor used to execute the transaction function.

Parameters:

txId - the transaction ID of this function invocation

existing - XTDB document to update

proxy - XTDB document to update, if existing is empty

userId - doing the update

entityGUID - of the entity to update

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

classificationName - of the classification to update

properties - to apply to the classification

Throws:

Exception - on any error

Method Details

transact

public static Classification transact(XTDBOMRSRepositoryConnector xtdb,
 String userId,
 EntityProxy entityProxy,
 String classificationName,
 InstanceProperties properties)
                               throws EntityNotKnownException,
ClassificationErrorException,
InvalidParameterException,
PropertyErrorException,
RepositoryErrorException

Update the properties 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

entityProxy - of the entity to classify

classificationName - of the classification to update

properties - to apply to the classification

Returns:

Classification that was applied

Throws:

EntityNotKnownException - if the entity cannot be found

ClassificationErrorException - if the specified classification cannot be found to update

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

PropertyErrorException - if one or more of the requested properties are not defined or have different characteristics in the TypeDef for this classification type

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