com.northconcepts.datapipeline.core

Class StreamWriter

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataWriter

com.northconcepts.datapipeline.core.StreamWriter

public class StreamWriter
extends DataWriter

Writes records to a stream in a human-readable format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamWriter.Format

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

DataEndpoint.State

Field Summary

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 and Description
StreamWriter(File file)
StreamWriter(OutputStream outputStream)
StreamWriter(Writer writer)

Method Summary

Modifier and Type	Method and Description
void	close() Indicates that this endpoint has finished reading or writing.
boolean	getCloseStream()
StreamWriter.Format	getFormat()
static StreamWriter	newJsonSystemOutWriter() Creates a new instance of StreamWriter writing JSON to System.out.
static StreamWriter	newSystemErrWriter() Creates a new instance of StreamWriter writing to System.err.
static StreamWriter	newSystemOutWriter() Creates a new instance of StreamWriter writing to System.out.
static StreamWriter	newSystemOutWriterWithSessionProperties() Creates a new instance of StreamWriter writing to System.out with all session properties.
static StreamWriter	newXmlSystemOutWriter() Creates a new instance of StreamWriter writing XML to System.out.
void	open() Makes this endpoint ready for reading or writing.
StreamWriter	setCloseStream(boolean closeStream) Specifies if the stream should be closed when this writer is closed (default is false).
StreamWriter	setFormat(StreamWriter.Format format)
protected void	writeImpl(Record record) Overridden by subclasses to write the specified record to this DataWriter.

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

addExceptionProperties, available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, write

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 Detail

StreamWriter

public StreamWriter(File file)
             throws DataException

Throws:

DataException

StreamWriter

public StreamWriter(Writer writer)

StreamWriter

public StreamWriter(OutputStream outputStream)

Method Detail

newSystemOutWriter

public static StreamWriter newSystemOutWriter()

Creates a new instance of StreamWriter writing to System.out.

newJsonSystemOutWriter

public static StreamWriter newJsonSystemOutWriter()

Creates a new instance of StreamWriter writing JSON to System.out.

newXmlSystemOutWriter

public static StreamWriter newXmlSystemOutWriter()

Creates a new instance of StreamWriter writing XML to System.out.

newSystemErrWriter

public static StreamWriter newSystemErrWriter()

Creates a new instance of StreamWriter writing to System.err.

newSystemOutWriterWithSessionProperties

public static StreamWriter newSystemOutWriterWithSessionProperties()

Creates a new instance of StreamWriter writing to System.out with all session properties.

getFormat

public StreamWriter.Format getFormat()

setFormat

public StreamWriter setFormat(StreamWriter.Format format)

getCloseStream

public boolean getCloseStream()

setCloseStream

public StreamWriter setCloseStream(boolean closeStream)

Specifies if the stream should be closed when this writer is closed (default is false).

Parameters:

closeStream -

Returns:

this writer

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class DataEndpoint

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

writeImpl

protected void writeImpl(Record record)
                  throws Throwable

Description copied from class: DataWriter

Overridden by subclasses to write the specified record to this DataWriter.

Specified by:

writeImpl in class DataWriter

Throws:

Throwable