Package org.eclipse.scanning.api.scan.process

Interface IPreprocessor

All Known Implementing Classes:

DefaultScanPreprocessor, ExamplePreprocessor

public interface IPreprocessor

A preprocessor which can make changes to a ScanRequest before it is processed. For example this may transform the scan request according to the particular hardware of a beamline.

Preprocessors can be registered as OSGi services (perhaps in Spring config files, using the OSGiServiceRegister class) and will then be used by the ScanServlet to process scan requests before they are run.

Method Summary

Modifier and Type	Method	Description
String	getName()	Preprocessor name.
ScanRequest	preprocess(ScanRequest req)	Runs the preprocessor on the given ScanRequest.

Method Details

getName

String getName()

Preprocessor name.

Returns:

name

preprocess

ScanRequest preprocess(ScanRequest req)
                throws ProcessingException

Runs the preprocessor on the given ScanRequest. This may modify the ScanRequest in place or return an entirely new ScanRequest object.

Parameters:

req - The request sent by the user interface

Returns:

the processed ScanRequest

Throws:

ProcessingException