Package org.odpi.egeria.connectors.juxt.xtdb.readops

Class GetEntity

java.lang.Object

org.odpi.egeria.connectors.juxt.xtdb.readops.AbstractReadOperation

org.odpi.egeria.connectors.juxt.xtdb.readops.GetEntity

public class GetEntity
extends AbstractReadOperation

Base class to retrieve entity information.

Field Summary

Fields inherited from class org.odpi.egeria.connectors.juxt.xtdb.readops.AbstractReadOperation

asOfTime, existingDB, xtdb

Constructor Summary

Constructors

Constructor	Description
GetEntity(XtdbOMRSRepositoryConnector xtdb, String guid, Date asOfTime)	Default constructor ensures that a consistent datasource is created and used for the entirety of the operation, and further ensures it is fully-closed afterwards irrespective of any exceptions.

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail	asDetail()	Retrieve the requested entity as a detailed object from the XTDB repository.
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy	asProxy()	Retrieve the requested entity as a proxy from the XTDB repository.
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary	asSummary()	Retrieve the requested entity as a summary from the XTDB repository.
static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail	detailByGuid(XtdbOMRSRepositoryConnector xtdb, xtdb.api.IXtdbDatasource db, String guid)	Translate the provided Egeria unique identifier into an Egeria entity.
static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail	detailByRef(XtdbOMRSRepositoryConnector xtdb, xtdb.api.IXtdbDatasource db, String ref)	Translate the provided XTDB document reference into an Egeria entity.
static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy	proxyByGuid(XtdbOMRSRepositoryConnector xtdb, xtdb.api.IXtdbDatasource db, String guid)	Translate the provided Egeria unique identifier into an Egeria entity.
static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy	proxyByRef(XtdbOMRSRepositoryConnector xtdb, xtdb.api.IXtdbDatasource db, String ref)	Translate the provided XTDB document reference into an Egeria entity.
static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary	summaryByGuid(XtdbOMRSRepositoryConnector xtdb, xtdb.api.IXtdbDatasource db, String guid)	Translate the provided Egeria unique identifier into an Egeria entity.
static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary	summaryByRef(XtdbOMRSRepositoryConnector xtdb, xtdb.api.IXtdbDatasource db, String ref)	Translate the provided XTDB document reference into an Egeria entity.

Methods inherited from class org.odpi.egeria.connectors.juxt.xtdb.readops.AbstractReadOperation

getXtdbObjectByReference

Methods inherited from class java.lang.Object

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

Constructor Detail

GetEntity

public GetEntity(XtdbOMRSRepositoryConnector xtdb,
                 String guid,
                 Date asOfTime)

Default constructor ensures that a consistent datasource is created and used for the entirety of the operation, and further ensures it is fully-closed afterwards irrespective of any exceptions.

Parameters:

xtdb - connectivity to XTDB

guid - of the entity to retrieve

asOfTime - (optional) validity time for which to open the datasource

Method Detail

asSummary

public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary asSummary()
                                                                                                                                throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException

Retrieve the requested entity as a summary from the XTDB repository.

Returns:

EntitySummary as it existed at the specified point in time

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - if any issue closing an open XTDB resource

asProxy

public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy asProxy()
                                                                                                                            throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException

Retrieve the requested entity as a proxy from the XTDB repository.

Returns:

EntityProxy as it existed at the specified point in time

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - if any issue closing an open XTDB resource

asDetail

public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail asDetail()
                                                                                                                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                                                                                                                     org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityProxyOnlyException

Retrieve the requested entity as a detailed object from the XTDB repository.

Returns:

EntityDetail as it existed at the specified point in time

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - if any issues closing an open XTDB resource

org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityProxyOnlyException - if the retrieved entity is only a proxy

summaryByGuid

public static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary summaryByGuid(XtdbOMRSRepositoryConnector xtdb,
                                                                                                                                                  xtdb.api.IXtdbDatasource db,
                                                                                                                                                  String guid)

Translate the provided Egeria unique identifier into an Egeria entity.

Parameters:

xtdb - connectivity to XTDB

db - from which to retrieve the details

guid - unique identifier of the Egeria entity

Returns:

EntitySummary

summaryByRef

public static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary summaryByRef(XtdbOMRSRepositoryConnector xtdb,
                                                                                                                                                 xtdb.api.IXtdbDatasource db,
                                                                                                                                                 String ref)

Translate the provided XTDB document reference into an Egeria entity.

Parameters:

xtdb - connectivity to XTDB

db - from which to retrieve the details

ref - internal XTDB reference to the entity document

Returns:

EntitySummary

proxyByGuid

public static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy proxyByGuid(XtdbOMRSRepositoryConnector xtdb,
                                                                                                                                              xtdb.api.IXtdbDatasource db,
                                                                                                                                              String guid)

Translate the provided Egeria unique identifier into an Egeria entity.

Parameters:

xtdb - connectivity to XTDB

db - from which to retrieve the details

guid - unique identifier of the Egeria entity

Returns:

EntityProxy

proxyByRef

public static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy proxyByRef(XtdbOMRSRepositoryConnector xtdb,
                                                                                                                                             xtdb.api.IXtdbDatasource db,
                                                                                                                                             String ref)

Translate the provided XTDB document reference into an Egeria entity.

Parameters:

xtdb - connectivity to XTDB

db - from which to retrieve the details

ref - internal XTDB reference to the entity document

Returns:

EntityProxy

detailByGuid

public static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail detailByGuid(XtdbOMRSRepositoryConnector xtdb,
                                                                                                                                                xtdb.api.IXtdbDatasource db,
                                                                                                                                                String guid)
                                                                                                                                         throws org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityProxyOnlyException

Translate the provided Egeria unique identifier into an Egeria entity.

Parameters:

xtdb - connectivity to XTDB

db - from which to retrieve the details

guid - unique identifier of the Egeria entity

Returns:

EntityDetail

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityProxyOnlyException - if the retrieved entity is only a proxy

detailByRef

public static org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail detailByRef(XtdbOMRSRepositoryConnector xtdb,
                                                                                                                                               xtdb.api.IXtdbDatasource db,
                                                                                                                                               String ref)
                                                                                                                                        throws org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityProxyOnlyException

Translate the provided XTDB document reference into an Egeria entity.

Parameters:

xtdb - connectivity to XTDB

db - from which to retrieve the details

ref - reference to the entity document

Returns:

EntityDetail

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityProxyOnlyException - if the retrieved entity is only a proxy