org.rubato.rubettes.builtin
Class MacroRubette

java.lang.Object
  extended by org.rubato.base.AbstractRubette
      extended by org.rubato.rubettes.builtin.MacroRubette
All Implemented Interfaces:
Rubette

public class MacroRubette
extends AbstractRubette


Constructor Summary
MacroRubette()
           
 
Method Summary
 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.lang.String getGroup()
          Returns the group this Rubette belongs to.
 javax.swing.ImageIcon getIcon()
          Returns an icon for this Rubette.
 java.lang.String getInfo()
          Returns the info string for the info label.
 java.lang.String getInTip(int i)
          Returns the tooltip for the input connector number i.
 java.lang.String getLongDescription()
          Returns a long description.
 java.lang.String getName()
          Returns the name of the rubette.
 NetworkModel getNetworkModel()
           
 java.lang.String getOutTip(int i)
          Returns the tooltip for the output connector number i.
 java.lang.String getShortDescription()
          Returns a short description.
 boolean hasInfo()
          Returns true iff this Rubette has an info label.
 Rubette newInstance()
          Creates a new instance from a protoype.
 void run(RunInfo runInfo)
          Runs the Rubette.
 void setInfo(java.lang.String s)
           
 void setLongDescription(java.lang.String s)
           
 void setName(java.lang.String s)
           
 void setNetworkModel(NetworkModel model)
           
 void setShortDescription(java.lang.String s)
           
 java.lang.String toString()
           
 void toXML(XMLWriter writer)
          Writes an XML description of this rubette.
 
Methods inherited from class org.rubato.base.AbstractRubette
addError, addError, applyProperties, clearErrors, getErrors, getInCount, getInput, getModel, getOutCount, getOutput, getProperties, getView, hasErrors, hasProperties, hasView, init, revertProperties, setInCount, setModel, setOutCount, setOutput, updateView
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MacroRubette

public MacroRubette()
Method Detail

run

public void run(RunInfo runInfo)
Description copied from class: AbstractRubette
Runs the Rubette. This is the heart of the Rubette and implements the actual computation. Input values are retrieved with the getInput method and output values are stored using the setOutput method. The runInfo parameter object has a method stopped() which should be called regularly, and, in the case it returns false, the run() method should exit gracefully.

Specified by:
run in interface Rubette
Specified by:
run in class AbstractRubette
Parameters:
runInfo - contains information about the Runner that executes the network

setNetworkModel

public void setNetworkModel(NetworkModel model)

getNetworkModel

public NetworkModel getNetworkModel()

getGroup

public java.lang.String getGroup()
Description copied from class: AbstractRubette
Returns the group this Rubette belongs to. The default group is "Other".

Specified by:
getGroup in interface Rubette
Overrides:
getGroup in class AbstractRubette

getName

public java.lang.String getName()
Description copied from class: AbstractRubette
Returns the name of the rubette.

Specified by:
getName in interface Rubette
Specified by:
getName in class AbstractRubette

setName

public void setName(java.lang.String s)

setInfo

public void setInfo(java.lang.String s)

hasInfo

public boolean hasInfo()
Description copied from class: AbstractRubette
Returns true iff this Rubette has an info label. The info label is a short string that is displayed in the JRubette.

Specified by:
hasInfo in interface Rubette
Overrides:
hasInfo in class AbstractRubette

getInfo

public java.lang.String getInfo()
Description copied from class: AbstractRubette
Returns the info string for the info label. If this Rubette has no info label, this simply returns null.

Specified by:
getInfo in interface Rubette
Overrides:
getInfo in class AbstractRubette

newInstance

public Rubette newInstance()
Description copied from class: AbstractRubette
Creates a new instance from a protoype.

Specified by:
newInstance in interface Rubette
Overrides:
newInstance in class AbstractRubette

duplicate

public Rubette duplicate()
Description copied from class: AbstractRubette
Creates a duplicate from this rubette instance. All properties are copied if possible. This must be correctly implemented in order that many functions work as expected.

Specified by:
duplicate in interface Rubette
Specified by:
duplicate in class AbstractRubette

setShortDescription

public void setShortDescription(java.lang.String s)

getShortDescription

public java.lang.String getShortDescription()
Description copied from class: AbstractRubette
Returns a short description. The short description is shown as a tooltip over the JRubette. The default text is the name of the rubette.

Specified by:
getShortDescription in interface Rubette
Overrides:
getShortDescription in class AbstractRubette

getIcon

public javax.swing.ImageIcon getIcon()
Description copied from class: AbstractRubette
Returns an icon for this Rubette.

Specified by:
getIcon in interface Rubette
Overrides:
getIcon in class AbstractRubette

setLongDescription

public void setLongDescription(java.lang.String s)

getLongDescription

public java.lang.String getLongDescription()
Description copied from class: AbstractRubette
Returns a long description. The long description is shown in the text area below the Rubette list, if this Rubette is selected in the list.

Specified by:
getLongDescription in interface Rubette
Overrides:
getLongDescription in class AbstractRubette

getInTip

public java.lang.String getInTip(int i)
Description copied from class: AbstractRubette
Returns the tooltip for the input connector number i.

Specified by:
getInTip in interface Rubette
Overrides:
getInTip in class AbstractRubette

getOutTip

public java.lang.String getOutTip(int i)
Description copied from class: AbstractRubette
Returns the tooltip for the output connector number i.

Specified by:
getOutTip in interface Rubette
Overrides:
getOutTip in class AbstractRubette

toXML

public void toXML(XMLWriter writer)
Description copied from class: AbstractRubette
Writes an XML description of this rubette. This method should write XML for the configuration of this Rubette.

Specified by:
toXML in interface Rubette
Specified by:
toXML in class AbstractRubette

fromXML

public Rubette fromXML(XMLReader reader,
                       org.w3c.dom.Element element)
Description copied from class: AbstractRubette
Creates a rubette from an XML description starting with element.

Specified by:
fromXML in interface Rubette
Specified by:
fromXML in class AbstractRubette

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object