org.apache.manifoldcf.agents.interfaces

Interface IPipelineSpecificationBasic

All Known Subinterfaces:

IPipelineConnections, IPipelineSpecification, IPipelineSpecificationWithVersions

All Known Implementing Classes:

PipelineConnections, PipelineSpecification, PipelineSpecificationBasic, PipelineSpecificationWithVersions

public interface IPipelineSpecificationBasic

This interface describes a multi-output pipeline. Each stage of the pipeline is given a rank number, and dependencies between stages refer to that rank number.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid

Method Summary

Modifier and Type	Method and Description
boolean	checkStageOutputConnection(int stage) Check if a stage is an output stage.
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.
int	getStageParent(int stage) Find parent of a given pipeline stage.

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

getStageCount

int getStageCount()

Get a count of all stages.

Returns:

the total count of all stages.

getStageChildren

int[] getStageChildren(int stage)

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

Parameters:

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

Returns:

the pipeline stages that represent those children.

getStageParent

int getStageParent(int stage)

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

Parameters:

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

Returns:

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

getStageConnectionName

java.lang.String getStageConnectionName(int stage)

Get the connection name for a pipeline stage.

Parameters:

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

Returns:

the connection name for that stage.

checkStageOutputConnection

boolean checkStageOutputConnection(int stage)

Check if a stage is an output stage.

Parameters:

stage - is the stage to check.

Returns:

true if the stage represents an output connection.

getOutputCount

int getOutputCount()

Return the number of output connections.

Returns:

the total number of output connections in this specification.

getOutputStage

int getOutputStage(int index)

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

Parameters:

index - is the output connection index.

Returns:

the stage number.