|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Rubette
Interface for Rubettes. Any implementation of a Rubette should derive AbstractRubette.
AbstractRubette
Method Summary | |
---|---|
void |
addError(java.lang.String msg,
java.lang.Object... objects)
Adds an error string to the current error state. |
boolean |
applyProperties()
Makes changes in the properties dialog permanent. |
void |
clearErrors()
Removes all errors from the error list. |
Rubette |
duplicate()
Creates a duplicate from this rubette instance. |
Rubette |
fromXML(XMLReader reader,
org.w3c.dom.Element element)
Creates a Rubette from an XML description starting with element . |
java.util.List<java.lang.String> |
getErrors()
Returns a list of the current errors. |
java.lang.String |
getGroup()
Returns the group this Rubette belongs to. |
javax.swing.ImageIcon |
getIcon()
Returns an icon for this Rubette. |
int |
getInCount()
Returns the current number of input connectors. |
java.lang.String |
getInfo()
Returns the info string for the info label. |
Denotator |
getInput(int i)
Returns the input denotator at input connector number i . |
java.lang.String |
getInTip(int i)
Returns the tooltip for the input connector number i . |
java.lang.String |
getLongDescription()
Returns a long description. |
RubetteModel |
getModel()
Returns the RubetteModel, that this Rubette is attached to. |
java.lang.String |
getName()
Returns the name of the Rubette. |
int |
getOutCount()
Returns the current number of output connectors. |
Denotator |
getOutput(int i)
Returns the output denotator of connectir number i . |
java.lang.String |
getOutTip(int i)
Returns the tooltip for the output connector number i . |
javax.swing.JComponent |
getProperties()
Returns the Swing component for the properties dialog. |
java.lang.String |
getShortDescription()
Returns a short description. |
javax.swing.JComponent |
getView()
Returns the Swing component for the view. |
boolean |
hasErrors()
Returns true iff any error has occurred. |
boolean |
hasInfo()
Returns true iff this Rubette has an info label. |
boolean |
hasProperties()
Returns true iff this Rubette has a properties dialog. |
boolean |
hasView()
Returns true iff this Rubette has a view. |
void |
init()
Initializes Rubette. |
Rubette |
newInstance()
Creates a new instance from a protoype. |
void |
revertProperties()
Reverts values in the properties dialog to the values in the Rubette. |
void |
run(RunInfo runInfo)
Runs the Rubette. |
void |
setInCount(int n)
Sets the number of input connectors. |
void |
setModel(RubetteModel model)
Sets the model this Rubette is attached to. |
void |
setOutCount(int n)
Sets the number of output connectors. |
void |
setOutput(int i,
Denotator d)
Stores the output denotator d for output connector number i . |
void |
toXML(XMLWriter writer)
Writes an XML description of this rubette. |
void |
updateView()
Updates the view reflecting the changes of the values in the Rubette. |
Method Detail |
---|
void init()
void run(RunInfo runInfo)
runInfo
- contains information about the Runner that executes
the networkjava.lang.String getGroup()
java.lang.String getName()
Rubette newInstance()
Rubette duplicate()
Rubette fromXML(XMLReader reader, org.w3c.dom.Element element)
element
.
void toXML(XMLWriter writer)
javax.swing.ImageIcon getIcon()
boolean hasProperties()
javax.swing.JComponent getProperties()
boolean applyProperties()
void revertProperties()
boolean hasView()
javax.swing.JComponent getView()
void updateView()
boolean hasInfo()
java.lang.String getInfo()
java.lang.String getShortDescription()
java.lang.String getLongDescription()
java.lang.String getInTip(int i)
i
.
java.lang.String getOutTip(int i)
i
.
void setInCount(int n)
int getInCount()
Denotator getInput(int i)
i
.
This is usually called at the beginning of the run() method
to get the input values. The run() method must check the
return value which may be null.
void setOutCount(int n)
int getOutCount()
void setOutput(int i, Denotator d)
d
for output connector number i
.
This is usually called at the end of the run() method to store
the result of the computation.
Denotator getOutput(int i)
i
.
This is usually called by the Runner.
RubetteModel getModel()
void addError(java.lang.String msg, java.lang.Object... objects)
java.util.List<java.lang.String> getErrors()
void clearErrors()
boolean hasErrors()
void setModel(RubetteModel model)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |