sapphire.ext

Class BaseInstrumentProvider

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.ext.BaseInstrumentProvider

public class BaseInstrumentProvider
extends com.labvantage.sapphire.BaseCustom

BaseInstrumentProvider class is the default implementation of the Instrument Protocol Provider. Custom implementation for an instrument model can override the executeCommand method, or parseResponse method or both.

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseCustom

FAILURE, logger, logName, SUCCESS

Constructor Summary

Constructors

Constructor and Description
BaseInstrumentProvider()

Method Summary

Modifier and Type	Method and Description
void	cancelCommand(PropertyList commandProps) override this method to allow cancel a command, especially when response is pushed from instrument.
java.lang.String	executeCommand(PropertyList commandProps) override this method to customize communicating with the instrument for push response type, returning empty string meaning result is not ready, checkResponse will be called repeatedly until a none empty response returned.
java.util.HashMap	parseResponse(java.lang.String responseStr, PropertyList commandProps) override this method to customize parsing instrument response string into name value pairs

Methods inherited from class com.labvantage.sapphire.BaseCustom

getAccessorErrorIds, getAccessorErrorMsgs, getActionProcessor, getConfigurationProcessor, getConnectionid, getConnectionId, getConnectionProcessor, getDAMProcessor, getDepartmentList, getHttpProcessor, getQueryProcessor, getRakFile, getSDCProcessor, getSDIProcessor, getSequenceProcessor, getTranslationProcessor, setConnectionId, setLanguage, setRakFile

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseInstrumentProvider

public BaseInstrumentProvider()

Method Detail

executeCommand

public java.lang.String executeCommand(PropertyList commandProps)
                                throws java.lang.Exception

override this method to customize communicating with the instrument for push response type, returning empty string meaning result is not ready, checkResponse will be called repeatedly until a none empty response returned. It is up to the implementation to determine whether to alway wait

Parameters:

commandProps -

Returns:

response

Throws:

java.lang.Exception

parseResponse

public java.util.HashMap parseResponse(java.lang.String responseStr,
                                       PropertyList commandProps)
                                throws java.lang.Exception

override this method to customize parsing instrument response string into name value pairs

Parameters:

responseStr -

commandProps -

Throws:

java.lang.Exception

cancelCommand

public void cancelCommand(PropertyList commandProps)

override this method to allow cancel a command, especially when response is pushed from instrument.

Parameters:

commandProps -