Package org.odpi.openmetadata.adapters.connectors.jacquard.tabulardatasets

Class OpenMetadataRootDataSetConnectorBase

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.jacquard.tabulardatasets.OpenMetadataDataSetConnectorBase

org.odpi.openmetadata.adapters.connectors.jacquard.tabulardatasets.OpenMetadataRootDataSetConnectorBase

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, ReadableTabularDataSource, VirtualConnectorExtension

Direct Known Subclasses:

DigitalProductsTabularDataSetConnector, DynamicOpenMetadataDataSetConnectorBase, GovernanceControlsTabularDataSetConnector, LocationsTabularDataSetConnector, OrganizationsTabularDataSetConnector, PeopleTabularDataSetConnector, ReferenceDataSetListConnector, SecretsStoresTabularDataSetConnector

public abstract class OpenMetadataRootDataSetConnectorBase
extends OpenMetadataDataSetConnectorBase

OpenMetadataRootDataSetConnectorBase is the base class for the tabular data set built on OpenMetadataRootElements. The constructor allows the provider to pass the product definition to the open metadata repository.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<Long,OpenMetadataRootElement>	records

Fields inherited from class org.odpi.openmetadata.adapters.connectors.jacquard.tabulardatasets.OpenMetadataDataSetConnectorBase

auditLog, connectorContext, connectorName, productDefinition, propertyHelper

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
OpenMetadataRootDataSetConnectorBase(String connectorName)	Constructor used to set up the name of this connector (supplied by the subclasses).
OpenMetadataRootDataSetConnectorBase(String connectorName, ProductDefinition productDefinition)	Constructor used to set up the name of this connector (supplied by the subclasses).

Method Summary

Modifier and Type	Method	Description
long	getRecordCount()	Return the record count in the data source.
protected void	processNestedValues(OpenMetadataRootElement element, List<String> knownGUIDs)	Process any nested records.
List<String>	readRecord(long rowNumber)	Return the requested data record.
void	refreshCache(String metadataTypeName)	Refresh any cached values.
protected List<String>	refreshExistingRecords()	Refresh any existing records.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.jacquard.tabulardatasets.OpenMetadataDataSetConnectorBase

disconnect, getColumnDescriptions, getColumnDescriptions, getColumnNumber, getConnectorComponentDescription, getElementHeaderRecordValue, getElementRecordValue, getElementRecordValue, getRecordValues, getRecordValues, getTableDescription, getTableName, getTabularColumnDescription, refreshCache, setAuditLog, setColumnDescriptions, setLocalEnvironment

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

combineConfigurationProperties, disconnectConnectors, equals, fromCamelToCanonicalCase, fromCanonicalToCamelCase, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getSecretsCollectionName, getSecretsLocation, getSecretsProvider, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingEndpointAddress, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, refreshStatistics, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

records

protected final Map<Long,OpenMetadataRootElement> records

Constructor Details

OpenMetadataRootDataSetConnectorBase

public OpenMetadataRootDataSetConnectorBase(String connectorName)

Constructor used to set up the name of this connector (supplied by the subclasses).

Parameters:

connectorName - name of the connector

OpenMetadataRootDataSetConnectorBase

public OpenMetadataRootDataSetConnectorBase(String connectorName,
 ProductDefinition productDefinition)

Constructor used to set up the name of this connector (supplied by the subclasses).

Parameters:

connectorName - name of the connector

Method Details

start

public void start()
           throws UserNotAuthorizedException,
ConnectorCheckedException

Indicates that the connector is completely configured and can begin processing.

Overrides:

start in class OpenMetadataDataSetConnectorBase

Throws:

ConnectorCheckedException - the connector detected a problem.

UserNotAuthorizedException - the connector was disconnected before/during start

refreshExistingRecords

protected List<String> refreshExistingRecords()
                                       throws ConnectorCheckedException

Refresh any existing records.

Returns:

list of GUIDs already processed and stored in the records

Throws:

ConnectorCheckedException - problem processing existing records

processNestedValues

protected void processNestedValues(OpenMetadataRootElement element,
 List<String> knownGUIDs)

Process any nested records.

Parameters:

element - retrieved element

knownGUIDs - list of records already processed

refreshCache

public void refreshCache(String metadataTypeName)
                  throws ConnectorCheckedException

Refresh any cached values.

Parameters:

metadataTypeName - name of the metadata type to refresh

Throws:

ConnectorCheckedException - unable to refresh

getRecordCount

public long getRecordCount()

Return the record count in the data source.

Returns:

count

readRecord

public List<String> readRecord(long rowNumber)
                        throws ConnectorCheckedException

Return the requested data record. The first record is record 0.

Parameters:

rowNumber - long

Returns:

list of values (as strings) where each string is the value from a column. The order is the same as the columns

Throws:

ConnectorCheckedException - a problem occurred accessing the data.