Package org.eclipse.scanning.server.servlet

Class DefaultScanPreprocessor

java.lang.Object

org.eclipse.scanning.server.servlet.DefaultScanPreprocessor

All Implemented Interfaces:

IPreprocessor

public class DefaultScanPreprocessor
extends Object
implements IPreprocessor

This pre-processor merges the monitors defined in its DefaultScanConfiguration into a ScanRequest.

Constructor Summary

Constructors

Constructor	Description
DefaultScanPreprocessor()

Method Summary

Modifier and Type	Method	Description
DefaultScanConfiguration	getDefaultScanConfiguration()
String	getName()	Preprocessor name.
ScanRequest	preprocess(ScanRequest scanRequest)	Runs the preprocessor on the given ScanRequest.
void	setDefaultScanConfiguration(DefaultScanConfiguration defaultScanConfiguration)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultScanPreprocessor

public DefaultScanPreprocessor()

Method Details

getName

public String getName()

Description copied from interface: IPreprocessor

Preprocessor name.

Specified by:

getName in interface IPreprocessor

Returns:

name

getDefaultScanConfiguration

public DefaultScanConfiguration getDefaultScanConfiguration()

setDefaultScanConfiguration

public void setDefaultScanConfiguration(DefaultScanConfiguration defaultScanConfiguration)

preprocess

public ScanRequest preprocess(ScanRequest scanRequest)
                       throws ProcessingException

Description copied from interface: IPreprocessor

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

Specified by:

preprocess in interface IPreprocessor

Parameters:

scanRequest - The request sent by the user interface

Returns:

the processed ScanRequest

Throws:

ProcessingException