org.esa.beam.framework.processor
Interface RequestElementFactory

All Known Implementing Classes:

DefaultRequestElementFactory

public interface RequestElementFactory

The factory for the elements of a processing request. A RequestElementFactory allows a particular processor implementation to influence the process of generating request elements with a RequestLoader.

Version:

$Revision$ $Date$

Author:

Norman Fomferra

See Also:

RequestLoader, Request

Method Summary

Parameter	createDefaultInputProductParameter() Creates a parameter for the default input product path - which is the current user's home directory.
Parameter	createDefaultLogPatternParameter(String prefix) Creates a default logging pattern parameter set to the prefix passed in.
Parameter	createDefaultOutputProductParameter() Creates an output product parameter set to the default path.
ProductRef	createInputProductRef(File file, String fileFormat, String typeId) Creates a new reference to an input product for the current processing request.
Parameter	createLogToOutputParameter(String value) Creates a logging to output product parameter set to true.
ProductRef	createOutputProductRef(File file, String fileFormat, String typeId) Creates a new reference to an output product for the current processing request.
Parameter	createParameter(String name, String value) Creates a new processing parameter for the current processing request.

Method Detail

createInputProductRef

ProductRef createInputProductRef(File file,
                                 String fileFormat,
                                 String typeId)
                                 throws RequestElementFactoryException

Creates a new reference to an input product for the current processing request.

Parameters:

file - the input product's file, must not be null

fileFormat - the file format, can be null if not known

typeId - the product type identifier, can be null if not known

Throws:

IllegalArgumentException - if url is null

RequestElementFactoryException - if the element could not be created

createOutputProductRef

ProductRef createOutputProductRef(File file,
                                  String fileFormat,
                                  String typeId)
                                  throws RequestElementFactoryException

Creates a new reference to an output product for the current processing request.

Parameters:

file - the output product's file, must not be null

fileFormat - the file format, can be null if not known

typeId - the product type identifier, can be null if not known

Throws:

IllegalArgumentException - if url is null

RequestElementFactoryException - if the element could not be created

createParameter

Parameter createParameter(String name,
                          String value)
                          throws RequestElementFactoryException

Creates a new processing parameter for the current processing request.

Parameters:

name - the parameter name, must not be null or empty

value - the parameter value, can be null if yet not known

Throws:

IllegalArgumentException - if name is null or empty

RequestElementFactoryException - if the parameter could not be created or is invalid

createDefaultInputProductParameter

Parameter createDefaultInputProductParameter()

Creates a parameter for the default input product path - which is the current user's home directory.

createDefaultOutputProductParameter

Parameter createDefaultOutputProductParameter()

Creates an output product parameter set to the default path.

createDefaultLogPatternParameter

Parameter createDefaultLogPatternParameter(String prefix)

Creates a default logging pattern parameter set to the prefix passed in.

Parameters:

prefix - the default setting for the logging pattern

Returns:

a logging pattern Parameter conforming the system settings

createLogToOutputParameter

Parameter createLogToOutputParameter(String value)
                                     throws ParamValidateException

Creates a logging to output product parameter set to true.

Returns:

the created logging to output product parameter.

Throws:

ParamValidateException