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
public class CSVFileStoreConnector extends BasicFileStoreConnector implements CSVFileStore
CSVFileStoreConnector works with structured files to retrieve simple tables of data.

  • Constructor Details

    • CSVFileStoreConnector

      public CSVFileStoreConnector()

  • Method Details

    • initialize

      public void initialize(String connectorInstanceId, ConnectionProperties connectionProperties)
      Initialize the connector.
      Overrides:
      initialize in class BasicFileStoreConnector
      Parameters:
      connectorInstanceId - - unique id for the connector instance - useful for messages etc
      connectionProperties - - POJO for the configuration used to create the connector.

    • getFileName

      public String getFileName() throws FileException
      Return the name of the file to read.
      Specified by:
      getFileName in interface CSVFileStore
      Returns:
      file name
      Throws:
      FileException - problem accessing the file

    • getLastUpdateDate

      public Date getLastUpdateDate() throws FileException
      Return the last update data for the file.
      Specified by:
      getLastUpdateDate in interface CSVFileStore
      Returns:
      Date object
      Throws:
      FileException - problem accessing the file

    • 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(int 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