com.northconcepts.datapipeline.json.JsonLinesWriter

public class JsonLinesWriter extends LinedTextWriter

Writes records in JSON Lines format: each record as a JSON object on its own line.

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

JsonLinesWriter(File file)

JsonLinesWriter(Writer writer)
Method Summary

Modifier and Type

Method

Description

protected void

assembleLine(Record record, StringBuilder lineBuffer)

Appends the record's output line, without a line terminator, to the empty buffer; also called for the header row (see AbstractWriter.isHeaderRow()).

JsonLinesWriter

setAutoCloseWriter(boolean autoCloseWriter)

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

JsonLinesWriter

setDescription(String description)

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

JsonLinesWriter

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().

JsonLinesWriter

setFlushOnWrite(boolean flushOnWrite)

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

Methods inherited from class com.northconcepts.datapipeline.core.LinedTextWriter
addExceptionProperties, getNewLine, setNewLine, writeRecord

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

Methods inherited from class com.northconcepts.datapipeline.core.AbstractWriter
createHeaderRecord, isHeaderRow, open, 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
- JsonLinesWriter
  
  public JsonLinesWriter(File file)
- JsonLinesWriter
  
  public JsonLinesWriter(Writer writer)
Method Details
- setAutoCloseWriter
  
  public JsonLinesWriter 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 JsonLinesWriter 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 JsonLinesWriter 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 JsonLinesWriter 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
- assembleLine
  
  protected void assembleLine(Record record, StringBuilder lineBuffer) throws Throwable
  
  Description copied from class: LinedTextWriter
  
  Appends the record's output line, without a line terminator, to the empty buffer; also called for the header row (see AbstractWriter.isHeaderRow()).
  
  Specified by:
  
  assembleLine in class LinedTextWriter
  
  Throws:
  
  Throwable

Class JsonLinesWriter

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

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

JsonLinesWriter

JsonLinesWriter

Method Details

setAutoCloseWriter

setFlushOnWrite

setFieldNamesInFirstRow

setDescription

assembleLine