Package net.simplace.sim.io.interfaces

Class CSVInterface

java.lang.Object

net.simplace.sim.io.interfaces.FWSimInterface<FilePool>

net.simplace.sim.io.interfaces.FILEInterface

net.simplace.sim.io.interfaces.CSVInterface

public class CSVInterface
extends FILEInterface

implementation of the FWSimInterface giving access to resources from and output to files divider can be given in xml-configuration tag. If not given divider will by default be 'tab' or '\t' Use Interface by FWSimInterface.getInterface(FWSimVarMap, CONTENT_TYPE).getLinesOfFile();

Author:

Andreas Enders

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CSVInterface.DATA_MODE

Nested classes/interfaces inherited from class net.simplace.sim.io.interfaces.FWSimInterface

FWSimInterface.INTERFACE_TYPE

Field Summary

Fields

Modifier and Type	Field	Description
protected CSVInterface.DATA_MODE	iDataMode	data mode for IO to read/write array values
protected String	iDivider	divider can be given in xml-configuration tag.
protected Integer[]	iLinesToRead	number of header lines to skip before reading the data
protected long	iSkipAboveSize	the file name
protected Integer	iSkipHeaderLines	number of header lines to skip before reading the data
protected boolean	iUnit2Fieldname	add unit to field name in output

Fields inherited from class net.simplace.sim.io.interfaces.FILEInterface

iContent, iFileinfo, iFilename

Fields inherited from class net.simplace.sim.io.interfaces.FWSimInterface

iColumnMap, iColumnNamesInt, iIntColumnNames

Constructor Summary

Constructors

Modifier	Constructor	Description
	CSVInterface(String aName, int aPoolSize, String aFileName, String aContent, String aDivider, long aSkipAboveSize, Integer[] aLinesToRead, Integer aSkipHeaderLines, Boolean aAddUnit2FieldName, CSVInterface.DATA_MODE aDataMode)
protected	CSVInterface(String aName, org.jdom2.Element aInterfaceElement)

Method Summary

Modifier and Type	Method	Description
boolean	getAddUnitToFieldName()
CSVInterface.DATA_MODE	getDataMode()
String	getDivider()	divider can be given in xml-configuration tag.
FilePool	getInterface(FWSimVarMap aVarMap, FWSimVariable.CONTENT_TYPE aContentType)	implementation of the get interface method.
Integer[]	getLinesToRead()
long	getSkipAboveSize()
Integer	getSkipHeaderLines()
FWSimResourceCache	read(FWSimSession aFwSimSession, String aProjectID, Object aCache, LinkedHashMap<String,String> aKeyMap, FWSimInputAdapter aResourceAdapter, String aUniqueID, FWSimInterface.INTERFACE_TYPE aInterfaceType)	factory method creating an interface instance concerning the given data type
org.jdom2.Element	toXML()

Methods inherited from class net.simplace.sim.io.interfaces.FILEInterface

finalize, getFilename, setFilename

Methods inherited from class net.simplace.sim.io.interfaces.FWSimInterface

checkHeaderForColMode, createInterface, createInterface, createStatisticInterface, getInterfaceType, getName, getPoolSize, readColArray, toString, transformArrays, writeToDatabase

Methods inherited from class java.lang.Object

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

Field Details

iDivider

protected String iDivider

divider can be given in xml-configuration tag. If not given divider will by default be 'tab' or '\t'

iSkipAboveSize

protected long iSkipAboveSize

the file name

iLinesToRead

protected Integer[] iLinesToRead

number of header lines to skip before reading the data

iUnit2Fieldname

protected boolean iUnit2Fieldname

add unit to field name in output

iDataMode

protected CSVInterface.DATA_MODE iDataMode

data mode for IO to read/write array values

iSkipHeaderLines

protected Integer iSkipHeaderLines

number of header lines to skip before reading the data

Constructor Details

CSVInterface

protected CSVInterface(String aName,
 org.jdom2.Element aInterfaceElement)

Parameters:

aName -

aPoolSize -

aInterfaceElement -

CSVInterface

public CSVInterface(String aName,
 int aPoolSize,
 String aFileName,
 String aContent,
 String aDivider,
 long aSkipAboveSize,
 Integer[] aLinesToRead,
 Integer aSkipHeaderLines,
 Boolean aAddUnit2FieldName,
 CSVInterface.DATA_MODE aDataMode)

Parameters:

aName -

aPoolSize -

aFileName -

aDivider -

aSkipAboveSize -

aLinesToRead -

aSkipHeaderLines -

Method Details

read

public FWSimResourceCache read(FWSimSession aFwSimSession,
 String aProjectID,
 Object aCache,
 LinkedHashMap<String,String> aKeyMap,
 FWSimInputAdapter aResourceAdapter,
 String aUniqueID,
 FWSimInterface.INTERFACE_TYPE aInterfaceType)
                        throws MissingSimResourceException

Description copied from class: FWSimInterface

factory method creating an interface instance concerning the given data type

Specified by:

read in class FWSimInterface<FilePool>

Returns:

generic FWSimResourceCache

Throws:

MissingSimResourceException

getInterface

public FilePool getInterface(FWSimVarMap aVarMap,
 FWSimVariable.CONTENT_TYPE aContentType)

implementation of the get interface method.

Overrides:

getInterface in class FILEInterface

Returns:

generic interface connection object. for example: database - connection; xml - fileinfo

See Also:

• FWSimInterface.getInterface(FWSimVarMap, CONTENT_TYPE)

getDivider

public String getDivider()

divider can be given in xml-configuration tag. If not given divider will by default be 'tab' or '\t'

Returns:

the divider the string is split with to read the data from columns

getLinesToRead

public Integer[] getLinesToRead()

Returns:

getSkipHeaderLines

public Integer getSkipHeaderLines()

Returns:

the skipHeaderLines

getSkipAboveSize

public long getSkipAboveSize()

Returns:

getDataMode

public CSVInterface.DATA_MODE getDataMode()

getAddUnitToFieldName

public boolean getAddUnitToFieldName()

Returns:

if units should be added to field name

toXML

public org.jdom2.Element toXML()

Overrides:

toXML in class FILEInterface

Returns:

Element containing configuration for this Interface