Package com.inductiveautomation.rm.base

Class RMCSVReader

java.lang.Object

com.inductiveautomation.rm.base.RMCSVReader

public class RMCSVReader
extends Object

A class for reading file of comma separated values, or really any separated values.

Constructor Summary

Constructors

Constructor	Description
RMCSVReader()

Method Summary

Modifier and Type	Method	Description
Entity	getEntity()	Returns the entity generated from last readRecords.
String	getFieldDelimiter()	Returns the field delimiter.
int	getFieldDelimiterCount()	Returns the number of field delimiters found in last readFormat.
boolean	getHasHeaderRow()	Returns whether first row has field names.
boolean	getHasQuotedFields()	Returns whether fields are quoted.
String	getRecordDelimiter()	Returns the record delimiter.
int	getRecordDelimiterCount()	Returns the number of record delimeters found in last readFormat.
String	getSourceName(Object aSource)	Returns the source name.
String	getSourceString(Object aSource)	Creates the source string.
void	readFormat(String aString)	Analyzes the given string and sets reader format attributes.
List<Map>	readObject(Object aSource)	Reads given source and returns list of maps.
List<Map>	readObject(Object aSource, Entity anEntity)	Reads given source and returns list of maps.
List<Map>	readObject(Object aSource, String aName, boolean doReadFormat)	Reads records from given string (and creates entity).
void	setFieldDelimiter(String aDelimiter)	Sets the field delimiter.
void	setHasHeaderRow(boolean aFlag)	Sets whether first row has field names.
void	setHasQuotedFields(boolean aFlag)	Sets whether records are quoted.
void	setRecordDelimiter(String aDelimiter)	Sets the record delimiter.

Methods inherited from class java.lang.Object

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

Constructor Details

RMCSVReader

public RMCSVReader()

Method Details

getFieldDelimiter

public String getFieldDelimiter()

Returns the field delimiter.

setFieldDelimiter

public void setFieldDelimiter(String aDelimiter)

Sets the field delimiter.

getRecordDelimiter

public String getRecordDelimiter()

Returns the record delimiter.

setRecordDelimiter

public void setRecordDelimiter(String aDelimiter)

Sets the record delimiter.

getHasHeaderRow

public boolean getHasHeaderRow()

Returns whether first row has field names.

setHasHeaderRow

public void setHasHeaderRow(boolean aFlag)

Sets whether first row has field names.

getHasQuotedFields

public boolean getHasQuotedFields()

Returns whether fields are quoted.

setHasQuotedFields

public void setHasQuotedFields(boolean aFlag)

Sets whether records are quoted.

readObject

public List<Map> readObject(Object aSource)

Reads given source and returns list of maps.

readObject

public List<Map> readObject(Object aSource,
 Entity anEntity)

Reads given source and returns list of maps.

readObject

public List<Map> readObject(Object aSource,
 String aName,
 boolean doReadFormat)

Reads records from given string (and creates entity).

readFormat

public void readFormat(String aString)

Analyzes the given string and sets reader format attributes.

getFieldDelimiterCount

public int getFieldDelimiterCount()

Returns the number of field delimiters found in last readFormat.

getEntity

public Entity getEntity()

Returns the entity generated from last readRecords.

getRecordDelimiterCount

public int getRecordDelimiterCount()

Returns the number of record delimeters found in last readFormat.

getSourceName

public String getSourceName(Object aSource)

Returns the source name.

getSourceString

public String getSourceString(Object aSource)

Creates the source string.