com.northconcepts.datapipeline.foundations.pipeline.output

Class FixedWidthPipelineOutput

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.core.FoundationObject

com.northconcepts.datapipeline.foundations.pipeline.PipelineObject

com.northconcepts.datapipeline.foundations.pipeline.PipelineOutput

com.northconcepts.datapipeline.foundations.pipeline.output.FileSinkPipelineOutput

com.northconcepts.datapipeline.foundations.pipeline.output.FixedWidthPipelineOutput

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, DataWriterFactory, JavaCodeGenerator, Serializable

public class FixedWidthPipelineOutput
extends FileSinkPipelineOutput

See Also:

Serialized Form

Field Summary

Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

internalId, internalName, log, TIMESTAMP_FORMAT

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

SERIALIZED_CLASS_NAME, TYPE

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
FixedWidthPipelineOutput()

Method Summary

Modifier and Type	Method and Description
FixedWidthPipelineOutput	addField(FixedWidthField field)
FixedWidthPipelineOutput	addField(String name, int width)
FixedWidthPipelineOutput	addField(String name, int width, FixedWidthAlign align, Character fillChar)
FixedWidthPipelineOutput	addFields(int... width)
DataWriter	createDataWriter()
FixedWidthPipelineOutput	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
FixedWidthPipelineOutput	fromXmlElement(Element pipelineInputElement)
void	generateJavaCode(JavaCodeBuilder code)
void	generateSaveCode(JavaCodeBuilder javaCodeBuilder)
String	getCharset()
List<FixedWidthField>	getFields()
FileSink	getFileSink()
char	getFillChar()
String	getName()
String	getNewLine()
boolean	isAutoCloseWriter()
boolean	isFieldNamesInFirstRow()
boolean	isFlushOnWrite()
boolean	isTruncateFields()
FixedWidthPipelineOutput	setAutoCloseWriter(boolean autoCloseWriter)
FixedWidthPipelineOutput	setCharset(String charset)
FixedWidthPipelineOutput	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
FixedWidthPipelineOutput	setFields(List<FixedWidthField> fields)
FixedWidthPipelineOutput	setFileSink(FileSink fileSink)
FixedWidthPipelineOutput	setFillChar(char fillChar)
FixedWidthPipelineOutput	setFlushOnWrite(boolean flushOnWrite)
FixedWidthPipelineOutput	setNewLine(String newLine)
FixedWidthPipelineOutput	setTruncateFields(boolean truncateFields)
FixedWidthPipelineOutput	skipField(int width)
Record	toRecord()
Element	toXmlElement(Document document)

Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.PipelineOutput

getNestedPipelineOutput, getRootPipelineOutput

Methods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

addExceptionProperties, assertValid, assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalId

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties

Constructor Detail

FixedWidthPipelineOutput

public FixedWidthPipelineOutput()

Method Detail

getName

public String getName()

Overrides:

getName in class FileSinkPipelineOutput

getFileSink

public FileSink getFileSink()

Specified by:

getFileSink in class FileSinkPipelineOutput

setFileSink

public FixedWidthPipelineOutput setFileSink(FileSink fileSink)

Specified by:

setFileSink in class FileSinkPipelineOutput

getFields

public List<FixedWidthField> getFields()

setFields

public FixedWidthPipelineOutput setFields(List<FixedWidthField> fields)

addField

public FixedWidthPipelineOutput addField(FixedWidthField field)

addFields

public FixedWidthPipelineOutput addFields(int... width)

addField

public FixedWidthPipelineOutput addField(String name,
                                         int width)

addField

public FixedWidthPipelineOutput addField(String name,
                                         int width,
                                         FixedWidthAlign align,
                                         Character fillChar)

skipField

public FixedWidthPipelineOutput skipField(int width)

getFillChar

public char getFillChar()

setFillChar

public FixedWidthPipelineOutput setFillChar(char fillChar)

isTruncateFields

public boolean isTruncateFields()

setTruncateFields

public FixedWidthPipelineOutput setTruncateFields(boolean truncateFields)

getNewLine

public String getNewLine()

setNewLine

public FixedWidthPipelineOutput setNewLine(String newLine)

isAutoCloseWriter

public boolean isAutoCloseWriter()

setAutoCloseWriter

public FixedWidthPipelineOutput setAutoCloseWriter(boolean autoCloseWriter)

isFlushOnWrite

public boolean isFlushOnWrite()

setFlushOnWrite

public FixedWidthPipelineOutput setFlushOnWrite(boolean flushOnWrite)

isFieldNamesInFirstRow

public boolean isFieldNamesInFirstRow()

setFieldNamesInFirstRow

public FixedWidthPipelineOutput setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

createDataWriter

public DataWriter createDataWriter()

generateSaveCode

public void generateSaveCode(JavaCodeBuilder javaCodeBuilder)

Overrides:

generateSaveCode in class FileSinkPipelineOutput

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

getCharset

public String getCharset()

setCharset

public FixedWidthPipelineOutput setCharset(String charset)

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord

public FixedWidthPipelineOutput fromRecord(Record source)

Description copied from interface: RecordSerializable

Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

Specified by:

fromRecord in interface RecordSerializable

Overrides:

fromRecord in class PipelineOutput

Returns:

this instance.

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

Overrides:

toXmlElement in class PipelineOutput

fromXmlElement

public FixedWidthPipelineOutput fromXmlElement(Element pipelineInputElement)