si::ijs::acs::objectexplorer::engine::Converter Interface Reference

Inheritance diagram for si::ijs::acs::objectexplorer::engine::Converter:

[legend]

List of all members.

Public Member Functions
String	getDescription ()
boolean	acceptConvert (String operation)
boolean	acceptInverseConvert (String operation)
Object	convert (String operation, Object[] params, Object returnValue)
void	inverseConvert (String operation, Object[] params)
Class[]	getInverseConvertParameterTypes (String operation, Class[] parameterTypes)

---

Detailed Description

Converter interface.

---

Member Function Documentation

boolean si::ijs::acs::objectexplorer::engine::Converter::acceptConvert

(

String

operation

)

Check if conversion is to be applied on the given operation.

Parameters:

operation

name of the operation.

Returns:

true if conversion on any parameter (or return value) of the given operation is to be made, otherwise false.

Implemented in si::ijs::acs::objectexplorer::engine::BACI::BACIConverterSupport.

Referenced by si::ijs::acs::objectexplorer::OERemoteResponseCallback::responseReceived(), and si::ijs::acs::objectexplorer::ReporterBean::toString().

boolean si::ijs::acs::objectexplorer::engine::Converter::acceptInverseConvert

(

String

operation

)

Check if inverse conversion is to be applied on the given operation.

Parameters:

operation

name of the operation.

Returns:

true if inverse conversion on any parameter (or return value) of the given operation is to be made, otherwise false.

Implemented in si::ijs::acs::objectexplorer::engine::BACI::BACIConverterSupport.

Referenced by si::ijs::acs::objectexplorer::CallMethodDialog::CallMethodDialog().

Object si::ijs::acs::objectexplorer::engine::Converter::convert	(	String	operation,
		Object[]	params,
		Object	returnValue
	)

Convert value (by chaning params array and returning converted returnValue).

Parameters:

	operation	operation name owning the parameter.
	params	operation parameters (response) or auxiliary parameters (see RemoteCall::getAuxReturnValues())
	returnValue	operation return value, if not available null.

Returns:

converted returnValue value, or just unchanged returnValue.

See also:

RemoteCall::getAuxReturnValues()

Implemented in si::ijs::acs::objectexplorer::engine::BACI::BACIConverterSupport.

Referenced by si::ijs::acs::objectexplorer::OERemoteResponseCallback::responseReceived(), and si::ijs::acs::objectexplorer::ReporterBean::toString().

String si::ijs::acs::objectexplorer::engine::Converter::getDescription

(

)

Get the description of the converter, e.g. "kph -> mph".

Returns:

description of the converter

Implemented in si::ijs::acs::objectexplorer::engine::BACI::converters::BACIDegreesToDDMMSSConverter, si::ijs::acs::objectexplorer::engine::BACI::converters::BACIDouble1000Multiplier, and si::ijs::acs::objectexplorer::engine::BACI::converters::BACIDoubleLinearConverter.

Referenced by si::ijs::acs::objectexplorer::ObjectExplorer::getconverterMenu(), and si::ijs::acs::objectexplorer::ObjectExplorer::loadConverters().

Class [] si::ijs::acs::objectexplorer::engine::Converter::getInverseConvertParameterTypes	(	String	operation,
		Class[]	parameterTypes
	)

Get parameters class types. This method returns classes expected by inverseConvert method. This method is needed to support conversion between different class types, e.g. degrees/radians to a structure of (hours, minutes, seconds).

Parameters:

	operation	operation name owning the parameters.
	parameterTypes	operation decalred parameter types.

Returns:

classes of parameters of given operation.

Implemented in si::ijs::acs::objectexplorer::engine::BACI::BACIConverterSupport.

Referenced by si::ijs::acs::objectexplorer::CallMethodDialog::getJPanel2(), and si::ijs::acs::objectexplorer::CallMethodDialog::invokeClicked().

void si::ijs::acs::objectexplorer::engine::Converter::inverseConvert	(	String	operation,
		Object[]	params
	)

Inverse convert value.

Parameters:

	operation	operation name owning the parameter.
	params	operation parameters
	returnValue	operation return value, if not available null.

Implemented in si::ijs::acs::objectexplorer::engine::BACI::BACIConverterSupport.

Referenced by si::ijs::acs::objectexplorer::CallMethodDialog::invokeClicked().

---

The documentation for this interface was generated from the following file:

• Converter.java