org.odpi.egeria.connectors.juxt.crux.mapping

Class EntityProxyMapping

java.lang.Object

org.odpi.egeria.connectors.juxt.crux.mapping.AbstractMapping

org.odpi.egeria.connectors.juxt.crux.mapping.InstanceAuditHeaderMapping

org.odpi.egeria.connectors.juxt.crux.mapping.InstanceHeaderMapping

org.odpi.egeria.connectors.juxt.crux.mapping.EntitySummaryMapping

org.odpi.egeria.connectors.juxt.crux.mapping.EntityProxyMapping

public class EntityProxyMapping
extends EntitySummaryMapping

Maps the properties of EntityProxies between persistence and objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_PROXY_ONLY_MARKER

Fields inherited from class org.odpi.egeria.connectors.juxt.crux.mapping.EntitySummaryMapping

INSTANCE_REF_PREFIX, N_CLASSIFICATIONS

Fields inherited from class org.odpi.egeria.connectors.juxt.crux.mapping.InstanceHeaderMapping

cruxDoc, instanceHeader

Fields inherited from class org.odpi.egeria.connectors.juxt.crux.mapping.InstanceAuditHeaderMapping

CREATE_TIME, CURRENT_STATUS, METADATA_COLLECTION_ID, TYPE_DEF_CATEGORY, TYPE_DEF_GUIDS, UPDATE_TIME, VERSION

Fields inherited from class org.odpi.egeria.connectors.juxt.crux.mapping.AbstractMapping

cruxConnector, mapper

Constructor Summary

Constructors

Constructor and Description
EntityProxyMapping(CruxOMRSRepositoryConnector cruxConnector, crux.api.CruxDocument cruxDoc) Construct a mapping from a Crux map (to map to an Egeria representation).
EntityProxyMapping(CruxOMRSRepositoryConnector cruxConnector, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityProxy) Construct a mapping from an EntityDetail (to map to a Crux representation).

Method Summary

Modifier and Type	Method and Description
protected void	fromDoc() Translate the provided Crux representation into an Egeria representation.
static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy	getFromDoc(CruxOMRSRepositoryConnector cruxConnector, crux.api.CruxDocument doc) Translate the provided Crux representation of an entity into an EntityProxy.
static String	getReference(String guid) Retrieve the canonical reference to the entity summary with the specified GUID.
static boolean	isOnlyAProxy(crux.api.CruxDocument doc) Indicates whether the provided map represents only an EntityProxy (true) or a full EntityDetail (false).
protected crux.api.CruxDocument.Builder	toDoc() Translate the provided Egeria representation into a Crux map.
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy	toEgeria() Map from Crux to Egeria.

Methods inherited from class org.odpi.egeria.connectors.juxt.crux.mapping.InstanceHeaderMapping

getGuidReference, getReference, toCrux, trimGuidFromReference

Methods inherited from class org.odpi.egeria.connectors.juxt.crux.mapping.InstanceAuditHeaderMapping

buildDoc, buildDoc, fromDoc, fromDoc

Methods inherited from class org.odpi.egeria.connectors.juxt.crux.mapping.AbstractMapping

getDeserializedValue, getEmbeddedSerializedForm, getKeyword, getKeyword

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_PROXY_ONLY_MARKER

public static final String ENTITY_PROXY_ONLY_MARKER

Constructor Detail

EntityProxyMapping

public EntityProxyMapping(CruxOMRSRepositoryConnector cruxConnector,
                          org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityProxy)

Construct a mapping from an EntityDetail (to map to a Crux representation).

Parameters:

cruxConnector - connectivity to Crux

entityProxy - from which to map

EntityProxyMapping

public EntityProxyMapping(CruxOMRSRepositoryConnector cruxConnector,
                          crux.api.CruxDocument cruxDoc)

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

Parameters:

cruxConnector - connectivity to Crux

cruxDoc - from which to map

Method Detail

toEgeria

public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy toEgeria()

Map from Crux to Egeria.

Overrides:

toEgeria in class EntitySummaryMapping

Returns:

EntityProxy

See Also:

EntityProxyMapping(CruxOMRSRepositoryConnector, CruxDocument)

toDoc

protected crux.api.CruxDocument.Builder toDoc()

Translate the provided Egeria representation into a Crux map.

Overrides:

toDoc in class EntitySummaryMapping

Returns:

CruxDocument.Builder from which to build the document

fromDoc

protected void fromDoc()

Translate the provided Crux representation into an Egeria representation.

Overrides:

fromDoc in class EntitySummaryMapping

getFromDoc

public static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy getFromDoc(CruxOMRSRepositoryConnector cruxConnector,
                                                                                                                                             crux.api.CruxDocument doc)

Translate the provided Crux representation of an entity into an EntityProxy.

Parameters:

cruxConnector - connectivity to the Crux environment

doc - containing the Crux representation of the entity

Returns:

EntityProxy

getReference

public static String getReference(String guid)

Retrieve the canonical reference to the entity summary with the specified GUID.

Parameters:

guid - of the entity summary to reference

Returns:

String giving the Crux reference to this entity summary document

isOnlyAProxy

public static boolean isOnlyAProxy(crux.api.CruxDocument doc)

Indicates whether the provided map represents only an EntityProxy (true) or a full EntityDetail (false).

Parameters:

doc - containing the Crux representation

Returns:

boolean