org.odpi.egeria.connectors.ibm.igc.clientlibrary.update

Class IGCUpdate

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.update.IGCUpdate

public class IGCUpdate
extends Object

Manages the criteria to use for updating assets in IGC.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IGCUpdate.UpdateMode

Constructor Summary

Constructors

Constructor and Description
IGCUpdate(String ridToUpdate)

Method Summary

Modifier and Type	Method and Description
void	addExclusiveRelationship(String propertyName, String relatedRid) Adds a relationship on a property that can only have one such relationship (so it will replace any existing relationship on that property).
void	addProperty(String propertyName, String value) Adds a new value for the provided property to be set on the update.
void	addRelationship(String propertyName, String relatedRid) Adds a relationship on a property that can have many relationships.
String	getRidToUpdate() Retrieves the RID of the asset that is being updated.
com.fasterxml.jackson.databind.JsonNode	getUpdate() Retrieves the update string for this update object.
void	setRelationshipUpdateMode(IGCUpdate.UpdateMode updateMode) Sets the update mode that should be used for the non-exclusive relationship properties.
String	toString() Retrieves a printable version of the update object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IGCUpdate

public IGCUpdate(String ridToUpdate)

Method Detail

addProperty

public void addProperty(String propertyName,
                        String value)

Adds a new value for the provided property to be set on the update.

Parameters:

propertyName - the name of the property to be updated

value - the new value for the property

addExclusiveRelationship

public void addExclusiveRelationship(String propertyName,
                                     String relatedRid)

Adds a relationship on a property that can only have one such relationship (so it will replace any existing relationship on that property).

Parameters:

propertyName - name of the IGC entity's exclusive relationship property

relatedRid - Repository ID (RID) of the related entity

addRelationship

public void addRelationship(String propertyName,
                            String relatedRid)

Adds a relationship on a property that can have many relationships. Decide whether to replace any existing relationships on the property or to append to the existing relationships using setRelationshipUpdateMode.

Parameters:

propertyName - name of the IGC entity's relationship property

relatedRid - Repository ID (RID) of the related entity

See Also:

setRelationshipUpdateMode(UpdateMode)

setRelationshipUpdateMode

public void setRelationshipUpdateMode(IGCUpdate.UpdateMode updateMode)

Sets the update mode that should be used for the non-exclusive relationship properties.

Parameters:

updateMode - the mode of the update

See Also:

IGCUpdate.UpdateMode, addRelationship(String, String)

getRidToUpdate

public String getRidToUpdate()

Retrieves the RID of the asset that is being updated.

Returns:

String

getUpdate

public com.fasterxml.jackson.databind.JsonNode getUpdate()

Retrieves the update string for this update object.

Returns:

JsonNode - the JSON structure representing the update operation

toString

public String toString()

Retrieves a printable version of the update object.

Overrides:

toString in class Object

Returns:

String