PlanImpl.Builder (ingest 1.0.0 API)

java.lang.Object
- org.jesterj.ingest.model.impl.NamedBuilder<Plan>
- - org.jesterj.ingest.model.impl.PlanImpl.Builder

All Implemented Interfaces:

Buildable<Plan>, ConfiguredBuildable<Plan>

Enclosing class:

PlanImpl
```
public static class PlanImpl.Builder
extends NamedBuilder<Plan>
```

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PlanImpl.Builder`	`addStep(StepImpl.Builder step, java.lang.String... predecessors)`	Add a step to the plan.
`Plan`	`build()`
`protected PlanImpl`	`getObj()`
`PlanImpl.Builder`	`named(java.lang.String name)`
`PlanImpl.Builder`	`withIdField(java.lang.String id)`
`PlanImpl.Builder`	`withVersion(int version)`

Methods inherited from class org.jesterj.ingest.model.impl.NamedBuilder
isValid

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - addStep
```
public PlanImpl.Builder addStep(StepImpl.Builder step,
                                java.lang.String... predecessors)
```
    Add a step to the plan. Will automatically append the supplied step to the specified predecessor step. If a step is added twice with different predecessors this represents a node that coalesces two paths in the DAG. If more than one step exists for the same predecessor this represents a fork in the DAG. Steps never know from whence a document was handed to them.
    
    Parameters:
    
    step - the step to add, must not be null
    
    predecessors - the stepsMap that this step should follow. If null, step must build a scanner. The step must have a step name that is unique.
    
    Returns:
    
    this builder object for chaining
  - build
```
public Plan build()
```
  - named
```
public PlanImpl.Builder named(java.lang.String name)
```
    Specified by:
    
    named in class NamedBuilder<Plan>
  - withVersion
```
public PlanImpl.Builder withVersion(int version)
```
  - getObj
```
protected PlanImpl getObj()
```
    Overrides:
    
    getObj in class NamedBuilder<Plan>
  - withIdField
```
public PlanImpl.Builder withIdField(java.lang.String id)
```