org.odpi.openmetadata.adapters.connectors.structuredfile

Class StructuredFileStoreConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.structuredfile.StructuredFileStoreConnector

All Implemented Interfaces:

StructuredFileStore

public class StructuredFileStoreConnector
extends ConnectorBase
implements StructuredFileStore

StructuredFileStoreConnector 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.frameworks.connectors.ConnectorBase

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, isActive, securedProperties

Constructor Summary

Constructors

Constructor and Description
StructuredFileStoreConnector()

Method Summary

Modifier and Type	Method and Description
void	disconnect() Close the config file
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.
void	initialize(String connectorInstanceId, ConnectionProperties connectionProperties) Initialize the connector.
List<String>	readRecord(int dataRecordNumber) Return the requested data record.

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

equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initializeConnectedAssetProperties, isActive, start, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StructuredFileStoreConnector

public StructuredFileStoreConnector()

Method Detail

initialize

public void initialize(String connectorInstanceId,
                       ConnectionProperties connectionProperties)

Initialize the connector.

Overrides:

initialize in class ConnectorBase

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 FileReadException

Return the name of the file to read.

Specified by:

getFileName in interface StructuredFileStore

Returns:

file name

Throws:

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

getLastUpdateDate

public Date getLastUpdateDate()
                       throws FileReadException

Return the last update data for the file.

Specified by:

getLastUpdateDate in interface StructuredFileStore

Returns:

Date object

Throws:

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

getRecordCount

public 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.

Specified by:

getRecordCount in interface StructuredFileStore

Returns:

count

Throws:

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

getColumnNames

public 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.

Specified by:

getColumnNames in interface StructuredFileStore

Returns:

a list of column names

Throws:

FileReadException - unable to retrieve the column names

readRecord

public List<String> readRecord(int dataRecordNumber)
                        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.

Specified by:

readRecord in interface StructuredFileStore

Parameters:

dataRecordNumber - 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.

disconnect

public void disconnect()

Close the config file

Overrides:

disconnect in class ConnectorBase