com.northconcepts.datapipeline.json.JsonWriter

public class JsonWriter extends TextWriter

Writes records as JSON using a JsonTemplate that defines the header, each record's detail and the footer.

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.AbstractWriter
currentRecord

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

JsonWriter(JsonTemplate template, File file)

JsonWriter(JsonTemplate template, Writer writer)
Method Summary

Modifier and Type

Method

Description

void

close()

Indicates that this endpoint has finished reading or writing.

void

open()

Makes this endpoint ready for reading or writing.

JsonWriter

setAutoCloseWriter(boolean autoCloseWriter)

Indicates if the underlying java.io.BufferedWriter should be closed when this stream closes (defaults to true).

JsonWriter

setDescription(String description)

Sets the optional text shown for this endpoint in Endpoint.toString() and exception properties.

JsonWriter

setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

Indicates if a header row of field names is written before the first record (default is true); must be called before AbstractWriter.open().

JsonWriter

setFlushOnWrite(boolean flushOnWrite)

Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written (defaults to false).

protected void

writeRecord(Record record)

Writes one row; called first for the header row (see AbstractWriter.isHeaderRow()) when field names are written, then for each record.

Methods inherited from class com.northconcepts.datapipeline.core.TextWriter
addExceptionProperties, getFile, getWriter, isAppend, isAutoCloseWriter, isFieldNamesInFirstRow, isFlushOnWrite, write

Methods inherited from class com.northconcepts.datapipeline.core.AbstractWriter
createHeaderRecord, isHeaderRow, writeImpl

Methods inherited from class com.northconcepts.datapipeline.core.DataWriter
available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, getWriter

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

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
- JsonWriter
  
  public JsonWriter(JsonTemplate template, File file)
- JsonWriter
  
  public JsonWriter(JsonTemplate template, Writer writer)
Method Details
- setAutoCloseWriter
  
  public JsonWriter setAutoCloseWriter(boolean autoCloseWriter)
  
  Description copied from class: TextWriter
  
  Indicates if the underlying java.io.BufferedWriter should be closed when this stream closes (defaults to true).
  
  Overrides:
  
  setAutoCloseWriter in class TextWriter
- setFlushOnWrite
  
  public JsonWriter setFlushOnWrite(boolean flushOnWrite)
  
  Description copied from class: TextWriter
  
  Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written (defaults to false).
  
  Overrides:
  
  setFlushOnWrite in class TextWriter
- setFieldNamesInFirstRow
  
  public JsonWriter setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
  
  Description copied from class: AbstractWriter
  
  Indicates if a header row of field names is written before the first record (default is true); must be called before AbstractWriter.open().
  
  Overrides:
  
  setFieldNamesInFirstRow in class AbstractWriter
- setDescription
  
  public JsonWriter setDescription(String description)
  
  Description copied from class: Endpoint
  
  Sets the optional text shown for this endpoint in Endpoint.toString() and exception properties.
  
  Overrides:
  
  setDescription in class Endpoint
- open
  
  public void open()
  
  Description copied from class: DataEndpoint
  
  Makes this endpoint ready for reading or writing.
  
  Overrides:
  
  open in class AbstractWriter
- close
  
  public void close()
  
  Description copied from class: DataEndpoint
  
  Indicates that this endpoint has finished reading or writing.
  
  Overrides:
  
  close in class TextWriter
- writeRecord
  
  protected void writeRecord(Record record) throws Throwable
  
  Description copied from class: AbstractWriter
  
  Writes one row; called first for the header row (see AbstractWriter.isHeaderRow()) when field names are written, then for each record.
  
  Specified by:
  
  writeRecord in class AbstractWriter
  
  Throws:
  
  Throwable

Class JsonWriter

Nested Class Summary

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

Field Summary

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

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

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

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

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

JsonWriter

JsonWriter

Method Details

setAutoCloseWriter

setFlushOnWrite

setFieldNamesInFirstRow

setDescription

open

close

writeRecord