Package net.simplace.sim.io

Klasse FWSimIOAdapter

java.lang.Object

net.simplace.sim.io.FWSimIOAdapter

Alle implementierten Schnittstellen:

FWSimFieldContainer

Bekannte direkte Unterklassen:

FWSimInputAdapter, FWSimOutputAdapter, FWSimSyncAdapter

public abstract class FWSimIOAdapter
extends Object
implements FWSimFieldContainer

Implements the FWSimFieldContainer to be able to access resources and output adaptors extending this class. create form fields makes it possible to use the form fields to fill the content of this adapter.

Autor:

Andreas Enders

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	FWSimIOAdapter.FREQUENCE	FREQUENCE the data is written, accessed, used or updated in the different adapters

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected boolean	iArrayMode	Source field from SimVarMap where key is taken from to filter the data in the adapter
protected int	iFieldcount	Number count of the fields accessible in this adapter
protected final FWSimIOAdapter.FREQUENCE	iFrequence	FREQUENCE the data is written, accessed, used or updated in the different adapters
protected final LinkedHashMap<String,FWSimVariable<?>>	iHeaderVariables	Hash map of the HeaderVariables used for all data interfacing.
protected FWSimInterface<?>	iInterface	SimInterface used to access the data.
protected String	iJexlRule
protected LinkedHashMap<String,String>	iKeyMap	Key field of data in the adapter
protected final String	iName	Name from configuration
protected int	iOrderNumber	order number for the serial order of the components
protected ProcessTime	iProcessTime
protected final org.jdom2.Element	iResourceElement	source Element used for creation of the Adapter
protected final FWSimSession	iSession
protected String	iSourceKey	Source field from SimVarMap where key is taken from to filter the data in the adapter

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
	FWSimIOAdapter(FWSimIOAdapter aAdapter, FWSimInterface<?> aInterface)
	FWSimIOAdapter(org.jdom2.Element aResourceElement, String aName, int aOrderNumber, FWSimInterface<?> aInterface, FWSimIOAdapter.FREQUENCE aFrequence, ProcessTime aProcessTime, FWSimSession aSession)
protected	FWSimIOAdapter(org.jdom2.Element aResourceElement, FWSimSession aSession, int aOrderNumber)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addProcessTime(long aProcessTime)	adds the processTime
void	addVariable(FWSimVariable<?> aVariable)	be careful if using this method while it adds a field to the header information
void	checkCondition(Boolean aCheckResult, String aMessage)	Called from inside the FWSimFieldContainer to log the initialization Errors.
static org.jdom2.Element	createFormFields(FWSimVariable.CONTENT_TYPE aContentType, FWSimInterface<?> aInterface, FWSimIOAdapter aAdapter, FWSimIOAdapter.FREQUENCE aFrequence, boolean aEnabled)
HashMap<String,FWSimVariable<?>>	createVariables()	returns a new hash map containing the header information
void	finalize()
org.jdom2.Element	getCreateFormXML()
org.jdom2.Element	getEditFormXML(boolean aEnabled)
HashMap<String,FWSimVariable<?>>	getFieldMap()	returns the header information
FWSimIOAdapter.FREQUENCE	getFrequence()
LinkedHashMap<String,FWSimVariable<?>>	getHeaderVariables()
org.jdom2.Element	getHeaderXML()
FWSimInterface<?>	getInterface()
String	getJexlRule()
HashMap<String,String>	getKeyMap()
String	getName()
int	getOrderNumber()
FWSimVariable<?>	getVariable(String aID)	gets FWSimVariable from the header information
boolean	isArrayMode()
boolean	isConditionCheck()
void	removeVariable(String aID)	be careful if using this method while it removes a field from the header information
void	setInterface(FWSimInterface<?> aInterface)
void	setOrderNumber(int orderNumber)
String	toString()	implementation returning the name of the component only
protected void	writeHeaderList()	writes a new header list to the element

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden net.simplace.sim.util.FWSimFieldContainer

getContentType, getInputVariables, getOutputVariables, getVarMap, toXML

Felddetails

iJexlRule

protected String iJexlRule

iSession

protected final FWSimSession iSession

iResourceElement

protected final org.jdom2.Element iResourceElement

source Element used for creation of the Adapter

iName

protected final String iName

Name from configuration

iOrderNumber

protected int iOrderNumber

order number for the serial order of the components

iInterface

protected FWSimInterface<?> iInterface

SimInterface used to access the data. Adapter stays media independent.

iHeaderVariables

protected final LinkedHashMap<String,FWSimVariable<?>> iHeaderVariables

Hash map of the HeaderVariables used for all data interfacing. Used for Input - Resources and Output - Results

Siehe auch:

• for more detail on the possible attriburtes of the fields.

iFieldcount

protected int iFieldcount

Number count of the fields accessible in this adapter

iFrequence

protected final FWSimIOAdapter.FREQUENCE iFrequence

FREQUENCE the data is written, accessed, used or updated in the different adapters

iKeyMap

protected LinkedHashMap<String,String> iKeyMap

Key field of data in the adapter

iSourceKey

protected String iSourceKey

Source field from SimVarMap where key is taken from to filter the data in the adapter

iArrayMode

protected boolean iArrayMode

Source field from SimVarMap where key is taken from to filter the data in the adapter

iProcessTime

protected ProcessTime iProcessTime

Konstruktordetails

FWSimIOAdapter

protected FWSimIOAdapter(org.jdom2.Element aResourceElement,
 FWSimSession aSession,
 int aOrderNumber)

Parameter:

aResourceElement -

aSession -

aOrderNumber -

FWSimIOAdapter

