Package com.univocity.parsers.common
Class AbstractWriter<S extends CommonWriterSettings<?>>
java.lang.Object
com.univocity.parsers.common.AbstractWriter<S>
- Type Parameters:
S
- The specific writer settings configuration class, which can potentially provide additional configuration options supported by the writer implementation.
- Direct Known Subclasses:
CsvWriter
,FixedWidthWriter
,TsvWriter
The AbstractWriter class provides a common ground for all writers in univocity-parsers.
It handles all settings defined by
CommonWriterSettings
, and delegates the writing algorithm implementation to its subclasses through the abstract
method processRow(Object[])
The following (absolutely required) attributes are exposed to subclasses:
- appender (
WriterCharAppender
): the character writer that appends characters from a given input into an internal buffer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final WriterCharAppender
private final boolean
protected final char
private NormalizedString[]
protected final String
private boolean
private final int
protected boolean
private Map<NormalizedString[],
Map<NormalizedString, Integer>> protected NormalizedString[]
protected boolean[]
protected boolean
protected boolean
private int[]
private final CommonSettings<DummyFormat>
private final boolean
private int
private final char[]
protected final String
private Object[]
private final Object[]
private int
protected long
private final WriterCharAppender
private final boolean
protected boolean
private boolean
protected final int
private Writer
private final RowWriterProcessor
protected boolean
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractWriter
(File file, String encoding, S settings) All writers must support, at the very least, the settings provided byCommonWriterSettings
.AbstractWriter
(File file, Charset encoding, S settings) All writers must support, at the very least, the settings provided byCommonWriterSettings
.AbstractWriter
(File file, S settings) All writers must support, at the very least, the settings provided byCommonWriterSettings
.AbstractWriter
(OutputStream output, String encoding, S settings) All writers must support, at the very least, the settings provided byCommonWriterSettings
.AbstractWriter
(OutputStream output, Charset encoding, S settings) All writers must support, at the very least, the settings provided byCommonWriterSettings
.AbstractWriter
(OutputStream output, S settings) All writers must support, at the very least, the settings provided byCommonWriterSettings
.AbstractWriter
(Writer writer, S settings) All writers must support, at the very least, the settings provided byCommonWriterSettings
.AbstractWriter
(S settings) All writers must support, at the very least, the settings provided byCommonWriterSettings
. -
Method Summary
Modifier and TypeMethodDescriptionfinal void
addStringValues
(Collection<String> values) Writes a sequence of Strings to a row in memory.final void
Writes a value to a row in memory.private final void
addValue
(NormalizedString[] headersInContext, NormalizedString headerName, boolean ignoreOnMismatch, Object value) final void
Writes a value to a row in memory.final void
Writes a value to a row in memory.final void
Writes a sequence of values to a row in memory.final void
addValues
(Collection<?> values) Writes a sequence of values to a row in memory.private Object[]
adjustRowLength
(Object[] row) protected final boolean
allowTrim
(int fieldIndex) Checks whether the writer can remove trailing/leading whitespaces from a value being written.protected final void
appendToRow
(char ch) Appends the given character to the output row.protected final void
appendToRow
(char[] chars) Appends the given character sequence to the output rowprotected final void
Appends the processed sequence of characters inappender
to the output row.final void
close()
Closes theWriter
given in this class constructor.final void
commentRow
(String comment) Writes a comment row to the output.final String
commentRowToString
(String comment) Writes a comment row to aString
final void
Discards the contents written to the internal in-memory row (usingor #writeValue()
.protected void
enableNewlineAfterRecord
(boolean enableNewlineAfterRecord) protected Object[]
private <T> void
fillOutputRow
(T[] row) Used when fields were selected and the input rows have a different order than the output.private void
final void
flush()
Flushes theWriter
given in this class constructor.private String
getContent
(CharSequence tmp) private Object[]
getContent
(Object[] tmp) private int
getFieldIndex
(NormalizedString[] headersInContext, NormalizedString headerName, boolean ignoreOnMismatch) Calculates the index of a header name in relation to the originalheaders
array defined in this writerfinal long
Returns the number of records written to the output so farprivate NormalizedString[]
protected String
getStringValue
(Object element) Converts a given object to its String representation for writing to aString
If the object is null, thennullValue
is returned. If the String representation of this object is an empty String, thenemptyValue
is returnedprotected abstract void
initialize
(S settings) Initializes the concrete implementation of this class with format-specific settings.private void
Writes the accumulated value of a record to the output, followed by a newline, and increases the record count.private String
Writes the accumulated value of a record to the output, followed by a newline, and increases the record count.final <K> void
processObjectRecords
(Map<K, String> headerMapping, Map<K, Object[]> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output .final <K> void
processObjectRecordsAndClose
(Map<K, Object[]> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output and closes the writer.final <K> void
processObjectRecordsAndClose
(Map<K, String> headerMapping, Map<K, Object[]> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output and closes the writer.processObjectRecordsToString
(Map<K, Object[]> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into aList
ofString
formatted to according to the specified output format.processObjectRecordsToString
(Map<K, String> headerMapping, Map<K, Object[]> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into aList
ofString
formatted to according to the specified output format.final void
processRecord
(Object record) Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it.final void
processRecord
(Object... record) Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it.final void
processRecord
(Map<?, ?> rowData) Processes the values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into a new output record ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.final <K> void
processRecord
(Map<K, String> headerMapping, Map<K, ?> rowData) Processes the values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into a new output record ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.final <T extends Record>
voidprocessRecord
(T record) final void
processRecords
(Iterable<?> records) Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them.final void
processRecords
(Object[] records) Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them.final <K,
I extends Iterable<?>>
voidprocessRecords
(Map<K, I> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output .final <K,
I extends Iterable<?>>
voidprocessRecords
(Map<K, String> headerMapping, Map<K, I> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output .final <T extends Record>
voidprocessRecords
(T[] records) Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them.final void
processRecordsAndClose
(Iterable<?> allRecords) Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them, then finally and closes the output ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.final void
processRecordsAndClose
(Object[] allRecords) Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them, then finally and closes the output ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.final <K,
I extends Iterable<?>>
voidprocessRecordsAndClose
(Map<K, I> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output and closes the writer.final <K,
I extends Iterable<?>>
voidprocessRecordsAndClose
(Map<K, String> headerMapping, Map<K, I> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output and closes the writer.processRecordsToString
(Iterable<?> records) Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them to aList
ofString
.processRecordsToString
(Object[] records) Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them them to aList
ofString
.processRecordsToString
(Map<K, I> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into aList
ofString
formatted to according to the specified output format.processRecordsToString
(Map<K, String> headerMapping, Map<K, I> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into aList
ofString
formatted to according to the specified output format.final String
processRecordToString
(Object record) Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it.final String
processRecordToString
(Object... record) Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it to aString
.final String
processRecordToString
(Map<?, ?> rowData) Processes the values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result intoString
formatted according to the specified output format.final <K> String
processRecordToString
(Map<K, String> headerMapping, Map<K, ?> rowData) Processes the values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result intoString
formatted according to the specified output format.processRecordToString
(T record) Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it to aString
.protected abstract void
processRow
(Object[] row) Format-specific implementation for writing a single record into the output.final void
Writes the contents accumulated in an internal in-memory row (usingor #addValue()
to a new record in the output.final String
Writes the contents accumulated in an internal in-memory row (usingor #addValue()
to aString
The objects added to this row will be processed with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
.private void
setHeadersFromMap
(Map<?, ?> map, boolean keys) Iterates over the keys of a map and builds an internal header row.protected static int
skipLeadingWhitespace
(int whitespaceRangeStart, String element) Identifies the starting character index of a value being written if leading whitespaces are to be discarded.private void
Submits a row for processing by the format-specific implementation.private TextWritingException
throwExceptionAndClose
(String message) In case of any exceptions, aTextWritingException
is thrown, and the outputWriter
is closed.private TextWritingException
throwExceptionAndClose
(String message, Object[] recordValues, Throwable cause) In case of any exceptions, aTextWritingException
is thrown, and the outputWriter
is closed.private TextWritingException
throwExceptionAndClose
(String message, String recordCharacters, Throwable cause) In case of any exceptions, aTextWritingException
is thrown, and the outputWriter
is closed.private TextWritingException
throwExceptionAndClose
(String message, Throwable cause) In case of any exceptions, aTextWritingException
is thrown, and the outputWriter
is closed.void
updateFieldExclusion
(Integer... fieldIndexesToExclude) Updates the selection of fields to exclude when writing.void
updateFieldExclusion
(String... fieldsToExclude) Updates the selection of fields to exclude when writing.void
updateFieldSelection
(Integer... newFieldSelectionByIndex) Updates the selection of fields to write.void
updateFieldSelection
(String... newFieldSelection) Updates the selection of fields to write.private void
updateIndexesToWrite
(CommonSettings<?> settings) Update indexes to write based on the field selection provided by the user.wrapObjectArray
(Map<K, Object[]> rowData) wrapRecordValues
(Map<K, ? extends Record> rowData) wrapStringArray
(Map<K, String[]> rowData) final void
Writes an empty line to the output, unless this is aFixedWidthWriter
whoseFixedWidthWriterSettings.getWriteLineSeparatorAfterRecord()
evaluates tofalse
.final void
Writes the headers defined inCommonSettings.getHeaders()
ATextWritingException
will be thrown if no headers were defined or if records were already written to the output.final void
writeHeaders
(String... headers) Writes the given collection of headers to the output.final void
writeHeaders
(Collection<?> headers) Writes the given collection of headers to the output.final String
Writes the headers defined inCommonSettings.getHeaders()
to aString
final String
writeHeadersToString
(String... headers) Writes the given collection of headers to aString
ATextWritingException
will be thrown if no headers were defined or if records were already written to aString
final String
writeHeadersToString
(Collection<?> headers) Writes the given collection of headers to aString
ATextWritingException
will be thrown if no headers were defined.final <K> void
writeObjectRows
(Map<K, String> headerMapping, Map<K, Object[]> rowData) Writes the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable.final <K> void
writeObjectRowsAndClose
(Map<K, Object[]> rowData) Writes the values of a given map to multiple output records and closes the output when finished.final <K> void
writeObjectRowsAndClose
(Map<K, String> headerMapping, Map<K, Object[]> rowData) Writes the values of a given map to multiple output records and closes the output when finished.writeObjectRowsToString
(Map<K, String> headerMapping, Map<K, Object[]> rowData) Writes the values of a given map to aList
ofString
formatted to according to the specified output format.final <T extends Record>
voidwriteRecord
(T row) Writes the data given for an individual record.final void
writeRecords
(Collection<? extends Record> rows) Iterates over all records and writes them to the output.final <K> void
writeRecords
(Map<K, String> headerMapping, Map<K, ? extends Record> rowData) Writes the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable.final void
writeRecordsAndClose
(Collection<? extends Record> allRows) Iterates over all records, writes them and closes the output.final <K> void
writeRecordsAndClose
(Map<K, ? extends Record> rowData) Writes the values of a given map to multiple output records and closes the output when finished.final <K> void
writeRecordsAndClose
(Map<K, String> headerMapping, Map<K, ? extends Record> rowData) Writes the values of a given map to multiple output records and closes the output when finished.writeRecordsToString
(Collection<? extends Record> rows) Iterates over all records and writes them to aList
ofString
.writeRecordsToString
(Map<K, String> headerMapping, Map<K, ? extends Record> rowData) Writes the values of a given map to aList
ofString
formatted to according to the specified output format.writeRecordToString
(T row) Writes the data given for an individual record to aString
.final void
Writes the data given for an individual record.final void
Writes a plain (potentially free-text) String as a line to the output.final void
Writes the data given for an individual record.final void
writeRow
(Collection<?> row) Writes the data given for an individual record.final void
Writes the values of a given map into new output record Note this method will not use theRowWriterProcessor
.final <K> void
Writes the values of a given map into new output record Note this method will not use theRowWriterProcessor
.final <C extends Collection<?>>
voidIterates over all records and writes them to the output.final void
Iterates over all records and writes them to the output.final void
writeRows
(Collection<Object[]> rows) Iterates over all records and writes them to the output.final <K,
I extends Iterable<?>>
voidWrites the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable.final <K,
I extends Iterable<?>>
voidWrites the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable.private <K,
I extends Iterable<?>>
voidwriteRows
(Map<K, String> headerMapping, Map<K, I> rowData, List<String> outputList, boolean useRowProcessor) Writes the values of a given map to aList
ofString
formatted to according to the specified output format.final <C extends Collection<?>>
voidwriteRowsAndClose
(Iterable<C> allRows) Iterates over all records, writes them and closes the output.final void
writeRowsAndClose
(Object[][] allRows) Iterates over all records, writes them and closes the output.final void
writeRowsAndClose
(Collection<Object[]> allRows) Iterates over all records, writes them and closes the output.final <K,
I extends Iterable<?>>
voidwriteRowsAndClose
(Map<K, I> rowData) Writes the values of a given map to multiple output records and closes the output when finished.final <K,
I extends Iterable<?>>
voidwriteRowsAndClose
(Map<K, String> headerMapping, Map<K, I> rowData) Writes the values of a given map to multiple output records and closes the output when finished.final <C extends Collection<?>>
List<String>writeRowsToString
(Iterable<C> rows) Iterates over all records and writes them to aList
ofString
.writeRowsToString
(Object[][] rows) Iterates over all records and writes them to aList
ofString
.writeRowsToString
(Collection<Object[]> rows) Iterates over all records and writes them to aList
ofString
.writeRowsToString
(Map<K, I> rowData) Writes the values of a given map to aList
ofString
formatted to according to the specified output format.writeRowsToString
(Map<K, String> headerMapping, Map<K, I> rowData) Writes the values of a given map to aList
ofString
formatted to according to the specified output format.final String
writeRowToString
(Object... row) Writes the data given for an individual record to aString
.final String
writeRowToString
(String[] row) Writes the data given for an individual record to aString
.final String
writeRowToString
(Collection<?> row) Writes the data given for an individual record to aString
.final String
writeRowToString
(Map<?, ?> rowData) Writes the values of a given map to aString
formatted to according to the specified output format.final <K> String
writeRowToString
(Map<K, String> headerMapping, Map<K, ?> rowData) Writes the values of a given map to aString
formatted to according to the specified output format.final <C extends Collection<?>>
voidwriteStringRows
(Iterable<C> rows) Iterates over all records and writes them to the output.final void
writeStringRows
(Collection<String[]> rows) Iterates over all records and writes them to the output.final <K> void
writeStringRows
(Map<K, String> headerMapping, Map<K, String[]> rowData) Writes the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable.final void
writeStringRowsAndClose
(Collection<String[]> allRows) Iterates over all records, writes them and closes the output.final <K> void
writeStringRowsAndClose
(Map<K, String[]> rowData) Writes the values of a given map to multiple output records and closes the output when finished.final <K> void
writeStringRowsAndClose
(Map<K, String> headerMapping, Map<K, String[]> rowData) Writes the values of a given map to multiple output records and closes the output when finished.final <C extends Collection<?>>
List<String>writeStringRowsToString
(Iterable<C> rows) Iterates over all records and writes them to aList
ofString
.writeStringRowsToString
(Collection<String[]> rows) Iterates over all records and writes them to aList
ofString
.writeStringRowsToString
(Map<K, String> headerMapping, Map<K, String[]> rowData) Writes the values of a given map to aList
ofString
formatted to according to the specified output format.private <K> void
writeValuesFromMap
(Map<K, String> headerMapping, Map<K, ?> rowData) Writes values from an implementation ofMap
to a partial output record, ready to be written to the output.final void
Writes the contents accumulated in an internal in-memory row (usingor #writeValue()
to a new record in the output.final String
Writes the contents accumulated in an internal in-memory row (usingor #addValue()
as aString
-
Field Details
-
writerProcessor
-
writer
-
skipEmptyLines
private final boolean skipEmptyLines -
comment
protected final char comment -
rowAppender
-
isHeaderWritingEnabled
private final boolean isHeaderWritingEnabled -
outputRow
-
indexesToWrite
private int[] indexesToWrite -
lineSeparator
private final char[] lineSeparator -
headers
-
recordCount
protected long recordCount -
nullValue
-
emptyValue
-
appender
-
partialLine
-
partialLineIndex
private int partialLineIndex -
headerIndexes
-
largestRowLength
private int largestRowLength -
writingHeaders
protected boolean writingHeaders -
headerTrimFlags
protected boolean[] headerTrimFlags -
dummyHeaderRow
-
expandRows
protected boolean expandRows -
usingSwitch
private boolean usingSwitch -
enableNewlineAfterRecord
private boolean enableNewlineAfterRecord -
usingNullOrEmptyValue
protected boolean usingNullOrEmptyValue -
whitespaceRangeStart
protected final int whitespaceRangeStart -
columnReorderingEnabled
private final boolean columnReorderingEnabled -
ignoreLeading
protected boolean ignoreLeading -
ignoreTrailing
protected boolean ignoreTrailing -
internalSettings
-
errorContentLength
private final int errorContentLength
-
-
Constructor Details
-
AbstractWriter
All writers must support, at the very least, the settings provided byCommonWriterSettings
. The AbstractWriter requires its configuration to be properly initialized. Important: by not providing an instance ofWriter
to this constructor, only the operations that write to Strings are available.- Parameters:
settings
- the writer configuration
-
AbstractWriter
All writers must support, at the very least, the settings provided byCommonWriterSettings
. The AbstractWriter requires its configuration to be properly initialized.- Parameters:
file
- the output file that will be written with the format-specific records as defined by subclasses ofAbstractWriter
.settings
- the writer configuration
-
AbstractWriter
All writers must support, at the very least, the settings provided byCommonWriterSettings
. The AbstractWriter requires its configuration to be properly initialized.- Parameters:
file
- the output file that will be written with the format-specific records as defined by subclasses ofAbstractWriter
.encoding
- the encoding of the filesettings
- the writer configuration
-
AbstractWriter
All writers must support, at the very least, the settings provided byCommonWriterSettings
. The AbstractWriter requires its configuration to be properly initialized.- Parameters:
file
- the output file that will be written with the format-specific records as defined by subclasses ofAbstractWriter
.encoding
- the encoding of the filesettings
- the writer configuration
-
AbstractWriter
All writers must support, at the very least, the settings provided byCommonWriterSettings
. The AbstractWriter requires its configuration to be properly initialized.- Parameters:
output
- the output stream that will be written with the format-specific records as defined by subclasses ofAbstractWriter
.settings
- the writer configuration
-
AbstractWriter
All writers must support, at the very least, the settings provided byCommonWriterSettings
. The AbstractWriter requires its configuration to be properly initialized.- Parameters:
output
- the output stream that will be written with the format-specific records as defined by subclasses ofAbstractWriter
.encoding
- the encoding of the streamsettings
- the writer configuration
-
AbstractWriter
All writers must support, at the very least, the settings provided byCommonWriterSettings
. The AbstractWriter requires its configuration to be properly initialized.- Parameters:
output
- the output stream that will be written with the format-specific records as defined by subclasses ofAbstractWriter
.encoding
- the encoding of the streamsettings
- the writer configuration
-
AbstractWriter
All writers must support, at the very least, the settings provided byCommonWriterSettings
. The AbstractWriter requires its configuration to be properly initialized.- Parameters:
writer
- the output resource that will receive the format-specific records as defined by subclasses ofAbstractWriter
.settings
- the writer configuration
-
-
Method Details
-
enableNewlineAfterRecord
protected void enableNewlineAfterRecord(boolean enableNewlineAfterRecord) -
initialize
Initializes the concrete implementation of this class with format-specific settings.- Parameters:
settings
- the settings object specific to the format being written.
-
updateIndexesToWrite
Update indexes to write based on the field selection provided by the user. -
updateFieldSelection
Updates the selection of fields to write. This is useful if the input rows change during the writing process and their values need be allocated to specific columns.- Parameters:
newFieldSelection
- the new selection of fields to write.
-
updateFieldSelection
Updates the selection of fields to write. This is useful if the input rows change during the writing process and their values need be allocated to specific columns.- Parameters:
newFieldSelectionByIndex
- the new selection of fields to write.
-
updateFieldExclusion
Updates the selection of fields to exclude when writing. This is useful if the input rows change during the writing process and their values need be allocated to specific columns.- Parameters:
fieldsToExclude
- the selection of fields to exclude from the output.
-
updateFieldExclusion
Updates the selection of fields to exclude when writing. This is useful if the input rows change during the writing process and their values need be allocated to specific columns.- Parameters:
fieldIndexesToExclude
- the selection of fields to exclude from the output.
-
submitRow
Submits a row for processing by the format-specific implementation.- Parameters:
row
- the data to be written for a single record in the output.
-
processRow
Format-specific implementation for writing a single record into the output. The AbstractWriter handles the initialization and processing of the output until it is ready to be written (generally, reorganizing it and passing it on to aRowWriterProcessor
). It then delegates the record to the writer-specific implementation defined byprocessRow(Object[])
. In general, an implementation ofprocessRow(Object[])
will perform the following steps:- Iterate over each object in the given input and convert it to the expected String representation.
- The conversion must happen using the provided
appender
object. The an individual value is processed, theappendValueToRow()
method must be called. This will clear the accumulated value inappender
and add it to the output row. - Format specific separators and other characters must be introduced to the output row using
appendToRow(char)
processRow(Object[])
method returns, a row will be written to the output with the processed information, and a newline will be automatically written after the given contents, unless this is aFixedWidthWriter
whoseFixedWidthWriterSettings.getWriteLineSeparatorAfterRecord()
evaluates tofalse
. The newline character sequence will conform to what is specified inFormat.getLineSeparator()
This cycle repeats until the writing process is stopped by the user or an error happens. In case of errors, the unchecked exceptionTextWritingException
will be thrown and all resources in use will be closed automatically. The exception should contain the cause and more information about the output state when the error happened.- Parameters:
row
- the data to be written to the output in the expected format.- See Also:
-
appendValueToRow
protected final void appendValueToRow()Appends the processed sequence of characters inappender
to the output row. -
appendToRow
protected final void appendToRow(char ch) Appends the given character to the output row.- Parameters:
ch
- the character to append to the output row
-
appendToRow
protected final void appendToRow(char[] chars) Appends the given character sequence to the output row- Parameters:
chars
- the sequence of characters to append to the output row
-
writeHeaders
public final void writeHeaders()Writes the headers defined inCommonSettings.getHeaders()
ATextWritingException
will be thrown if no headers were defined or if records were already written to the output. -
writeHeaders
Writes the given collection of headers to the output. ATextWritingException
will be thrown if no headers were defined or if records were already written to the output.- Parameters:
headers
- the headers to write to the output.
-
writeHeaders
Writes the given collection of headers to the output. ATextWritingException
will be thrown if no headers were defined or if records were already written to the output.- Parameters:
headers
- the headers to write to the output.
-
processRecordsAndClose
Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them, then finally and closes the output ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
allRecords
- the records to be transformed by aRowWriterProcessor
and then written to the output
-
processRecordsAndClose
Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them, then finally and closes the output ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
allRecords
- the records to be transformed by aRowWriterProcessor
and then written to the output
-
processRecords
Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them. The output will remain open for further writing. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
records
- the records to be transformed by aRowWriterProcessor
and then written to the output
-
processRecords
Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them. The output will remain open for further writing. * ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
records
- the records to transformed by aRowWriterProcessor
and then written to the output
-
processRecords
Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them. The output will remain open for further writing. * ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
T
- the concrete Record type- Parameters:
records
- the records to transformed by aRowWriterProcessor
and then written to the output
-
processRecord
Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it. The output will remain open for further writing. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
record
- the information of a single record to be transformed by aRowWriterProcessor
and then written to the output
-
processRecord
-
processRecord
Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it. The output will remain open for further writing. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
record
- the information of a single record to be transformed by aRowWriterProcessor
and then written to the output
-
getRowProcessorHeaders
-
writeRowsAndClose
Iterates over all records, writes them and closes the output. Note this method will not use theRowWriterProcessor
. UseprocessRecordsAndClose(Iterable)
for that.- Type Parameters:
C
- Collection of objects containing values of a row- Parameters:
allRows
- the rows to be written to the output
-
writeRowsAndClose
Iterates over all records, writes them and closes the output. Note this method will not use theRowWriterProcessor
. UseprocessRecordsAndClose(Object[])
for that.- Parameters:
allRows
- the rows to be written to the output
-
writeStringRowsAndClose
Iterates over all records, writes them and closes the output. Note this method will not use theRowWriterProcessor
. UseprocessRecordsAndClose(Iterable)
for that.- Parameters:
allRows
- the rows to be written to the output
-
writeRecordsAndClose
Iterates over all records, writes them and closes the output. Note this method will not use theRowWriterProcessor
. UseprocessRecordsAndClose(Iterable)
for that.- Parameters:
allRows
- the rows to be written to the output
-
writeRowsAndClose
Iterates over all records, writes them and closes the output. Note this method will not use theRowWriterProcessor
. UseprocessRecordsAndClose(Object[])
for that.- Parameters:
allRows
- the rows to be written to the output
-
writeRows
Iterates over all records and writes them to the output. The output will remain open for further writing. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Object[])
for that.- Parameters:
rows
- the rows to be written to the output
-
writeRows
Iterates over all records and writes them to the output. The output will remain open for further writing. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Type Parameters:
C
- Collection of objects containing values of a row- Parameters:
rows
- the rows to be written to the output
-
writeStringRows
Iterates over all records and writes them to the output. The output will remain open for further writing. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Parameters:
rows
- the rows to be written to the output
-
writeRecords
Iterates over all records and writes them to the output. The output will remain open for further writing. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Parameters:
rows
- the rows to be written to the output
-
writeStringRows
Iterates over all records and writes them to the output. The output will remain open for further writing. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Type Parameters:
C
- Collection of objects containing values of a row- Parameters:
rows
- the rows to be written to the output
-
writeRows
Iterates over all records and writes them to the output. The output will remain open for further writing. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Parameters:
rows
- the rows to be written to the output
-
writeRow
Writes the data given for an individual record. The output will remain open for further writing. Note this method will not use theRowWriterProcessor
. UseprocessRecord(Object)
for that.- Parameters:
row
- the information of a single record to be written to the output
-
writeRow
Writes the data given for an individual record. The output will remain open for further writing. If the given data is null or empty, andCommonSettings.getSkipEmptyLines()
is true, the input will be just ignored. IfCommonSettings.getSkipEmptyLines()
is false, then an empty row will be written to the output (as specified bywriteEmptyRow()
). In case of any errors, aTextWritingException
will be thrown and theWriter
given in the constructor will be closed. Note this method will not use theRowWriterProcessor
. UseprocessRecord(Object)
for that.- Parameters:
row
- the information of a single record to be written to the output
-
writeRecord
Writes the data given for an individual record. The output will remain open for further writing. If the given data is null or empty, andCommonSettings.getSkipEmptyLines()
is true, the input will be just ignored. IfCommonSettings.getSkipEmptyLines()
is false, then an empty row will be written to the output (as specified bywriteEmptyRow()
). In case of any errors, aTextWritingException
will be thrown and theWriter
given in the constructor will be closed. Note this method will not use theRowWriterProcessor
. UseprocessRecord(Object)
for that.- Type Parameters:
T
- the concrete Record type- Parameters:
row
- the information of a single record to be written to the output
-
writeRow
Writes the data given for an individual record. The output will remain open for further writing. If the given data is null or empty, andCommonSettings.getSkipEmptyLines()
is true, the input will be just ignored. IfCommonSettings.getSkipEmptyLines()
is false, then an empty row will be written to the output (as specified bywriteEmptyRow()
). In case of any errors, aTextWritingException
will be thrown and theWriter
given in the constructor will be closed. Note this method will not use theRowWriterProcessor
. UseprocessRecord(Object)
for that.- Parameters:
row
- the information of a single record to be written to the output
-
expand
-
writeRow
Writes a plain (potentially free-text) String as a line to the output. A newline will automatically written after the given contents, unless this is aFixedWidthWriter
whoseFixedWidthWriterSettings.getWriteLineSeparatorAfterRecord()
evaluates tofalse
. The newline character sequence will conform to what is specified inFormat.getLineSeparator()
The writer implementation has no control over the format of this content. The output will remain open for further writing.- Parameters:
row
- the line to be written to the output
-
writeEmptyRow
public final void writeEmptyRow()Writes an empty line to the output, unless this is aFixedWidthWriter
whoseFixedWidthWriterSettings.getWriteLineSeparatorAfterRecord()
evaluates tofalse
. The newline character sequence will conform to what is specified inFormat.getLineSeparator()
The output will remain open for further writing. -
commentRow
Writes a comment row to the output. A newline will automatically written after the given contents, unless this is aFixedWidthWriter
whoseFixedWidthWriterSettings.getWriteLineSeparatorAfterRecord()
evaluates tofalse
. The newline character sequence will conform to what is specified inFormat.getLineSeparator()
The output will remain open for further writing.- Parameters:
comment
- the contents to be written as a comment to the output
-
fillOutputRow
private <T> void fillOutputRow(T[] row) Used when fields were selected and the input rows have a different order than the output. This method fills the internal #outputRow array with the values provided by the user in the correct order.- Parameters:
row
- user-provided data which has to be rearranged to the expected record sequence before writing to the output.
-
internalWriteRow
private void internalWriteRow()Writes the accumulated value of a record to the output, followed by a newline, and increases the record count. The newline character sequence will conform to what is specified inFormat.getLineSeparator()
The contents ofrowAppender
depend on the concrete implementation ofprocessRow(Object[])
-
skipLeadingWhitespace
Identifies the starting character index of a value being written if leading whitespaces are to be discarded. Implementation note whitespaces are considered all characters wherech <= ' '
evaluates totrue
- Parameters:
whitespaceRangeStart
- starting range after which characters will be considered whitespaceelement
- the String to be scanned for leading whitespaces.- Returns:
- the index of the first non-whitespace character in the given element.
-
flush
public final void flush()Flushes theWriter
given in this class constructor. An IllegalStateException will be thrown in case of any errors, and the writer will be closed. -
close
public final void close()Closes theWriter
given in this class constructor. An IllegalStateException will be thrown in case of any errors. -
throwExceptionAndClose
In case of any exceptions, aTextWritingException
is thrown, and the outputWriter
is closed.- Parameters:
message
- Description of the error
-
throwExceptionAndClose
In case of any exceptions, aTextWritingException
is thrown, and the outputWriter
is closed.- Parameters:
message
- Description of the errorcause
- the exception to be wrapped by aTextWritingException
-
throwExceptionAndClose
private TextWritingException throwExceptionAndClose(String message, String recordCharacters, Throwable cause) In case of any exceptions, aTextWritingException
is thrown, and the outputWriter
is closed.- Parameters:
message
- Description of the errorrecordCharacters
- characters used to write to the output at the time the exception happenedcause
- the exception to be wrapped by aTextWritingException
-
throwExceptionAndClose
private TextWritingException throwExceptionAndClose(String message, Object[] recordValues, Throwable cause) In case of any exceptions, aTextWritingException
is thrown, and the outputWriter
is closed.- Parameters:
message
- Description of the errorrecordValues
- values used to write to the output at the time the exception happenedcause
- the exception to be wrapped by aTextWritingException
-
getStringValue
Converts a given object to its String representation for writing to aString
- If the object is null, then
nullValue
is returned. - If the String representation of this object is an empty String, then
emptyValue
is returned
- Parameters:
element
- the object to be converted into a String.- Returns:
- the String representation of the given object
- If the object is null, then
-
addValues
Writes a sequence of values to a row in memory. Subsequent calls to this method will add the given values in a new column of the same row, untilwriteValuesToRow()
is called to flush all values accumulated and effectively write a new record to the output- Parameters:
values
- the values to be written
-
addStringValues
Writes a sequence of Strings to a row in memory. Subsequent calls to this method will add the given values in a new column of the same row, untilwriteValuesToRow()
is called to flush all values accumulated and effectively write a new record to the output- Parameters:
values
- the values to be written
-
addValues
Writes a sequence of values to a row in memory. Subsequent calls to this method will add the given values in a new column of the same row, untilwriteValuesToRow()
is called to flush all values accumulated and effectively write a new record to the output- Parameters:
values
- the values to be written
-
addValue
Writes a value to a row in memory. Subsequent calls to this method will add the given values in a new column of the same row, untilwriteValuesToRow()
is called to flush all values accumulated and effectively write a new record to the output- Parameters:
value
- the value to be written
-
fillPartialLineToMatchHeaders
private void fillPartialLineToMatchHeaders() -
writeValuesToRow
public final void writeValuesToRow()Writes the contents accumulated in an internal in-memory row (usingor #writeValue()
to a new record in the output. -
addValue
Writes a value to a row in memory. Subsequent calls to this method will add the given values in a new column of the same row, untilwriteValuesToRow()
is called to flush all values accumulated and effectively write a new record to the output- Parameters:
index
- the position in the row that should receive the value.value
- the value to be written
-
addValue
Writes a value to a row in memory. Subsequent calls to this method will add the given values in a new column of the same row, untilwriteValuesToRow()
is called to flush all values accumulated and effectively write a new record to the output- Parameters:
headerName
- the name of the column of the new row that should receive the value.value
- the value to be written
-
addValue
private final void addValue(NormalizedString[] headersInContext, NormalizedString headerName, boolean ignoreOnMismatch, Object value) -
getFieldIndex
private int getFieldIndex(NormalizedString[] headersInContext, NormalizedString headerName, boolean ignoreOnMismatch) Calculates the index of a header name in relation to the originalheaders
array defined in this writer- Parameters:
headersInContext
- headers currently in use (they might change).headerName
- the name of the header whose position will be identifiedignoreOnMismatch
- flag indicating that if the header is not found, no exception is to be thrown, and -1 should be returned instead.- Returns:
- the position of the given header, or -1 if it's not found when ignoreOnMismatch is set to
true
-
discardValues
public final void discardValues()Discards the contents written to the internal in-memory row (usingor #writeValue()
. -
writeHeadersToString
Writes the headers defined inCommonSettings.getHeaders()
to aString
- Returns:
- a formatted
String
containing the headers defined inCommonSettings.getHeaders()
-
writeHeadersToString
Writes the given collection of headers to aString
ATextWritingException
will be thrown if no headers were defined.- Parameters:
headers
- the headers to write to aString
- Returns:
- a formatted
String
containing the given headers
-
writeHeadersToString
Writes the given collection of headers to aString
ATextWritingException
will be thrown if no headers were defined or if records were already written to aString
- Parameters:
headers
- the headers to write to aString
- Returns:
- a formatted
String
containing the given headers
-
processRecordsToString
Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them to aList
ofString
. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
records
- the records to be transformed by aRowWriterProcessor
and then written to aList
ofString
.- Returns:
- a
List
containing the information transformed from the given records as formattedString
s
-
processRecordsToString
Iterates over all records, processes each one with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, and writes them them to aList
ofString
. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
records
- the records to transformed by aRowWriterProcessor
and then written aString
.- Returns:
- a
List
containing the information transformed from the given records as formattedString
s
-
processRecordToString
Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it to aString
. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
record
- the information of a single record to be transformed by aRowWriterProcessor
and then written to aString
.- Returns:
- a formatted
String
containing the information transformed from the given record
-
processRecordToString
Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it to aString
. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
T
- the concrete Record type- Parameters:
record
- the information of a single record to be transformed by aRowWriterProcessor
and then written to aString
.- Returns:
- a formatted
String
containing the information transformed from the given record
-
processRecordToString
Processes the data given for an individual record with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes it. The output will remain open for further writing. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
record
- the information of a single record to be transformed by aRowWriterProcessor
and then written to aString
.- Returns:
- a formatted
String
containing the information transformed from the given record
-
writeRowsToString
Iterates over all records and writes them to aList
ofString
. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Object[])
for that.- Parameters:
rows
- the rows to be written to aList
ofString
.- Returns:
- a
List
containing the given rows as formattedString
s
-
writeRowsToString
Iterates over all records and writes them to aList
ofString
. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Type Parameters:
C
- Collection of objects containing values of a row- Parameters:
rows
- the rows to be written to aList
ofString
.- Returns:
- a
List
containing the given rows as formattedString
s
-
writeStringRowsToString
Iterates over all records and writes them to aList
ofString
. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Type Parameters:
C
- Collection of objects containing values of a row- Parameters:
rows
- the rows to be written to aList
ofString
.- Returns:
- a
List
containing the given rows as formattedString
s
-
writeRowsToString
Iterates over all records and writes them to aList
ofString
. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Parameters:
rows
- the rows to be written to aList
ofString
.- Returns:
- a
List
containing the given rows as formattedString
s
-
writeStringRowsToString
Iterates over all records and writes them to aList
ofString
. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Parameters:
rows
- the rows to be written to aList
ofString
.- Returns:
- a
List
containing the given rows as formattedString
s
-
writeRecordsToString
Iterates over all records and writes them to aList
ofString
. Note this method will not use theRowWriterProcessor
. UseprocessRecords(Iterable)
for that.- Parameters:
rows
- the rows to be written to aList
ofString
.- Returns:
- a
List
containing the given rows as formattedString
s
-
writeRowToString
Writes the data given for an individual record to aString
. Note this method will not use theRowWriterProcessor
. UseprocessRecord(Object)
for that.- Parameters:
row
- the information of a single record to be written to aString
- Returns:
- a formatted
String
containing the information of the given record
-
writeRowToString
Writes the data given for an individual record to aString
. If the given data is null or empty, andCommonSettings.getSkipEmptyLines()
is true,null
will be returned In case of any errors, aTextWritingException
will be thrown. Note this method will not use theRowWriterProcessor
. UseprocessRecord(Object)
for that.- Parameters:
row
- the information of a single record to be written to aString
.- Returns:
- a formatted
String
containing the information of the given record
-
writeRecordToString
Writes the data given for an individual record to aString
. If the given data is null or empty, andCommonSettings.getSkipEmptyLines()
is true,null
will be returned In case of any errors, aTextWritingException
will be thrown. Note this method will not use theRowWriterProcessor
. UseprocessRecord(Object)
for that.- Parameters:
row
- the information of a single record to be written to aString
.- Returns:
- a formatted
String
containing the information of the given record
-
writeRowToString
Writes the data given for an individual record to aString
. If the given data is null or empty, andCommonSettings.getSkipEmptyLines()
is true,null
will be returned In case of any errors, aTextWritingException
will be thrown. Note this method will not use theRowWriterProcessor
. UseprocessRecord(Object)
for that.- Parameters:
row
- the information of a single record to be written to aString
.- Returns:
- a formatted
String
containing the information of the given record
-
adjustRowLength
-
commentRowToString
Writes a comment row to aString
- Parameters:
comment
- the contents to be written as a comment to aString
.- Returns:
- a formatted
String
containing the comment.
-
internalWriteRowToString
Writes the accumulated value of a record to the output, followed by a newline, and increases the record count. The newline character sequence will conform to what is specified inFormat.getLineSeparator()
The contents ofrowAppender
depend on the concrete implementation ofprocessRow(Object[])
- Returns:
- a formatted
String
containing the comment.
-
writeValuesToString
Writes the contents accumulated in an internal in-memory row (usingor #addValue()
as aString
- Returns:
- a formatted
String
containing the information accumulated in the internal in-memory row.
-
processValuesToRow
public final void processValuesToRow()Writes the contents accumulated in an internal in-memory row (usingor #addValue()
to a new record in the output. The objects added to this row will be processed with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
. The output will remain open for further writing. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
. -
processValuesToString
Writes the contents accumulated in an internal in-memory row (usingor #addValue()
to aString
The objects added to this row will be processed with theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
. The output will remain open for further writing. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Returns:
- a formatted
String
containing the result produced by theRowWriterProcessor
using the values accumulated in internal in-memory row.
-
getRecordCount
public final long getRecordCount()Returns the number of records written to the output so far- Returns:
- the number of records written to the output so far
-
writeValuesFromMap
Writes values from an implementation ofMap
to a partial output record, ready to be written to the output. Values will be stored under a column identified by the headers. If no headers are defined, the keys of the map will be used to initialize an internal header row. A map of headers can be optionally provided to assign a name to the keys of the input map. This is useful when the input map has keys will generate unwanted header names.- Type Parameters:
K
- type of the key in both rowData and headerMapping maps.- Parameters:
headerMapping
- an optional map associating keys of the rowData map with expected header namesrowData
- the data to be written. Its keys will be used to form a header row in case no headers are available.
-
setHeadersFromMap
Iterates over the keys of a map and builds an internal header row.- Parameters:
map
- the input map whose keys will be used to generate headers for the output.keys
- indicates whether to take the map keys or values to build the header rows.
-
writeRowToString
Writes the values of a given map to aString
formatted to according to the specified output format. Note this method will not use theRowWriterProcessor
.- Parameters:
rowData
- the map whose values will be used to generate aString
.- Returns:
- a
String
containing the given data as a formattedString
-
writeRow
Writes the values of a given map into new output record Note this method will not use theRowWriterProcessor
.- Parameters:
rowData
- the map whose values will be used to generate a new record
-
writeRowToString
Writes the values of a given map to aString
formatted to according to the specified output format. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aString
.- Returns:
- a
String
containing the given data as a formattedString
-
writeRow
Writes the values of a given map into new output record Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a new record
-
writeRowsToString
Writes the values of a given map to aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
List
of formattedString
, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
writeRows
Writes the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
rowData
- the map whose values will be used to generate a number of output records
-
writeRowsToString
public final <K,I extends Iterable<?>> List<String> writeRowsToString(Map<K, String> headerMapping, Map<K, I> rowData) Writes the values of a given map to aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
List
of formattedString
, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
writeRows
public final <K,I extends Iterable<?>> void writeRows(Map<K, String> headerMapping, Map<K, I> rowData) Writes the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
writeRows
private <K,I extends Iterable<?>> void writeRows(Map<K, String> headerMapping, Map<K, I> rowData, List<String> outputList, boolean useRowProcessor) Writes the values of a given map to aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aList
ofString
.outputList
- an outputList
to fill with formattedString
s, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
writeStringRowsToString
public final <K> List<String> writeStringRowsToString(Map<K, String> headerMapping, Map<K, String[]> rowData) Writes the values of a given map to aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
List
of formattedString
, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
writeRecordsToString
public final <K> List<String> writeRecordsToString(Map<K, String> headerMapping, Map<K, ? extends Record> rowData) Writes the values of a given map to aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
List
of formattedString
, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
writeStringRows
Writes the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
writeRecords
Writes the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
writeObjectRowsToString
public final <K> List<String> writeObjectRowsToString(Map<K, String> headerMapping, Map<K, Object[]> rowData) Writes the values of a given map to aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
List
of formattedString
, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
writeObjectRows
Writes the values of a given map to multiple output records Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
wrapObjectArray
-
wrapStringArray
-
wrapRecordValues
-
writeObjectRowsAndClose
Writes the values of a given map to multiple output records and closes the output when finished. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
writeStringRowsAndClose
Writes the values of a given map to multiple output records and closes the output when finished. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
writeRecordsAndClose
public final <K> void writeRecordsAndClose(Map<K, String> headerMapping, Map<K, ? extends Record> rowData) Writes the values of a given map to multiple output records and closes the output when finished. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
writeObjectRowsAndClose
Writes the values of a given map to multiple output records and closes the output when finished. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
rowData
- the map whose values will be used to generate a number of output records
-
writeStringRowsAndClose
Writes the values of a given map to multiple output records and closes the output when finished. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
rowData
- the map whose values will be used to generate a number of output records
-
writeRecordsAndClose
Writes the values of a given map to multiple output records and closes the output when finished. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key type- Parameters:
rowData
- the map whose values will be used to generate a number of output records
-
writeRowsAndClose
public final <K,I extends Iterable<?>> void writeRowsAndClose(Map<K, String> headerMapping, Map<K, I> rowData) Writes the values of a given map to multiple output records and closes the output when finished. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
writeRowsAndClose
Writes the values of a given map to multiple output records and closes the output when finished. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. Note this method will not use theRowWriterProcessor
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
rowData
- the map whose values will be used to generate a number of output records
-
processRecordToString
Processes the values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result intoString
formatted according to the specified output format. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
String
containing the given data as a formattedString
-
processRecord
Processes the values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into a new output record ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Parameters:
rowData
- the map whose values will be used to generate aList
ofString
.
-
processRecordToString
Processes the values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result intoString
formatted according to the specified output format. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
String
containing the given data as a formattedString
-
processRecord
Processes the values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into a new output record ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aList
ofString
.
-
processRecordsToString
Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
List
of formattedString
, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
processRecords
Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output . The output will remain open for further write operations. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
rowData
- the map whose values will be used to generate a number of output records
-
processRecordsToString
public final <K,I extends Iterable<?>> List<String> processRecordsToString(Map<K, String> headerMapping, Map<K, I> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
List
of formattedString
, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
processRecords
public final <K,I extends Iterable<?>> void processRecords(Map<K, String> headerMapping, Map<K, I> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output . The output will remain open for further write operations. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
processObjectRecordsToString
Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key type- Parameters:
rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
List
of formattedString
, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
processObjectRecordsToString
public final <K> List<String> processObjectRecordsToString(Map<K, String> headerMapping, Map<K, Object[]> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
and writes the result into aList
ofString
formatted to according to the specified output format. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate aList
ofString
.- Returns:
- a
List
of formattedString
, eachString
representing one successful iteration over at least one element of the iterators in the map.
-
processObjectRecords
Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output . The output will remain open for further write operations. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
processObjectRecordsAndClose
public final <K> void processObjectRecordsAndClose(Map<K, String> headerMapping, Map<K, Object[]> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output and closes the writer. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
processObjectRecordsAndClose
Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output and closes the writer. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key type- Parameters:
rowData
- the map whose values will be used to generate a number of output records
-
processRecordsAndClose
public final <K,I extends Iterable<?>> void processRecordsAndClose(Map<K, String> headerMapping, Map<K, I> rowData) Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output and closes the writer. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
headerMapping
- a mapping associating the keys of the input map to their corresponding header names.rowData
- the map whose values will be used to generate a number of output records
-
processRecordsAndClose
Processes the data in all values of a map using theRowWriterProcessor
provided byCommonWriterSettings.getRowWriterProcessor()
, then writes all values to the output and closes the writer. Each value is expected to be iterable and the result of this method will produce the number of records equal to the longest iterable. A new record will be created each time at least oneIterator.hasNext()
returnstrue
.Null
will be written when a iterator has been fully read. ATextWritingException
will be thrown if noRowWriterProcessor
is provided byCommonWriterSettings.getRowWriterProcessor()
.- Type Parameters:
K
- the key typeI
- the iterable type- Parameters:
rowData
- the map whose values will be used to generate a number of output records
-
getContent
-
getContent
-
allowTrim
protected final boolean allowTrim(int fieldIndex) Checks whether the writer can remove trailing/leading whitespaces from a value being written. Applies to headers where names can be conflicting if trimmed for example' a '
and'a'
will become the same value if the spaces are removed)- Parameters:
fieldIndex
- index of the field to be written.- Returns:
true
if the value being written is not a header name, or it is a header name that won't conflict with another header if its surrounding whitespaces are trimmed.
-