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

Interface ReadableTabularDataCollection

All Superinterfaces:

ReadableTabularDataSource, TabularDataCollection

All Known Implementing Classes:

DigitalProductFamilyDataSetCollectionConnector

public interface ReadableTabularDataCollection
extends TabularDataCollection, ReadableTabularDataSource

ReadableTabularDataCollection is the connector API for reading a collection of tabular data sets - a schema of tables, a folder of files, a product family - through a single connector. It is the read-side counterpart of TabularDataCollection, and works the same way: the connector focuses on one table at a time, and the ReadableTabularDataSource methods describe and read the table in focus.

What the read side adds is the ability to say which tables there are. A caller that copies a whole collection asks for the table names, focuses on each in turn with TabularDataCollection.setTableName(String, String), and reads it. The names are in canonical word format - each word capitalized, with spaces between the words - so they can be translated into the naming convention of whatever the data is copied into.

Method Summary

Modifier and Type	Method	Description
List<String>	getTableNames()	Return the names of the tabular data sets in this collection.

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

getColumnDescriptions, getColumnNumber, getRecordCount, getTableDescription, getTableName, readRecord

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

setTableName

Method Details

getTableNames

List<String> getTableNames()
                    throws ConnectorCheckedException

Return the names of the tabular data sets in this collection. Each name can be passed to TabularDataCollection.setTableName(String, String) to bring that data set into focus.

Returns:

list of table names in canonical word format; empty if the collection has no members

Throws:

ConnectorCheckedException - data access problem