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

Class ValidValueSetListConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.referencedata.tabulardatasets.ReferenceDataSetConnectorBase

org.odpi.openmetadata.adapters.connectors.referencedata.tabulardatasets.ValidValueSetListConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, ReadableTabularDataSource, VirtualConnectorExtension

public class ValidValueSetListConnector
extends ReferenceDataSetConnectorBase
implements AuditLoggingComponent, ReadableTabularDataSource

ValidValueSetListConnector maintains a tabular data set that lists the valid value sets in open metadata. Valid value sets are valid value definitions with no valid value parent and one or more members.

Nested Class Summary

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

ConnectorBase.ProtectedConnection

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.connectors.referencedata.tabulardatasets.ReferenceDataSetConnectorBase

auditLog, columnDescriptions, connectorContext, connectorName

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

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
ValidValueSetListConnector()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Close the file
List<TabularColumnDescription>	getColumnDescriptions()	Return the list of column descriptions associated with this data source.
long	getRecordCount()	Return the number of records in the data source.
String	getTableDescription()	Return the description for this data source.
String	getTableName()	Return the table name for this data source.
List<String>	readRecord(long rowNumber)	Return the requested data record.
void	refreshCache()	Refresh any cached values,
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.referencedata.tabulardatasets.ReferenceDataSetConnectorBase

getColumnNumber, getConnectorComponentDescription, getTabularColumnDescription, setAuditLog, setColumnDescriptions, setLocalEnvironment

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

combineConfigurationProperties, disconnectConnectors, equals, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, 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

Methods inherited from interface org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent

getConnectorComponentDescription, setAuditLog

Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.tabulardatasets.ReadableTabularDataSource

getColumnNumber

Constructor Details

ValidValueSetListConnector

public ValidValueSetListConnector()

Default constructor

Method Details

start

public void start()
           throws UserNotAuthorizedException,
ConnectorCheckedException

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

Overrides:

start in class ReferenceDataSetConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.

UserNotAuthorizedException - the connector was disconnected before/during start

refreshCache

public void refreshCache()
                  throws ConnectorCheckedException

Refresh any cached values,

Specified by:

refreshCache in class ReferenceDataSetConnectorBase

Throws:

ConnectorCheckedException - unable to refresh

getRecordCount

public long getRecordCount()

Return the number of records in the data source.

Specified by:

getRecordCount in interface ReadableTabularDataSource

Returns:

count

getTableName

public String getTableName()
                    throws ConnectorCheckedException

Return the table name for this data source. This is in canonical name format where each word in the name should be capitalized, with spaces between the words. This format allows easy translation between different naming conventions.

Specified by:

getTableName in interface ReadableTabularDataSource

Returns:

string

Throws:

ConnectorCheckedException - there is a problem accessing the data

getTableDescription

public String getTableDescription()

Return the description for this data source.

Specified by:

getTableDescription in interface ReadableTabularDataSource

Returns:

string

getColumnDescriptions

public List<TabularColumnDescription> getColumnDescriptions()

Return the list of column descriptions associated with this data source. The information should be sufficient to define the schema in a target data store. This list is the default column descriptions. The caller can override them.

Specified by:

getColumnDescriptions in interface ReadableTabularDataSource

Overrides:

getColumnDescriptions in class ReferenceDataSetConnectorBase

Returns:

a list of column descriptions or null if not available.

readRecord

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

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

Specified by:

readRecord in interface ReadableTabularDataSource

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 - there is a problem accessing the data.

disconnect

public void disconnect()

Close the file

Overrides:

disconnect in class ReferenceDataSetConnectorBase