ClassBasedStep (kodexa-java 4.0.56 API)

java.lang.Object
- com.kodexa.client.pipeline.ClassBasedStep

All Implemented Interfaces:: OptionDrivenStep, PipelineStep

public class ClassBasedStep
extends Object
implements PipelineStep, OptionDrivenStep

Constructor Summary

Constructors
Constructor Description

ClassBasedStep(Class stepClass)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getName()`	The name of the pipeline step
`Document`	`process(Document document, PipelineContext context)`	The pipeline will call the process method, passing each document to the step.
`void`	`setOptions(Options options)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClassBasedStep
```
public ClassBasedStep(Class stepClass)
```
- Method Detail
  - process
```
public Document process(Document document,
                        PipelineContext context)
```
    Description copied from interface: PipelineStep
    
    The pipeline will call the process method, passing each document to the step. The step will then perform and actions and can return either the same document or a new document representing its result.
    It can also interact with the context if it wishes to work with the stores or other contextual information.
    
    Specified by:
    
    process in interface PipelineStep
    
    Parameters:
    
    document - The document to process
    
    context - The pipeline's context
    
    Returns:
    
    The document after the steps actions
  - getName
```
public String getName()
```
    Description copied from interface: PipelineStep
    
    The name of the pipeline step
    
    Specified by:
    
    getName in interface PipelineStep
    
    Returns:
    
    a string representing the name
  - setOptions
```
public void setOptions(Options options)
```
    Specified by:
    
    setOptions in interface OptionDrivenStep