com.arcway.cockpit.docgen.provider.interfaces

Interface ICSVHelper

public interface ICSVHelper

The ICSVHelper provides access methods used for building strings and text lines for files in comma separated values format. The ICSVHelper can be referenced directly within a document template by its name csvHelper.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCSVLine(java.util.Collection<java.lang.Object> attributes, java.lang.String separator) Builds a text line in comma separated values format where each of the given attributes are separated by the given separator string.
java.lang.String	getCSVLine(java.lang.Object[] attributes, java.lang.String separator) Builds a text line in comma separated values format where each of the given attributes are separated by the given separator string.
java.lang.String	getCSVStringForAttribute(java.lang.Object attribute) Converts the HTML encoded string of an attribute into one string which can be used as element in an CSV file.
java.lang.String	getCSVStringForString(java.lang.String string) Converts a string into one string which can be used as element in an CSV file.
java.lang.String	getStringForAttribute(java.lang.Object attribute) Converts the HTML encoded string of an attribute into one string.

Method Detail

getStringForAttribute

java.lang.String getStringForAttribute(java.lang.Object attribute)

Converts the HTML encoded string of an attribute into one string. Aside HTML decoding arrays of text are combined to one text string where each part ist separated by a \n character.

Parameters:

attribute - string object or array or collection of strings. Any other type will be ignored

Returns:

text string which can be used within an CSV file

getCSVStringForString

java.lang.String getCSVStringForString(java.lang.String string)

Converts a string into one string which can be used as element in an CSV file. The " characters are replaced by "".

Parameters:

attribute - string object. Any other type will be ignored

Returns:

text string which can be used within an CSV file

getCSVStringForAttribute

java.lang.String getCSVStringForAttribute(java.lang.Object attribute)

Converts the HTML encoded string of an attribute into one string which can be used as element in an CSV file. Aside HTML decoding the " characters are replaced by "" and lists or arrays of text are combined to one text string where each part ist separated by a \n character.

Parameters:

attribute - string object or array or collection of strings. Any other type will be ignored

Returns:

text string which can be used within an CSV file

getCSVLine

java.lang.String getCSVLine(java.lang.Object[] attributes,
                            java.lang.String separator)

Builds a text line in comma separated values format where each of the given attributes are separated by the given separator string. For standard CSV format use "," as separator, for excel compatible csv format use ";" as separator.

Parameters:

attributes - Array of attributes which shall be listed in the CSV line, NOT NULL

separator - separator chararcter to use ("," for standard CSV, ";" for Excel compatible CSV, NOT NULL

Returns:

line in CSV format containing all given attributes

getCSVLine

java.lang.String getCSVLine(java.util.Collection<java.lang.Object> attributes,
                            java.lang.String separator)

Builds a text line in comma separated values format where each of the given attributes are separated by the given separator string. For standard CSV format use "," as separator, for excel compatible csv format use ";" as separator.

Parameters:

attributes - Collection of attributes which shall be listed in the CSV line, NOT NULL

separator - separator chararcter to use ("," for standard CSV, ";" for Excel compatible CSV, NOT NULL

Returns:

line in CSV format containing all given attributes