Package net.simplace.sim.io.interfaces

Klasse 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();

Autor:

Andreas Enders

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	CSVInterface.DATA_MODE

Von Klasse geerbte verschachtelte Klassen/Schnittstellen net.simplace.sim.io.interfaces.FWSimInterface

FWSimInterface.INTERFACE_TYPE

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
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

Von Klasse geerbte Felder net.simplace.sim.io.interfaces.FILEInterface

iContent, iFileinfo, iFilename

Von Klasse geerbte Felder net.simplace.sim.io.interfaces.FWSimInterface

iColumnMap, iColumnNamesInt, iIntColumnNames

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
	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)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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()

Von Klasse geerbte Methoden net.simplace.sim.io.interfaces.FILEInterface

finalize, getFilename, setFilename

Von Klasse geerbte Methoden net.simplace.sim.io.interfaces.FWSimInterface

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

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

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

Konstruktordetails

CSVInterface

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

Parameter:

aName -

aInterfaceElement -

aPoolSize -

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)

Parameter:

aName -

aPoolSize -

aFileName -

aDivider -

aSkipAboveSize -

aLinesToRead -

aSkipHeaderLines -

Methodendetails

read

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

Beschreibung aus Klasse kopiert: FWSimInterface

factory method creating an interface instance concerning the given data type

Angegeben von:

read in Klasse FWSimInterface<FilePool>

Parameter:

aFwSimSession -

aProjectID -

aCache -

aKeyMap -

aResourceAdapter -

aUniqueID -

aInterfaceType -

Gibt zurück:

generic FWSimResourceCache

Löst aus:

MissingSimResourceException

getInterface

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

implementation of the get interface method.

Setzt außer Kraft:

getInterface in Klasse FILEInterface

Parameter:

aVarMap -

aContentType -

Gibt zurück:

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

Siehe auch:

• 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'

Gibt zurück:

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

getLinesToRead

public Integer[] getLinesToRead()

Gibt zurück:

getSkipHeaderLines

public Integer getSkipHeaderLines()

Gibt zurück:

the skipHeaderLines

getSkipAboveSize

public long getSkipAboveSize()

Gibt zurück:

getDataMode

public CSVInterface.DATA_MODE getDataMode()

getAddUnitToFieldName

public boolean getAddUnitToFieldName()

Gibt zurück:

if units should be added to field name

toXML

public org.jdom2.Element toXML()

Setzt außer Kraft:

toXML in Klasse FILEInterface

Gibt zurück:

Element containing configuration for this Interface