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

Class ValidValueDataSetConnector

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.ValidValueDataSetConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, ReadableTabularDataSource, TabularDataCollection, WritableTabularDataSource, VirtualConnectorExtension

public class ValidValueDataSetConnector
extends ReferenceDataSetConnectorBase
implements AuditLoggingComponent, ReadableTabularDataSource, WritableTabularDataSource, TabularDataCollection

ValidValueDataSetConnector enables interaction with a valid value set as if it is a tabular data set.

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 String	validValueSetGUID

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
ValidValueDataSetConnector()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	appendRecord(List<String> dataValues)	Write the requested data record to the end of the data source.
void	deleteRecord(long rowNumber)	Remove the requested data record.
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 canonical table name for this data source.
List<String>	readRecord(long rowNumber)	Return the requested data record.
void	refreshCache()	Refresh any cached values,
void	setTableName(String tableName, String tableDescription)	Set up the canonical table name for this data source.
void	start()	Indicates that the connector is completely configured and can begin processing.
void	writeRecord(long requestedRowNumber, List<String> dataValues)	Write the requested data record.

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

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

setColumnDescriptions

Field Details

validValueSetGUID

protected String validValueSetGUID

Constructor Details

ValidValueDataSetConnector

public ValidValueDataSetConnector()

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

Specified by:

getRecordCount in interface WritableTabularDataSource

Returns:

count

getTableName

public String getTableName()
                    throws ConnectorCheckedException

Return the canonical table name for this data source. Each word in the name should be capitalized, with spaces between the words to allow 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

setTableName

public void setTableName(String tableName,
 String tableDescription)

Set up the canonical table name for this data source. Each word in the name should be capitalized, with spaces between the words to allow translation between different naming conventions.

Specified by:

setTableName in interface TabularDataCollection

Parameters:

tableName - string

tableDescription - optional description

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.

writeRecord

public void writeRecord(long requestedRowNumber,
 List<String> dataValues)
                 throws ConnectorCheckedException

Write the requested data record. The first data record is record 0. This process reads the entire file, inserts the record in the right place and writes it out again.

Specified by:

writeRecord in interface WritableTabularDataSource

Parameters:

requestedRowNumber - long

dataValues - Map of column descriptions to strings, each string is the value for the column.

Throws:

ConnectorCheckedException - there is a problem accessing the data.

appendRecord

public void appendRecord(List<String> dataValues)
                  throws ConnectorCheckedException

Write the requested data record to the end of the data source.

Specified by:

appendRecord in interface WritableTabularDataSource

Parameters:

dataValues - Map of column descriptions to strings, each string is the value for the column.

Throws:

ConnectorCheckedException - there is a problem accessing the data.

deleteRecord

public void deleteRecord(long rowNumber)
                  throws ConnectorCheckedException

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

Specified by:

deleteRecord in interface WritableTabularDataSource

Parameters:

rowNumber - long

Throws:

ConnectorCheckedException - there is a problem accessing the data.

disconnect

public void disconnect()

Close the file

Overrides:

disconnect in class ReferenceDataSetConnectorBase