com.northconcepts.datapipeline.openfinancialexchange.OpenFinancialExchangeReader

public class OpenFinancialExchangeReader extends IntegrationReader

Read an OFX / QFX (Quicken) / QBO (QuickBooks) file as a single nested Record that mirrors the document's aggregate hierarchy, using the OFX tag names (BANKMSGSRSV1, STMTTRN, TRNAMT, ...) as field names.

Child aggregates become nested Records, repeating aggregates become ArrayValues, and elements that are absent or empty are left out entirely. Values keep the types ofx4j produces, so tax-form amounts and dates (which OFX models as free-form strings) stay strings.

Every repeating list ofx4j exposes becomes one ArrayValue. Where such a list is an aggregate's only content and its entries can be of different kinds (INVPOSLIST, SECLIST, MSGSETLIST), the field itself is that array and each entry is a one-field record naming the entry's own tag (POSSTOCK, STOCKINFO, BANKMSGSET, ...). INVTRANLIST also carries DTSTART and DTEND, so it stays a record and its mixed transactions sit in a TRANSACTIONS array - the one field name here that is not an OFX tag.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint
DataEndpoint.State
Field Summary

Fields inherited from class com.northconcepts.datapipeline.core.DataReader
fieldLineage, recordLineage

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint
lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint
BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject
id, log, name, TIMESTAMP_FORMAT
Constructor Summary

Constructors

Constructor

Description

OpenFinancialExchangeReader(File file)

Read an OFX/QFX/QBO file.

OpenFinancialExchangeReader(InputStream inputStream)

Read a stream of OFX/QFX/QBO data.
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this endpoint's current state to a DataException.

void

close()

Indicates that this endpoint has finished reading or writing.

void

open()

Makes this endpoint ready for reading or writing.

protected Record

readImpl()

Overridden by subclasses to read the next record from this DataReader.

Methods inherited from class com.northconcepts.datapipeline.core.DataReader
addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, setSaveLineage, skip

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint
decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint
addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject
exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- OpenFinancialExchangeReader
  
  public OpenFinancialExchangeReader(File file)
  
  Read an OFX/QFX/QBO file.
  
  Parameters:
  
  file - the file to be read
- OpenFinancialExchangeReader
  
  public OpenFinancialExchangeReader(InputStream inputStream)
  
  Read a stream of OFX/QFX/QBO data.
  
  Parameters:
  
  inputStream - the source stream
Method Details
- open
  
  public void open() throws DataException
  
  Description copied from class: DataEndpoint
  
  Makes this endpoint ready for reading or writing.
  
  Overrides:
  
  open in class IntegrationReader
  
  Throws:
  
  DataException
- close
  
  public void close() throws DataException
  
  Description copied from class: DataEndpoint
  
  Indicates that this endpoint has finished reading or writing.
  
  Overrides:
  
  close in class DataEndpoint
  
  Throws:
  
  DataException
- readImpl
  
  protected Record readImpl()
  
  Description copied from class: DataReader
  Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.
  If no record is available, null will be returned.
  Contract for subclasses (see also docs/authoring/DataReader.md):
  
  Return null exactly once to signal end-of-stream.
  
  Do not call this method directly — DataReader.read() is the template method that wraps exceptions, increments the record count, and tracks lineage.
  
  Do not call DataEndpoint.incrementRecordCount() here; DataReader.read() already does.
  
  Throw raw exceptions; DataReader.read() wraps them via exception(throwable).
  Specified by:
  
  readImpl in class DataReader
- addExceptionProperties
  
  public DataException addExceptionProperties(DataException exception)
  
  Description copied from class: Endpoint
  
  Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.
  
  Overrides:
  
  addExceptionProperties in class DataReader

Class OpenFinancialExchangeReader

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Field Summary

Fields inherited from class com.northconcepts.datapipeline.core.DataReader

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.core.DataReader

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

Methods inherited from class java.lang.Object

Constructor Details

OpenFinancialExchangeReader

OpenFinancialExchangeReader

Method Details

open

close

readImpl

addExceptionProperties