com.exalead.mercury.mami.connect.v10

Class PipelineBranch

java.lang.Object

com.exalead.mercury.mami.connect.v10.BranchAction

com.exalead.mercury.mami.connect.v10.PipelineBranch

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

BasicPipelineBranch, MultithreadedDispatchBranch

public abstract class PipelineBranch
extends BranchAction
implements com.exalead.util.Checkable, java.io.Serializable

A graph of processing actions. It has one input and one output.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	autolink
java.util.List<BranchAction>	branchAction
static boolean	DEFAULT_AUTOLINK
java.lang.String	input
java.lang.String	output
java.util.List<PipelineLink>	pipelineLink

Fields inherited from class com.exalead.mercury.mami.connect.v10.BranchAction

name

Constructor Summary

Constructors

Constructor and Description
PipelineBranch()
PipelineBranch(PipelineBranch o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this PipelineBranch.
static PipelineBranch	fromString(java.lang.String s) String representation of this PipelineBranch.
java.util.List<BranchAction>	getBranchAction() Actions in the branch
java.util.Map<java.lang.String,BranchAction>	getBranchActionAsMap() Get the map of BranchAction, indexed by name
BranchAction	getBranchActionByName(java.lang.String _lookup) Get the BranchAction for which the name matches _lookup
java.lang.String	getInput() Name of the BranchAction used as input (with the processors'input if it is a Process action)
java.lang.String	getOutput() Name of the BranchAction used as input (with the processors'input if it is a Process action)
java.util.List<PipelineLink>	getPipelineLink() Links between actions
boolean	isAutolink() Links automatically successive BranchActions on their first input and output when they have no explicit link.
PipelineBranch	makeCopy()
static PipelineBranch	readFrom(java.io.InputStream is) Read this PipelineBranch from an XML fragment.
boolean	removeBranchActionByName(java.lang.String _lookup) Removes the BranchAction for which the name matches _lookup
void	setAutolink(boolean autolink) Links automatically successive BranchActions on their first input and output when they have no explicit link.
void	setInput(java.lang.String input) Name of the BranchAction used as input (with the processors'input if it is a Process action)
void	setOutput(java.lang.String output) Name of the BranchAction used as input (with the processors'input if it is a Process action)
java.lang.String	toString() String representation of this PipelineBranch.
PipelineBranch	withAutolink(boolean autolink)
PipelineBranch	withAutolink(java.lang.Boolean autolink)
PipelineBranch	withBranchAction(BranchAction... __values) Actions in the branch
PipelineBranch	withBranchAction(java.util.Collection<BranchAction> __values)
PipelineBranch	withInput(java.lang.String input)
PipelineBranch	withName(java.lang.String name)
PipelineBranch	withOutput(java.lang.String output)
PipelineBranch	withPipelineLink(java.util.Collection<PipelineLink> __values)
PipelineBranch	withPipelineLink(PipelineLink... __values) Links between actions
void	writeTo(java.io.OutputStream os)

Methods inherited from class com.exalead.mercury.mami.connect.v10.BranchAction

getName, setName

Methods inherited from class java.lang.Object

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

Field Detail

branchAction

public java.util.List<BranchAction> branchAction

pipelineLink

public java.util.List<PipelineLink> pipelineLink

input

public java.lang.String input

output

public java.lang.String output

autolink

public boolean autolink

DEFAULT_AUTOLINK

public static final boolean DEFAULT_AUTOLINK

See Also:

Constant Field Values

Constructor Detail

PipelineBranch

public PipelineBranch()

PipelineBranch

public PipelineBranch(PipelineBranch o)

Copy constructor

Method Detail

withName

public PipelineBranch withName(java.lang.String name)

Overrides:

withName in class BranchAction

getBranchAction

public java.util.List<BranchAction> getBranchAction()

Actions in the branch

getBranchActionByName

public BranchAction getBranchActionByName(java.lang.String _lookup)

Get the BranchAction for which the name matches _lookup

Returns:

null if no matching BranchAction is found

getBranchActionAsMap

public java.util.Map<java.lang.String,BranchAction> getBranchActionAsMap()

Get the map of BranchAction, indexed by name

removeBranchActionByName

public boolean removeBranchActionByName(java.lang.String _lookup)

Removes the BranchAction for which the name matches _lookup

Returns:

false if no matching BranchAction is found, true if one was found

withBranchAction

public PipelineBranch withBranchAction(BranchAction... __values)

Actions in the branch

withBranchAction

public PipelineBranch withBranchAction(java.util.Collection<BranchAction> __values)

getPipelineLink

public java.util.List<PipelineLink> getPipelineLink()

Links between actions

withPipelineLink

public PipelineBranch withPipelineLink(PipelineLink... __values)

Links between actions

withPipelineLink

public PipelineBranch withPipelineLink(java.util.Collection<PipelineLink> __values)

setInput

public void setInput(java.lang.String input)

Name of the BranchAction used as input (with the processors'input if it is a Process action)

getInput

public java.lang.String getInput()

Name of the BranchAction used as input (with the processors'input if it is a Process action)

withInput

public PipelineBranch withInput(java.lang.String input)

setOutput

public void setOutput(java.lang.String output)

Name of the BranchAction used as input (with the processors'input if it is a Process action)

getOutput

public java.lang.String getOutput()

Name of the BranchAction used as input (with the processors'input if it is a Process action)

withOutput

public PipelineBranch withOutput(java.lang.String output)

setAutolink

public void setAutolink(boolean autolink)

Links automatically successive BranchActions on their first input and output when they have no explicit link.

isAutolink

public boolean isAutolink()

Links automatically successive BranchActions on their first input and output when they have no explicit link.

withAutolink

public PipelineBranch withAutolink(boolean autolink)

withAutolink

public PipelineBranch withAutolink(java.lang.Boolean autolink)

makeCopy

public PipelineBranch makeCopy()

Overrides:

makeCopy in class BranchAction

readFrom

public static PipelineBranch readFrom(java.io.InputStream is)
                               throws javax.xml.bind.JAXBException

Read this PipelineBranch from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Overrides:

writeTo in class BranchAction

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static PipelineBranch fromString(java.lang.String s)
                                 throws javax.xml.bind.JAXBException,
                                        java.io.UnsupportedEncodingException

String representation of this PipelineBranch.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PipelineBranch.

Overrides:

toString in class BranchAction

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this PipelineBranch.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BranchAction

Throws:

com.exalead.util.TypedException