org.mule.modules.salesforce.analytics.internal.metadata

Class FileFormat

java.lang.Object

org.mule.modules.salesforce.analytics.internal.metadata.FileFormat

public class FileFormat
extends Object

Data transfer object holding information regarding the format of the file.

Constructor Summary

Constructors

Constructor and Description
FileFormat()

Method Summary

Modifier and Type	Method and Description
String	getCharsetName() Getter method for charset name.
String	getFieldsDelimitedBy() Getter method for string that delimits the fields.
String	getFieldsEnclosedBy() Getter method for string that encloses fields.
String	getLinesTerminatedBy() Getter method for string that delimits the lines.
Integer	getNumberOfLinesToIgnore() Getter method for number of lines to ignore.
void	setCharsetName(String charsetName) Setter method for charset name.
void	setFieldsDelimitedBy(String fieldsDelimitedBy) Setter method for string that delimits the fields.
void	setFieldsEnclosedBy(String fieldsEnclosedBy) Setter method for string that encloses fields.
void	setLinesTerminatedBy(String linesTerminatedBy) Setter method for string that delimits the lines.
void	setNumberOfLinesToIgnore(Integer numberOfLinesToIgnore) Setter method for number of lines to ignore.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileFormat

public FileFormat()

Method Detail

getCharsetName

public String getCharsetName()

Getter method for charset name.

Returns:

the charset of the file

setCharsetName

public void setCharsetName(String charsetName)

Setter method for charset name.

Parameters:

charsetName - - the charset of the file

getFieldsEnclosedBy

public String getFieldsEnclosedBy()

Getter method for string that encloses fields. Character that can be used to enclose fields in the CSV file. Only double-quotes are supported. If a double quote is used within a field, it must be escaped by preceding it with another double-quote. Must be "\"".

Returns:

the value enclosing fields

setFieldsEnclosedBy

public void setFieldsEnclosedBy(String fieldsEnclosedBy)

Setter method for string that encloses fields. Character that can be used to enclose fields in the CSV file. Only double-quotes are supported. If a double quote is used within a field, it must be escaped by preceding it with another double-quote. Must be "\"".

Parameters:

fieldsEnclosedBy - - the value enclosing fields

getFieldsDelimitedBy

public String getFieldsDelimitedBy()

Getter method for string that delimits the fields. Character that separates field values in the CSV file. Must be ",".

Returns:

the string that delimits values

setFieldsDelimitedBy

public void setFieldsDelimitedBy(String fieldsDelimitedBy)

Setter method for string that delimits the fields. Character that separates field values in the CSV file.

Parameters:

fieldsDelimitedBy - Character that separates field values in the CSV file. Must be ",".

getLinesTerminatedBy

public String getLinesTerminatedBy()

Getter method for string that delimits the lines. Character indicating the end of a line.

Returns:

the string that delimits lines

setLinesTerminatedBy

public void setLinesTerminatedBy(String linesTerminatedBy)

Setter method for string that delimits the lines. Character indicating the end of a line.

Parameters:

linesTerminatedBy - - the string that delimits lines

getNumberOfLinesToIgnore

public Integer getNumberOfLinesToIgnore()

Getter method for number of lines to ignore. Number of lines for the parser to ignore (allows you to specify a header). Must be at least 1.

Returns:

the number of lines to ignore

setNumberOfLinesToIgnore

public void setNumberOfLinesToIgnore(Integer numberOfLinesToIgnore)

Setter method for number of lines to ignore. Number of lines for the parser to ignore (allows you to specify a header). Must be at least 1.

Parameters:

numberOfLinesToIgnore - - the number of lines to ignore