Package net.simplace.sim.io.resources

Class FWSimInputAdapter

java.lang.Object

net.simplace.sim.io.FWSimIOAdapter

net.simplace.sim.io.resources.FWSimInputAdapter

All Implemented Interfaces:

FWSimFieldContainer

Direct Known Subclasses:

FWSimResourceAdapter, FWSimResourceAlias, FWSimResourceTransformer

public abstract class FWSimInputAdapter
extends FWSimIOAdapter

Abstract implementation for the IO-Adapter for only reading input data

Author:

Andreas Enders

Nested Class Summary

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

FWSimIOAdapter.FREQUENCE

Field Summary

Fields

Modifier and Type	Field	Description
protected JexlRuleScript	iJexlScript
protected Boolean	iShouldCacheToDB	if the content of the result cache should also be put to the database

Fields inherited from class net.simplace.sim.io.FWSimIOAdapter

iArrayMode, iFieldcount, iFrequence, iHeaderVariables, iInterface, iJexlRule, iKeyMap, iName, iOrderNumber, iProcessTime, iResourceElement, iSession, iSourceKey

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FWSimInputAdapter(FWSimInputAdapter aAdapter, FWSimInterface<?> aInterface)	update adapter calls this clone construtor
protected	FWSimInputAdapter(org.jdom2.Element aResourceElement, String aName, int aOrderNumber, FWSimInterface<?> aInterface, FWSimIOAdapter.FREQUENCE aFrequence, FWSimSession aFwSimSession)	called from graph panel to instantiate the adapter
protected	FWSimInputAdapter(org.jdom2.Element aResourceElement, FWSimSession aSession, int aOrderNumber)	Create Adapter from Resource Element

Method Summary

Modifier and Type	Method	Description
FWSimVariable.CONTENT_TYPE	getContentType()
abstract FWSimResourceCache	getData(FWSimVarMap aVarMap)
Collection<FWSimVariable<?>>	getInputVariables()	always returning empty list because this adapters are not meant to receive input data
JexlRuleScript	getJexlScript()
Collection<FWSimVariable<?>>	getOutputVariables()	returning the variables from the header information
FWSimVarMap	getVarMap()
boolean	isTransformer()
boolean	shouldCacheToDB()
String	toHTMLTablestring()	creates HTML Documentation form of the Input Adaptor

Methods inherited from class net.simplace.sim.io.FWSimIOAdapter

addProcessTime, addVariable, checkCondition, createFormFields, createVariables, finalize, getCreateFormXML, getEditFormXML, getFieldMap, getFrequence, getHeaderVariables, getHeaderXML, getInterface, getJexlRule, getKeyMap, getName, getOrderNumber, getVariable, isArrayMode, isConditionCheck, removeVariable, setInterface, setOrderNumber, toString, writeHeaderList

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.simplace.sim.util.FWSimFieldContainer

toXML

Field Details

iShouldCacheToDB

protected Boolean iShouldCacheToDB

if the content of the result cache should also be put to the database

iJexlScript

protected JexlRuleScript iJexlScript

Constructor Details

FWSimInputAdapter

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

Create Adapter from Resource Element

Parameters:

aResourceElement -

aSession -

aOrderNumber -

FWSimInputAdapter

protected FWSimInputAdapter(org.jdom2.Element aResourceElement,
 String aName,
 int aOrderNumber,
 FWSimInterface<?> aInterface,
 FWSimIOAdapter.FREQUENCE aFrequence,
 FWSimSession aFwSimSession)

called from graph panel to instantiate the adapter

Parameters:

aResourceElement -

aName -

aOrderNumber -

aInterface -

aFrequence -

aFwSimSession -

FWSimInputAdapter

protected FWSimInputAdapter(FWSimInputAdapter aAdapter,
 FWSimInterface<?> aInterface)

update adapter calls this clone construtor

Parameters:

aAdapter -

aInterface -

Method Details

getData

public abstract FWSimResourceCache getData(FWSimVarMap aVarMap)
                                    throws MissingSimResourceException

Parameters:

aVarMap -

Returns:

SimResourceCache containing the data from the resource media

Throws:

MissingSimResourceException

getOutputVariables

public Collection<FWSimVariable<?>> getOutputVariables()

returning the variables from the header information

Returns:

FWSimVarables filtered - only output Variables

See Also:

• FWSimFieldContainer.getOutputVariables()

getInputVariables

public Collection<FWSimVariable<?>> getInputVariables()

always returning empty list because this adapters are not meant to receive input data

Returns:

FWSimVarables filtered - only input Variables

See Also:

• FWSimFieldContainer.getInputVariables()

getContentType

public FWSimVariable.CONTENT_TYPE getContentType()

Returns:

number in the order of Components

See Also:

• FWSimFieldContainer.getContentType()

getJexlScript

public JexlRuleScript getJexlScript()

Parameters:

aEngineToCreate -

Returns:

the jexlScript

getVarMap

public FWSimVarMap getVarMap()

Returns:

number in the order of Components

toHTMLTablestring

public String toHTMLTablestring()

creates HTML Documentation form of the Input Adaptor

Returns:

the generated HTMLString

isTransformer

public boolean isTransformer()

Returns:

if the InputAdapter is a transformer

shouldCacheToDB

public boolean shouldCacheToDB()

Returns: