org.geomajas.service.pipeline

Interface PipelineService<RESPONSE>

Type Parameters:

RESPONSE - type of response object for the pipeline

@Api(allMethods=true)
public interface PipelineService<RESPONSE>

Service which is allows "executing" a pipeline.

Since:

1.6.0

Author:

Joachim Van der Auwera

Method Summary

Methods

Modifier and Type	Method and Description
PipelineContext	createContext() Get a new pipeline context.
void	execute(PipelineInfo<RESPONSE> pipeline, PipelineContext context, RESPONSE response) Execute the pipeline, starting with a known context.
void	execute(String key, String layerId, PipelineContext context, RESPONSE response) Execute the pipeline, starting with a known context.
PipelineInfo<RESPONSE>	getPipeline(String key, String layerId) Get a pipeline configuration based on the key and optional layer id.

Method Detail

execute

void execute(PipelineInfo<RESPONSE> pipeline,
           PipelineContext context,
           RESPONSE response)
             throws GeomajasException

Execute the pipeline, starting with a known context.

Parameters:

pipeline - pipeline steps / configuration

context - known context (can be null if there are no parameters for the pipeline)

response - response object which is filled by the pipeline

Throws:

GeomajasException - any exception which may have been throws during the execution

execute

void execute(String key,
           String layerId,
           PipelineContext context,
           RESPONSE response)
             throws GeomajasException

Execute the pipeline, starting with a known context.

Parameters:

key - key for the pipeline

layerId - layer if

context - known context (can be null if there are no parameters for the pipeline)

response - response object which is filled by the pipeline

Throws:

GeomajasException - any exception which may have been throws during the execution

getPipeline

PipelineInfo<RESPONSE> getPipeline(String key,
                                 String layerId)
                                   throws GeomajasException

Get a pipeline configuration based on the key and optional layer id.

This will attempt to get the layer specific pipeline and if that does not exist, it will use the general pipeline. The layer specific pipeline is assumed to have bean name key + "." + layerId.

Parameters:

key - key for the pipeline

layerId - layer if

Returns:

pipeline configuration

Throws:

GeomajasException - when pipeline info not found

createContext

PipelineContext createContext()

Get a new pipeline context.

Returns:

new pipeline context