org.odpi.openmetadata.adapters.connectors.structuredfile

Interface StructuredFileStore

All Known Implementing Classes:

StructuredFileStoreConnector

public interface StructuredFileStore

StructuredFileStore defines the specific connector api for working with structured files. A structured file is one where each row represents a record that is divided into attributes that are separated by a special character (usually a space). Each row has the same list of attributes and so the file is effectively a table of data.

Method Summary

Modifier and Type	Method and Description
List<String>	getColumnNames() Return the list of column names associated with this structured file.
String	getFileName() Return the name of the file to read.
Date	getLastUpdateDate() Return the last update data for the file.
long	getRecordCount() Return the number of records in the file.
List<String>	readRecord(int rowNumber) Return the requested data record.

Method Detail

getFileName

String getFileName()
            throws FileReadException

Return the name of the file to read.

Returns:

file name

Throws:

FileReadException - - the file name is null, the file does not exist, or is a directory or is not readable.

getLastUpdateDate

Date getLastUpdateDate()
                throws FileReadException

Return the last update data for the file.

Returns:

Date object

Throws:

FileReadException - - the file name is null, the file does not exist, or is a directory or is not readable.

getRecordCount

long getRecordCount()
             throws 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.

Returns:

count

Throws:

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

getColumnNames

List<String> getColumnNames()
                     throws 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.

Returns:

a list of column names

Throws:

FileReadException - unable to retrieve the column names

readRecord

List<String> readRecord(int rowNumber)
                 throws 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.

Parameters:

rowNumber - long

Returns:

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

Throws:

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