public FWSimIOAdapter(org.jdom2.Element aResourceElement,
 String aName,
 int aOrderNumber,
 FWSimInterface<?> aInterface,
 FWSimIOAdapter.FREQUENCE aFrequence,
 ProcessTime aProcessTime,
 FWSimSession aSession)

Parameter:

aResourceElement -

aName -

aOrderNumber -

aInterface -

aFrequence -

aProcessTime -

aSession -

FWSimIOAdapter

public FWSimIOAdapter(FWSimIOAdapter aAdapter,
 FWSimInterface<?> aInterface)

Parameter:

aAdapter -

aInterface -

Methodendetails

addVariable

public void addVariable(FWSimVariable<?> aVariable)

be careful if using this method while it adds a field to the header information

Angegeben von:

addVariable in Schnittstelle FWSimFieldContainer

Parameter:

aVariable -

Siehe auch:

• FWSimFieldContainer.addVariable(net.simplace.sim.util.FWSimVariable)

getVariable

public FWSimVariable<?> getVariable(String aID)

gets FWSimVariable from the header information

Angegeben von:

getVariable in Schnittstelle FWSimFieldContainer

Parameter:

aID -

Gibt zurück:

FWSimVariable for ID in Field Map

Siehe auch:

• FWSimFieldContainer.getVariable(java.lang.String)

removeVariable

public void removeVariable(String aID)

be careful if using this method while it removes a field from the header information

Angegeben von:

removeVariable in Schnittstelle FWSimFieldContainer

Parameter:

aID -

Siehe auch:

• FWSimFieldContainer.removeVariable(java.lang.String)

getName

public String getName()

Angegeben von:

getName in Schnittstelle FWSimFieldContainer

Gibt zurück:

the name

getFrequence

public FWSimIOAdapter.FREQUENCE getFrequence()

Angegeben von:

getFrequence in Schnittstelle FWSimFieldContainer

Gibt zurück:

the frequency

getJexlRule

public String getJexlRule()

Gibt zurück:

the rule

getOrderNumber

public int getOrderNumber()

Angegeben von:

getOrderNumber in Schnittstelle FWSimFieldContainer

Gibt zurück:

the orderNumber

setOrderNumber

public void setOrderNumber(int orderNumber)

Parameter:

orderNumber - the orderNumber to set

getInterface

public FWSimInterface<?> getInterface()

Gibt zurück:

FWSimInterface

setInterface

public void setInterface(FWSimInterface<?> aInterface)

Parameter:

aInterface -

getKeyMap

public HashMap<String,String> getKeyMap()

Gibt zurück:

the key

getHeaderVariables

public LinkedHashMap<String,FWSimVariable<?>> getHeaderVariables()

Gibt zurück:

the headerVariables

createVariables

public HashMap<String,FWSimVariable<?>> createVariables()

returns a new hash map containing the header information

Angegeben von:

createVariables in Schnittstelle FWSimFieldContainer

Gibt zurück:

variables from the field map

Siehe auch:

• FWSimFieldContainer.createVariables()

addProcessTime

public void addProcessTime(long aProcessTime)

adds the processTime

Parameter:

aProcessTime -

getFieldMap

public HashMap<String,FWSimVariable<?>> getFieldMap()

returns the header information

Angegeben von:

getFieldMap in Schnittstelle FWSimFieldContainer

Gibt zurück:

whole field map as created in createVariables()

Siehe auch:

• FWSimFieldContainer.getFieldMap()

toString

public String toString()

implementation returning the name of the component only

Setzt außer Kraft:

toString in Klasse Object

Siehe auch:

• Object.toString()

getHeaderXML

public org.jdom2.Element getHeaderXML()

Gibt zurück:

XML Element of the Header information

isArrayMode

public boolean isArrayMode()

Gibt zurück:

if the Adapter is used in ArrayMode

getCreateFormXML

public org.jdom2.Element getCreateFormXML()

Angegeben von:

getCreateFormXML in Schnittstelle FWSimFieldContainer

Gibt zurück:

a xml element with all the settings of this component()

Siehe auch:

• FWSimFieldContainer.getCreateFormXML()

getEditFormXML

public org.jdom2.Element getEditFormXML(boolean aEnabled)

Angegeben von:

getEditFormXML in Schnittstelle FWSimFieldContainer

Parameter:

aEnabled -

Gibt zurück:

a xml element with all the settings of this component()

Siehe auch:

• FWSimFieldContainer.getEditFormXML(boolean)

createFormFields

public static org.jdom2.Element createFormFields(FWSimVariable.CONTENT_TYPE aContentType,
 FWSimInterface<?> aInterface,
 FWSimIOAdapter aAdapter,
 FWSimIOAdapter.FREQUENCE aFrequence,
 boolean aEnabled)

Parameter:

aContentType -

aInterface -

aAdapter -

aFrequence -

aEnabled -

Gibt zurück:

the created Element

writeHeaderList

protected void writeHeaderList()

writes a new header list to the element

finalize

public void finalize()
              throws Exception

Setzt außer Kraft:

finalize in Klasse Object

Löst aus:

Exception

Siehe auch:

• Object.finalize()

checkCondition

public void checkCondition(Boolean aCheckResult,
 String aMessage)

Beschreibung aus Schnittstelle kopiert: FWSimFieldContainer

Called from inside the FWSimFieldContainer to log the initialization Errors.

Angegeben von:

checkCondition in Schnittstelle FWSimFieldContainer

Parameter:

aCheckResult -

aMessage -

isConditionCheck

public boolean isConditionCheck()

Angegeben von:

isConditionCheck in Schnittstelle FWSimFieldContainer