Package com.storedobject.common

Class CSV

java.lang.Object

com.storedobject.common.CSV

All Implemented Interfaces:

ContentGenerator, TextContentGenerator

public abstract class CSV
extends Object
implements TextContentGenerator

CSV creator.

Author:

Syam

Field Summary

Fields inherited from interface com.storedobject.common.ContentGenerator

ext

Constructor Summary

Constructors

Constructor	Description
CSV()	Constructor.
CSV(int columnCount)	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract void	generateContent()	Override this method for adding content to the CSV.
final void	generateContent(Writer output)	Generate the content and write to a writer.
final String	getContentType()	Mime type of the content.
Function<Object,String>	getConverter()	Get the value converter that maps the column values to string.
final String	getFileExtension()	File extension normally used for this type of content.
protected Writer	getWriter()	Get the writer that takes the output.
void	setColumnCount(int columnCount)	Sets the number of columns to be used for the CSV content.
void	setConverter(Function<Object,String> converter)	Set the value converter to map the column values to string.
final void	setValue(int column, Object value)	Set a value at a specific column in the current row.
final void	setValues(Object... values)	Set values starting from the first column in the current row.
final void	setValuesFrom(int startingColumn, Object... values)	Set values starting from a specific column in the current row.
void	writeRow()	Write out the current row.

Methods inherited from class java.lang.Object

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

Constructor Details

CSV

public CSV()

Constructor.

CSV

public CSV(int columnCount)

Constructor.

Parameters:

columnCount - Number of columns.

Method Details

setColumnCount

public void setColumnCount(int columnCount)

Sets the number of columns to be used for the CSV content. The column count must be set before the writer is initialized. Additionally, the column count must be a positive integer.

Parameters:

columnCount - The number of columns to be set. Must be 1 or greater.

Throws:

SORuntimeException - If the column count is set after the writer is initialized or if an invalid column count (less than 1) is specified.

generateContent

public abstract void generateContent()
                              throws Exception

Override this method for adding content to the CSV. Typically, you call setValue(int, Object) (or its variants - setValues(Object...) or setValuesFrom(int, Object...)) for each column value and call writeRow() to write out each row.

Throws:

Exception

generateContent

public final void generateContent(Writer output)
                           throws Exception

Description copied from interface: TextContentGenerator

Generate the content and write to a writer.

Specified by:

generateContent in interface TextContentGenerator

Parameters:

output - Writer to collect the generated content.

Throws:

Exception - if content can not be generated.

setValue

public final void setValue(int column,
 Object value)

Set a value at a specific column in the current row.

Parameters:

column - Column,

value - Value to set.

setValuesFrom

public final void setValuesFrom(int startingColumn,
 Object... values)

Set values starting from a specific column in the current row.

Parameters:

startingColumn - Column,

values - Values to set.

setValues

public final void setValues(Object... values)

Set values starting from the first column in the current row.

Parameters:

values - Values to set.

writeRow

public void writeRow()
              throws IOException

Write out the current row.

Throws:

IOException

setConverter

public void setConverter(Function<Object,String> converter)

Set the value converter to map the column values to string.

Parameters:

converter - Converter. If no converter is set, StringUtility.toString(Object) is used as the default converter.

getConverter

public Function<Object,String> getConverter()

Get the value converter that maps the column values to string.

Returns:

Current converter. It could be null.

getWriter

protected Writer getWriter()

Get the writer that takes the output. (You should not write anything directly to it).

Returns:

The writer.

getContentType

public final String getContentType()

Description copied from interface: TextContentGenerator

Mime type of the content.

Specified by:

getContentType in interface ContentGenerator

Specified by:

getContentType in interface TextContentGenerator

Returns:

Default implementation returns "text/plain".

getFileExtension

public final String getFileExtension()

Description copied from interface: TextContentGenerator

File extension normally used for this type of content.

Specified by:

getFileExtension in interface ContentGenerator

Specified by:

getFileExtension in interface TextContentGenerator

Returns:

Default implementation returns "txt".