Package com.inductiveautomation.rm.base
Class RMCSVReader
- java.lang.Object
-
- com.inductiveautomation.rm.base.RMCSVReader
-
public class RMCSVReader extends java.lang.Object
A class for reading file of comma separated values, or really any separated values.
-
-
Constructor Summary
Constructors Constructor Description RMCSVReader()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Entity
getEntity()
Returns the entity generated from last readRecords.java.lang.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.java.lang.String
getRecordDelimiter()
Returns the record delimiter.int
getRecordDelimiterCount()
Returns the number of record delimeters found in last readFormat.java.lang.String
getSourceName(java.lang.Object aSource)
Returns the source name.java.lang.String
getSourceString(java.lang.Object aSource)
Creates the source string.void
readFormat(java.lang.String aString)
Analyzes the given string and sets reader format attributes.java.util.List<java.util.Map>
readObject(java.lang.Object aSource)
Reads given source and returns list of maps.java.util.List<java.util.Map>
readObject(java.lang.Object aSource, Entity anEntity)
Reads given source and returns list of maps.java.util.List<java.util.Map>
readObject(java.lang.Object aSource, java.lang.String aName, boolean doReadFormat)
Reads records from given string (and creates entity).void
setFieldDelimiter(java.lang.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(java.lang.String aDelimiter)
Sets the record delimiter.
-
-
-
Method Detail
-
getFieldDelimiter
public java.lang.String getFieldDelimiter()
Returns the field delimiter.
-
setFieldDelimiter
public void setFieldDelimiter(java.lang.String aDelimiter)
Sets the field delimiter.
-
getRecordDelimiter
public java.lang.String getRecordDelimiter()
Returns the record delimiter.
-
setRecordDelimiter
public void setRecordDelimiter(java.lang.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 java.util.List<java.util.Map> readObject(java.lang.Object aSource)
Reads given source and returns list of maps.
-
readObject
public java.util.List<java.util.Map> readObject(java.lang.Object aSource, Entity anEntity)
Reads given source and returns list of maps.
-
readObject
public java.util.List<java.util.Map> readObject(java.lang.Object aSource, java.lang.String aName, boolean doReadFormat)
Reads records from given string (and creates entity).
-
readFormat
public void readFormat(java.lang.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 java.lang.String getSourceName(java.lang.Object aSource)
Returns the source name.
-
getSourceString
public java.lang.String getSourceString(java.lang.Object aSource)
Creates the source string.
-
-