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

Class RelationshipMapping

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.AbstractMapping

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.InstanceAuditHeaderMapping

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.InstanceHeaderMapping

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.RelationshipMapping

public class RelationshipMapping
extends InstanceHeaderMapping

Maps the properties of Relationships between persistence and objects.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTITY_PROXIES
static final String	INSTANCE_REF_PREFIX
static final String	RELATIONSHIP_PROPERTIES_NS

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.InstanceHeaderMapping

instanceHeader, RE_IDENTIFIED_FROM_GUID, xtdbDoc

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.InstanceAuditHeaderMapping

CREATE_TIME, CURRENT_STATUS, INSTANCE_PROVENANCE_TYPE, MAINTAINED_BY, METADATA_COLLECTION_ID, METADATA_COLLECTION_NAME, REPLICATED_BY, STATUS_ON_DELETE, TYPE_DEF_CATEGORY, TYPE_DEF_GUIDS, UPDATE_TIME, UPDATED_BY, VERSION

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.AbstractMapping

mapper, xtdbConnector

Constructor Summary

Constructors

Constructor	Description
RelationshipMapping(XTDBOMRSRepositoryConnector xtdbConnector, Relationship relationship)	Construct a mapping from a Relationship (to map to a XTDB representation).
RelationshipMapping(XTDBOMRSRepositoryConnector xtdbConnector, xtdb.api.XtdbDocument xtdbDoc, xtdb.api.IXtdbDatasource db)	Construct a mapping from a XTDB map (to map to an Egeria representation).

Method Summary

Modifier and Type	Method	Description
protected void	fromDoc()	Translate the provided XTDB representation into an Egeria representation.
static String	getReference(String guid)	Retrieve the canonical reference to the relationship with the specified GUID.
protected xtdb.api.XtdbDocument.Builder	toDoc()	Translate the provided Egeria representation into a XTDB document.
Relationship	toEgeria()	Map from XTDB to Egeria.
static clojure.lang.IPersistentMap	toMap(Relationship relationship)	Translate the provided Egeria representation into a XTDB document map.

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.InstanceHeaderMapping

fromMap, getGuidReference, getGuidReference, getReference, toMap, toXTDB, trimGuidFromReference

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.InstanceAuditHeaderMapping

addToMap, addTypeDetailsToMap, buildDoc, buildDoc, fromDoc, fromDoc, fromMap, getTypeFromInstance, isKnownBaseProperty

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.mapping.AbstractMapping

getDeserializedValue, getDeserializedValue, getEmbeddedSerializedForm, getEmbeddedSerializedForm, getKeyword, getKeyword

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE_REF_PREFIX

public static final String INSTANCE_REF_PREFIX

See Also:

• Constant Field Values

RELATIONSHIP_PROPERTIES_NS

public static final String RELATIONSHIP_PROPERTIES_NS

See Also:

• Constant Field Values

ENTITY_PROXIES

public static final String ENTITY_PROXIES

Constructor Details

RelationshipMapping

public RelationshipMapping(XTDBOMRSRepositoryConnector xtdbConnector,
 Relationship relationship)

Construct a mapping from a Relationship (to map to a XTDB representation).

Parameters:

xtdbConnector - connectivity to XTDB

relationship - from which to map

RelationshipMapping

public RelationshipMapping(XTDBOMRSRepositoryConnector xtdbConnector,
 xtdb.api.XtdbDocument xtdbDoc,
 xtdb.api.IXtdbDatasource db)

Construct a mapping from a XTDB map (to map to an Egeria representation).

Parameters:

xtdbConnector - connectivity to XTDB

xtdbDoc - from which to map

db - an open database connection for a point-in-time appropriate to the mapping

Method Details

toEgeria

public Relationship toEgeria()

Map from XTDB to Egeria.

Returns:

EntityDetail

See Also:

• RelationshipMapping(XTDBOMRSRepositoryConnector, XtdbDocument, IXtdbDatasource)

toDoc

protected xtdb.api.XtdbDocument.Builder toDoc()

Translate the provided Egeria representation into a XTDB document.

Overrides:

toDoc in class InstanceHeaderMapping

Returns:

XtdbDocument.Builder from which to build the document

toMap

public static clojure.lang.IPersistentMap toMap(Relationship relationship)
                                         throws InvalidParameterException,
IOException

Translate the provided Egeria representation into a XTDB document map.

Parameters:

relationship - to translate

Returns:

IPersistentMap representing the XTDB document

Throws:

InvalidParameterException - on any errors identified within the metadata instance

IOException - on any error serializing the values

fromDoc

protected void fromDoc()

Translate the provided XTDB representation into an Egeria representation.

Overrides:

fromDoc in class InstanceHeaderMapping

getReference

public static String getReference(String guid)

Retrieve the canonical reference to the relationship with the specified GUID.

Parameters:

guid - of the relationship to reference

Returns:

String giving the XTDB reference to this relationship document