Package org.odpi.openmetadata.adapters.connectors.datastore.csvfile

Class CSVFileStoreConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.datastore.basicfile.BasicFileStoreConnector

org.odpi.openmetadata.adapters.connectors.datastore.csvfile.CSVFileStoreConnector

All Implemented Interfaces:

BasicFileStore, CSVFileStore, SecureConnectorExtension, VirtualConnectorExtension

public class CSVFileStoreConnector
extends BasicFileStoreConnector
implements CSVFileStore

CSVFileStoreConnector works with structured files to retrieve simple tables of data.

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.datastore.basicfile.BasicFileStoreConnector

fileStoreName

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

auditLog, connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
CSVFileStoreConnector()

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Close the file
List<String>	getColumnNames()	Return the list of column names associated with this structured file.
char	getDelimiterChar()	Return the defined delimiter character.
char	getQuoteChar()	Return the defined quote char.
long	getRecordCount()	Return the number of records in the file.
List<String>	getSuppliedColumnNames()	Return any fixed column names defined by the connector
List<String>	readRecord(long dataRecordNumber)	Return the requested data record.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.datastore.basicfile.BasicFileStoreConnector

getCreationDate, getFile, getFile, getFileLength, getFileName, getLastAccessDate, getLastUpdateDate, setFileStoreName

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.adapters.connectors.datastore.basicfile.BasicFileStore

getCreationDate, getFile, getFileLength, getFileName, getLastAccessDate, getLastUpdateDate

Constructor Details

CSVFileStoreConnector

public CSVFileStoreConnector()

Method Details

start

public void start()
           throws UserNotAuthorizedException,
ConnectorCheckedException

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

Overrides:

start in class BasicFileStoreConnector

Throws:

ConnectorCheckedException - there is a problem within the connector.

UserNotAuthorizedException - the connector was disconnected before/during start

getSuppliedColumnNames

public List<String> getSuppliedColumnNames()

Return any fixed column names defined by the connector

Returns:

list of configured column names

getDelimiterChar

public char getDelimiterChar()

Return the defined delimiter character.

Returns:

char

getQuoteChar

public char getQuoteChar()

Return the defined quote char.

Returns:

char

getRecordCount

public long getRecordCount()
                    throws FileException,
FileReadException

Return the number of records in the file. This is achieved by scanning the file and counting the records - not recommended for very large files.

Specified by:

getRecordCount in interface CSVFileStore

Returns:

count

Throws:

FileException - problem accessing the file

FileReadException - unable to find, open or scan the file.

getColumnNames

public List<String> getColumnNames()
                            throws FileException,
FileReadException

Return the list of column names associated with this structured file. This may be embedded in the first line of the file or encoded in the connection object used to create a connector instance.

Specified by:

getColumnNames in interface CSVFileStore

Returns:

a list of column names

Throws:

FileException - problem accessing the file

FileReadException - unable to retrieve the column names

readRecord

public List<String> readRecord(long dataRecordNumber)
                        throws FileException,
FileReadException

Return the requested data record. The first record is record 0. If the first line of the file is the column names then record 0 is the line following the column names.

Specified by:

readRecord in interface CSVFileStore

Parameters:

dataRecordNumber - long

Returns:

List of strings, each string is the value from the column.

Throws:

FileException - problem accessing the file

FileReadException - unable to find, open or read the file, or the file does not include the requested record.

disconnect

public void disconnect()

Close the file

Overrides:

disconnect in class BasicFileStoreConnector