si.ijs.acs.objectexplorer.engine

Interface Converter

All Known Implementing Classes:

BACIConverterSupport, BACIDegreesToDDMMSSConverter, BACIDouble1000Multiplier, BACIDoubleLinearConverter

public interface Converter

Converter interface.

Method Summary

Modifier and Type	Method and Description
boolean	acceptConvert(java.lang.String operation) Check if conversion is to be applied on the given operation.
boolean	acceptInverseConvert(java.lang.String operation) Check if inverse conversion is to be applied on the given operation.
java.lang.Object	convert(java.lang.String operation, java.lang.Object[] params, java.lang.Object returnValue) Convert value (by chaning params array and returning converted returnValue).
java.lang.String	getDescription() Get the description of the converter, e.g.
DataType[]	getInverseConvertParameterTypes(java.lang.String operation, DataType[] parameterTypes) Get parameters class types.
void	inverseConvert(java.lang.String operation, java.lang.Object[] params) Inverse convert value.

Method Detail

getDescription

java.lang.String getDescription()

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

Returns:

description of the converter

acceptConvert

boolean acceptConvert(java.lang.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.

acceptInverseConvert

boolean acceptInverseConvert(java.lang.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.

convert

java.lang.Object convert(java.lang.String operation,
                         java.lang.Object[] params,
                         java.lang.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()

inverseConvert

void inverseConvert(java.lang.String operation,
                    java.lang.Object[] params)

Inverse convert value.

Parameters:

operation - operation name owning the parameter.

params - operation parameters

returnValue - operation return value, if not available null.

getInverseConvertParameterTypes

DataType[] getInverseConvertParameterTypes(java.lang.String operation,
                                           DataType[] 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.