|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcz.cuni.jagrlib.BasicPlug
public class BasicPlug
Basic Plug
implementation - can be used for internal Plug
s -
inside executed Composition.
Plug
,
Piece
,
Channel
Field Summary | |
---|---|
protected boolean |
cloneable
Is that Plug cloneable (=generic)? |
protected java.lang.String |
inputInterface
Fully qualified input interface name (implemented interface). |
protected java.lang.String |
key
Key string used in associated Template . |
protected boolean |
mandatory
Is that Plug mandatory? |
protected boolean |
multi
Can that Plug be used in multi-channels? |
protected java.lang.String |
outputInterface
Fully qualified output interface name (required interface). |
protected Template |
template
Associated Template . |
Constructor Summary | |
---|---|
BasicPlug(boolean _mandatory,
boolean _multi,
boolean _cloneable,
java.lang.String _inputInterface,
java.lang.String _outputInterface,
Template _template,
java.lang.String _key)
Assign constructor - initializes a new BasicPlug object. |
Method Summary | |
---|---|
void |
connectChannel(Channel channel)
Connects the Channel in the associated Piece . |
boolean |
disconnectChannel()
Disconnects the associated channel. |
java.lang.Object |
getInputInterface()
Returns the internal (implemented) interface object - to be called from outside. |
java.lang.String |
getInputInterfaceName()
Returns the fully-qualified name of an internal (implemented) interface - to be called from outside. |
java.lang.String |
getKey()
Gets the access key from associated Template to this Plug . |
java.lang.String |
getOutputInterfaceName()
Returns the fully-qualified name of an external (required) interface - to be called from this Piece . |
Piece |
getPiece()
Gets the associated Piece . |
Template |
getTemplate()
Gets the associated Template . |
boolean |
isCloneable()
Can this Plug be cloned? |
boolean |
isCompatible(Plug pl)
Compatibility test: Am I compatible with the given Plug ? |
boolean |
isCompatible(java.lang.String iInterface,
java.lang.String oInterface,
boolean cl,
boolean mul)
Compatibility test: Am I compatible with the given parameters? |
boolean |
isInput()
Has this Plug the input capability (can be called from outside)? |
boolean |
isMandatory()
Is this Plug mandatory? |
boolean |
isMulti()
Can this Plug be used in multi-channels? |
boolean |
isOpposite(Plug opposite)
Compatibility test: Am I compatible with the opposite Plug ? |
boolean |
isOutput()
Has this Plug the output capability (can call other interfaces)? |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected boolean mandatory
Plug
mandatory?
protected boolean multi
Plug
be used in multi-channels?
Channel
protected boolean cloneable
Plug
cloneable (=generic)?
key
protected java.lang.String inputInterface
protected java.lang.String outputInterface
protected Template template
Template
.
key
protected java.lang.String key
Template
.
template
Constructor Detail |
---|
public BasicPlug(boolean _mandatory, boolean _multi, boolean _cloneable, java.lang.String _inputInterface, java.lang.String _outputInterface, Template _template, java.lang.String _key)
_mandatory
- Is that plug mandatory (has to be connected)?_multi
- Can that plug be used in multi-channels?_cloneable
- Is that plug "cloneable" (=generic)? If yes,
ordinal numbers (starting from 0) will be appended to its name._inputInterface
- Fully qualified identifier of input (implemented)
interface._outputInterface
- Fully qualified identifier of output (required)
interface._template
- Template
this plug is to be associated with._key
- Key used in associated Template
.Method Detail |
---|
public boolean isInput()
Plug
the input capability (can be called from outside)?
isInput
in interface Plug
Plug
can be called from outside.getInputInterfaceName()
,
getInputInterface()
public boolean isOutput()
Plug
the output capability (can call other interfaces)?
isOutput
in interface Plug
Plug
can call other interfaces.getOutputInterfaceName()
public boolean isMandatory()
Plug
mandatory?
isMandatory
in interface Plug
Plug
is mandatory (has to be
connected).public boolean isMulti()
Plug
be used in multi-channels?
isMulti
in interface Plug
Plug
can be connected to multi-channel.public boolean isCloneable()
Plug
be cloned? For filters with variable number of (input)
channels.
isCloneable
in interface Plug
Plug
can be cloned.getKey()
public java.lang.String getInputInterfaceName()
getInputInterfaceName
in interface Plug
isInput()
public java.lang.String getOutputInterfaceName()
Piece
.
getOutputInterfaceName
in interface Plug
isOutput()
public java.lang.Object getInputInterface()
getInputInterface
in interface Plug
public Template getTemplate()
Template
.
For topological purposes only.
getTemplate
in interface Plug
Template
or null.getKey()
public Piece getPiece()
Piece
.
For topological purposes only.
getPiece
in interface Plug
Piece
or null.getKey()
public java.lang.String getKey()
key
from associated Template
to this Plug
.
For topological purposes only.
getKey
in interface Plug
getTemplate()
public boolean isCompatible(java.lang.String iInterface, java.lang.String oInterface, boolean cl, boolean mul)
isCompatible
in interface Plug
iInterface
- Required input interface (or null).oInterface
- Required output interface (or null).cl
- Is the cloneability required?.mul
- Is the multi-channel property required?.
public boolean isCompatible(Plug pl)
Plug
?
isCompatible
in interface Plug
pl
- The checked Plug
.
Plug
.public boolean isOpposite(Plug opposite)
Plug
?
isOpposite
in interface Plug
opposite
- The opposite Plug
.
Plug
.public void connectChannel(Channel channel)
Channel
in the associated Piece
.
connectChannel
in interface Plug
channel
- The Channel
to be connected to this Plug
.public boolean disconnectChannel()
disconnectChannel
in interface Plug
Channel
connected.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |