Package net.simplace.sim.io

Class FWSimIOAdapter

java.lang.Object

net.simplace.sim.io.FWSimIOAdapter

All Implemented Interfaces:

FWSimFieldContainer

Direct Known Subclasses:

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.

Author:

Andreas Enders

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FWSimIOAdapter.FREQUENCE	FREQUENCE the data is written, accessed, used or updated in the different adapters

Field Summary

Fields

Modifier and Type	Field	Description
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

Constructor Summary

Constructors

Modifier	Constructor	Description
	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)

Method Summary

Modifier and Type	Method	Description
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

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

getContentType, getInputVariables, getOutputVariables, getVarMap, toXML

Field Details

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

See Also:

• 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

Constructor Details

FWSimIOAdapter

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

Parameters:

aResourceElement -

aSession -

aOrderNumber -

FWSimIOAdapter

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

Parameters:

aResourceElement -

aName -

aOrderNumber -

aInterface -

aFrequence -

aProcessTime -

aSession -

FWSimIOAdapter

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

Parameters:

aAdapter -

aInterface -

Method Details

addVariable

public void addVariable(FWSimVariable<?> aVariable)

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

Specified by:

addVariable in interface FWSimFieldContainer

See Also:

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

getVariable

public FWSimVariable<?> getVariable(String aID)

gets FWSimVariable from the header information

Specified by:

getVariable in interface FWSimFieldContainer

Returns:

FWSimVariable for ID in Field Map

See Also:

• 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

Specified by:

removeVariable in interface FWSimFieldContainer

See Also:

• FWSimFieldContainer.removeVariable(java.lang.String)

getName

public String getName()

Specified by:

getName in interface FWSimFieldContainer

Returns:

the name

getFrequence

public FWSimIOAdapter.FREQUENCE getFrequence()

Specified by:

getFrequence in interface FWSimFieldContainer

Returns:

the frequency

getJexlRule

public String getJexlRule()

Returns:

the rule

getOrderNumber

public int getOrderNumber()

Specified by:

getOrderNumber in interface FWSimFieldContainer

Returns:

the orderNumber

setOrderNumber

public void setOrderNumber(int orderNumber)

Parameters:

orderNumber - the orderNumber to set

getInterface

public FWSimInterface<?> getInterface()

Returns:

FWSimInterface

setInterface

public void setInterface(FWSimInterface<?> aInterface)

Parameters:

aInterface -

getKeyMap

public HashMap<String,String> getKeyMap()

Returns:

the key

getHeaderVariables

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

Returns:

the headerVariables

createVariables

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

returns a new hash map containing the header information

Specified by:

createVariables in interface FWSimFieldContainer

Returns:

variables from the field map

See Also:

• FWSimFieldContainer.createVariables()

addProcessTime

public void addProcessTime(long aProcessTime)

adds the processTime

Parameters:

aProcessTime -

getFieldMap

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

returns the header information

Specified by:

getFieldMap in interface FWSimFieldContainer

Returns:

whole field map as created in createVariables()

See Also:

• FWSimFieldContainer.getFieldMap()

toString

public String toString()

implementation returning the name of the component only

Overrides:

toString in class Object

See Also:

• Object.toString()

getHeaderXML

public org.jdom2.Element getHeaderXML()

Returns:

XML Element of the Header information

isArrayMode

public boolean isArrayMode()

Returns:

if the Adapter is used in ArrayMode

getCreateFormXML

public org.jdom2.Element getCreateFormXML()

Specified by:

getCreateFormXML in interface FWSimFieldContainer

Returns:

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

See Also:

• FWSimFieldContainer.getCreateFormXML()

getEditFormXML

public org.jdom2.Element getEditFormXML(boolean aEnabled)

Specified by:

getEditFormXML in interface FWSimFieldContainer

Returns:

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

See Also:

• FWSimFieldContainer.getEditFormXML(boolean)

createFormFields

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

Parameters:

aContentType -

aInterface -

aAdapter -

aFrequence -

aEnabled -

Returns:

the created Element

writeHeaderList

protected void writeHeaderList()

writes a new header list to the element

finalize

public void finalize()
              throws Exception

Overrides:

finalize in class Object

Throws:

Exception

See Also:

• Object.finalize()

checkCondition

public void checkCondition(Boolean aCheckResult,
 String aMessage)

Description copied from interface: FWSimFieldContainer

Called from inside the FWSimFieldContainer to log the initialization Errors.

Specified by:

checkCondition in interface FWSimFieldContainer

isConditionCheck

public boolean isConditionCheck()

Specified by:

isConditionCheck in interface FWSimFieldContainer