Package org.apache.manifoldcf.crawler.system

Class PipelineConnections

java.lang.Object

org.apache.manifoldcf.crawler.system.PipelineConnections

All Implemented Interfaces:

IPipelineConnections, IPipelineSpecificationBasic

public class PipelineConnections
extends java.lang.Object
implements IPipelineConnections

Pipeline connections implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.Integer,java.lang.Integer>	outputConnectionLookupMap
protected java.lang.String[]	outputConnectionNames
protected IOutputConnection[]	outputConnections
protected IPipelineSpecificationBasic	spec
protected java.util.Map<java.lang.Integer,java.lang.Integer>	transformationConnectionLookupMap
protected java.lang.String[]	transformationConnectionNames
protected ITransformationConnection[]	transformationConnections

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

_rcsid

Constructor Summary

Constructors

Constructor	Description
PipelineConnections(IPipelineSpecificationBasic spec, ITransformationConnectionManager transformationConnectionManager, IOutputConnectionManager outputConnectionManager)

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.
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

spec

protected final IPipelineSpecificationBasic spec

transformationConnectionNames

protected final java.lang.String[] transformationConnectionNames

transformationConnections

protected final ITransformationConnection[] transformationConnections

outputConnectionNames

protected final java.lang.String[] outputConnectionNames

outputConnections

protected final IOutputConnection[] outputConnections

transformationConnectionLookupMap

protected final java.util.Map<java.lang.Integer,java.lang.Integer> transformationConnectionLookupMap

outputConnectionLookupMap

protected final java.util.Map<java.lang.Integer,java.lang.Integer> outputConnectionLookupMap

Constructor Detail

PipelineConnections

public PipelineConnections(IPipelineSpecificationBasic spec,
                           ITransformationConnectionManager transformationConnectionManager,
                           IOutputConnectionManager outputConnectionManager)
                    throws ManifoldCFException

Throws:

ManifoldCFException

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()

Description copied from interface: IPipelineConnections

Get the transformation connection names mentioned by the IPipelineSpecification object.

Specified by:

getTransformationConnectionNames in interface IPipelineConnections

getTransformationConnections

public ITransformationConnection[] getTransformationConnections()

Description copied from interface: IPipelineConnections

Get the transformation connection instances mentioned by the IPipelineSpecification object.

Specified by:

getTransformationConnections in interface IPipelineConnections

getOutputConnectionNames

public java.lang.String[] getOutputConnectionNames()

Description copied from interface: IPipelineConnections

Get the output connection names mentioned by the IPipelineSpecification object.

Specified by:

getOutputConnectionNames in interface IPipelineConnections

getOutputConnections

public IOutputConnection[] getOutputConnections()

Description copied from interface: IPipelineConnections

Get the output connection instances mentioned by the IPipelineSpecification object.

Specified by:

getOutputConnections in interface IPipelineConnections

getTransformationConnectionIndex

public java.lang.Integer getTransformationConnectionIndex(int stage)

Description copied from interface: IPipelineConnections

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)

Description copied from interface: IPipelineConnections

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

Specified by:

getOutputConnectionIndex in interface IPipelineConnections