Package org.odpi.openmetadata.frameworks.connectors.tabulardatasets

Interface ReadableTabularDataSource

All Known Implementing Classes:
CSVFileStoreConnector, ReferenceDataSetConnectorBase, ValidValueDataSetConnector, ValidValueSetListConnector
public interface ReadableTabularDataSource
ReadableTabularDataSource defines the specific connector api for reading simple tabular data. Each row represents a record that is divided into columns. Each row has the same list of columns and so the data source is effectively a table of data.

  • Method Details

    • getRecordCount

      long getRecordCount() throws ConnectorCheckedException
      Return the number of records in the data source.
      Returns:
      count
      Throws:
      ConnectorCheckedException - there is a problem accessing the data

    • getTableName

      String getTableName() throws ConnectorCheckedException
      Return the table name for this data source. This is in canonical word format where each word in the name should be capitalized, with spaces between the words. This format allows easy translation between different naming conventions.
      Returns:
      string
      Throws:
      ConnectorCheckedException - there is a problem accessing the data

    • getTableDescription

      String getTableDescription() throws ConnectorCheckedException
      Return the description for this data source.
      Returns:
      string
      Throws:
      ConnectorCheckedException - there is a problem accessing the data

    • getColumnDescriptions

      List<TabularColumnDescription> getColumnDescriptions() throws ConnectorCheckedException
      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. The names of the columns should be in a canonical name format where each word in the name is capitalized with a space between each word. This allows simple translation between the naming conventions supported by different technologies.
      Returns:
      a list of column descriptions or null if not available.
      Throws:
      ConnectorCheckedException - there is a problem accessing the data

    • getColumnNumber

      int getColumnNumber(String columnName) throws ConnectorCheckedException
      Locate the named column. A negative number means the column is not present.
      Parameters:
      columnName - name of the column to return
      Returns:
      column
      Throws:
      ConnectorCheckedException - problem extracting the column descriptions

    • readRecord

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