org.seedstack.io.supercsv

Class SuperCsvTemplate

java.lang.Object

org.seedstack.io.spi.AbstractBaseTemplate

org.seedstack.io.supercsv.SuperCsvTemplate

All Implemented Interfaces:

Template

public class SuperCsvTemplate
extends AbstractBaseTemplate

CSV Template based on SuperCSV.

See Also:

supercsv

Constructor Summary

Constructors

Constructor and Description
SuperCsvTemplate(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addColumn(Column column) Adds a column.
String	getCharsetName()
List<Column>	getColumns() Gets the columns.
String	getDescription()
List<String>	getFields()
List<String>	getHeaders() Get the column headers name.
String	getName()
org.supercsv.prefs.CsvPreference	getPreferences() Builder CsvPreference with template parameters.
List<org.supercsv.cellprocessor.ift.CellProcessor>	getReadingCellProcessors()
List<org.supercsv.cellprocessor.ift.CellProcessor>	getWritingCellProcessors()
void	removeColumn(Column column) Removes a column.
void	setCharsetName(String charsetName)
void	setCsvEncoder(org.supercsv.encoder.CsvEncoder encoder) Sets the csv encoder.
void	setEndOfLine(String endOfLine)
void	setQuote(char quote)
void	setQuoteMode(org.supercsv.quote.QuoteMode quoteMode) Sets the quote mode.
void	setSeparator(char separator)
boolean	showHeader()
void	showHeader(boolean showHeader)
void	skipComments(org.supercsv.comment.CommentMatcher commentMatcher) Sets the comment matcher.
void	skipComments(String startWith) Sets the string used to indicate comments, eg.

Methods inherited from class java.lang.Object

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

Constructor Detail

SuperCsvTemplate

public SuperCsvTemplate(String name)

Constructor.

Parameters:

name - template name

Method Detail

getName

public String getName()

Specified by:

getName in interface Template

Specified by:

getName in class AbstractBaseTemplate

Returns:

the name

getDescription

public String getDescription()

Specified by:

getDescription in interface Template

Specified by:

getDescription in class AbstractBaseTemplate

Returns:

the description

getPreferences

public org.supercsv.prefs.CsvPreference getPreferences()

Builder CsvPreference with template parameters.

Returns:

CSV preferences

setQuoteMode

public void setQuoteMode(org.supercsv.quote.QuoteMode quoteMode)

Sets the quote mode.

Parameters:

quoteMode - quote mode

setCsvEncoder

public void setCsvEncoder(org.supercsv.encoder.CsvEncoder encoder)

Sets the csv encoder.

Parameters:

encoder - csv encoder

skipComments

public void skipComments(String startWith)

Sets the string used to indicate comments, eg. # or //.

Parameters:

startWith - string a the beginning of a comment line

skipComments

public void skipComments(org.supercsv.comment.CommentMatcher commentMatcher)

Sets the comment matcher.

Parameters:

commentMatcher - comment matcher

addColumn

public void addColumn(Column column)

Adds a column.

Parameters:

column - csv column

removeColumn

public void removeColumn(Column column)

Removes a column.

Parameters:

column - csv column

getColumns

public List<Column> getColumns()

Gets the columns.

Returns:

list of column

getHeaders

public List<String> getHeaders()

Get the column headers name.

Returns:

list of headers

getFields

public List<String> getFields()

Returns:

list of model fields to render

getWritingCellProcessors

public List<org.supercsv.cellprocessor.ift.CellProcessor> getWritingCellProcessors()

Returns:

list of column writing configuration

getReadingCellProcessors

public List<org.supercsv.cellprocessor.ift.CellProcessor> getReadingCellProcessors()

Returns:

list of column reading configuration

setQuote

public void setQuote(char quote)

Parameters:

quote - the quote to set

setSeparator

public void setSeparator(char separator)

Parameters:

separator - the separator to set

setEndOfLine

public void setEndOfLine(String endOfLine)

Parameters:

endOfLine - the endOfLine to set

getCharsetName

public String getCharsetName()

Returns:

the charsetName

setCharsetName

public void setCharsetName(String charsetName)

Parameters:

charsetName - the charsetName to set

showHeader

public boolean showHeader()

Returns:

the showHeader

showHeader

public void showHeader(boolean showHeader)

Parameters:

showHeader - the showHeader to set