Package org.apache.manifoldcf.crawler.system

Class PipelineSpecification

java.lang.Object

org.apache.manifoldcf.crawler.system.PipelineSpecification

All Implemented Interfaces:

IPipelineConnections, IPipelineSpecification, IPipelineSpecificationBasic

public class PipelineSpecification
extends java.lang.Object
implements IPipelineSpecification

Class which handles pipeline specifications that include current (new) description strings.

Field Summary

Fields

Modifier and Type	Field	Description
protected IPipelineConnections	connections
protected VersionContext[]	pipelineDescriptionStrings

Fields inherited from interface org.apache.manifoldcf.agents.interfaces.IPipelineSpecification

_rcsid

Constructor Summary

Constructors

Constructor	Description
PipelineSpecification(IPipelineConnections connections, IJobDescription job, IIncrementalIngester ingester)

Method Summary

Modifier and Type	Method	Description
boolean	checkStageOutputConnection(int stage)	Check if a stage is an output stage.
java.lang.Integer	getOutputConnectionIndex(int stage)	Get the index of the output connection corresponding to a specific pipeline stage.
java.lang.String[]	getOutputConnectionNames()	Get the output connection names mentioned by the IPipelineSpecification object.
IOutputConnection[]	getOutputConnections()	Get the output connection instances mentioned by the IPipelineSpecification object.
int	getOutputCount()	Return the number of output connections.
int	getOutputStage(int index)	Given an output index, return the stage number for that output.
int[]	getStageChildren(int stage)	Find children of a given pipeline stage.
java.lang.String	getStageConnectionName(int stage)	Get the connection name for a pipeline stage.
int	getStageCount()	Get a count of all stages.
VersionContext	getStageDescriptionString(int stage)	Get the description string for a pipeline stage.
int	getStageParent(int stage)	Find parent of a given pipeline stage.
java.lang.Integer	getTransformationConnectionIndex(int stage)	Get the index of the transformation connection corresponding to a specific pipeline stage.
java.lang.String[]	getTransformationConnectionNames()	Get the transformation connection names mentioned by the IPipelineSpecification object.
ITransformationConnection[]	getTransformationConnections()	Get the transformation connection instances mentioned by the IPipelineSpecification object.

Methods inherited from class java.lang.Object

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

Field Detail

connections

protected final IPipelineConnections connections

pipelineDescriptionStrings

protected final VersionContext[] pipelineDescriptionStrings

Constructor Detail

PipelineSpecification

public PipelineSpecification(IPipelineConnections connections,
                             IJobDescription job,
                             IIncrementalIngester ingester)
                      throws ManifoldCFException,
                             ServiceInterruption

Throws:

ManifoldCFException

ServiceInterruption

Method Detail

getStageCount

public int getStageCount()

Get a count of all stages.

Specified by:

getStageCount in interface IPipelineSpecificationBasic

Returns:

the total count of all stages.

getStageChildren

public int[] getStageChildren(int stage)

Find children of a given pipeline stage. Pass -1 to find the children of the root stage.

Specified by:

getStageChildren in interface IPipelineSpecificationBasic

Parameters:

stage - is the stage index to get the children of.

Returns:

the pipeline stages that represent those children.

getStageParent

public int getStageParent(int stage)

Find parent of a given pipeline stage. Returns -1 if there's no parent (it's the root).

Specified by:

getStageParent in interface IPipelineSpecificationBasic

Parameters:

stage - is the stage index to get the parent of.

Returns:

the pipeline stage that is the parent, or -1.

getStageConnectionName

public java.lang.String getStageConnectionName(int stage)

Get the connection name for a pipeline stage.

Specified by:

getStageConnectionName in interface IPipelineSpecificationBasic

Parameters:

stage - is the stage to get the connection name for.

Returns:

the connection name for that stage.

checkStageOutputConnection

public boolean checkStageOutputConnection(int stage)

Check if a stage is an output stage.

Specified by:

checkStageOutputConnection in interface IPipelineSpecificationBasic

Parameters:

stage - is the stage to check.

Returns:

true if the stage represents an output connection.

getOutputCount

public int getOutputCount()

Return the number of output connections.

Specified by:

getOutputCount in interface IPipelineSpecificationBasic

Returns:

the total number of output connections in this specification.

getOutputStage

public int getOutputStage(int index)

Given an output index, return the stage number for that output.

Specified by:

getOutputStage in interface IPipelineSpecificationBasic

Parameters:

index - is the output connection index.

Returns:

the stage number.

getTransformationConnectionNames

public java.lang.String[] getTransformationConnectionNames()

Get the transformation connection names mentioned by the IPipelineSpecification object.

Specified by:

getTransformationConnectionNames in interface IPipelineConnections

getTransformationConnections

public ITransformationConnection[] getTransformationConnections()

Get the transformation connection instances mentioned by the IPipelineSpecification object.

Specified by:

getTransformationConnections in interface IPipelineConnections

getOutputConnectionNames

public java.lang.String[] getOutputConnectionNames()

Get the output connection names mentioned by the IPipelineSpecification object.

Specified by:

getOutputConnectionNames in interface IPipelineConnections

getOutputConnections

public IOutputConnection[] getOutputConnections()

Get the output connection instances mentioned by the IPipelineSpecification object.

Specified by:

getOutputConnections in interface IPipelineConnections

getTransformationConnectionIndex

public java.lang.Integer getTransformationConnectionIndex(int stage)

Get the index of the transformation connection corresponding to a specific pipeline stage.

Specified by:

getTransformationConnectionIndex in interface IPipelineConnections

getOutputConnectionIndex

public java.lang.Integer getOutputConnectionIndex(int stage)

Get the index of the output connection corresponding to a specific pipeline stage.

Specified by:

getOutputConnectionIndex in interface IPipelineConnections

getStageDescriptionString

public VersionContext getStageDescriptionString(int stage)

Get the description string for a pipeline stage.

Specified by:

getStageDescriptionString in interface IPipelineSpecification

Parameters:

stage - is the stage to get the connection name for.

Returns:

the description string that stage.