org.rubato.rubettes.builtin
Class ConstructorRubette

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

public class ConstructorRubette
extends AbstractRubette

The Constructor Rubette creates a denotator of the form specified in the properties with coordinates at the input connectors.

Author:
Gérard Milmeister

Constructor Summary
ConstructorRubette()
           
 
Method Summary
 boolean applyProperties()
          Makes changes in the properties dialog permanent.
 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.
 Form getForm()
           
 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.
 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.
 boolean hasInfo()
          Returns true iff this Rubette has an info label.
 boolean hasProperties()
          Returns true iff this rubette has a properties dialog.
 void revertProperties()
          Reverts values in the properties dialog to the values in the Rubette.
 void run(RunInfo runInfo)
          Runs the Rubette.
 boolean setForm(Form form)
           
 void toXML(XMLWriter writer)
          Writes an XML description of this rubette.
 
Methods inherited from class org.rubato.base.AbstractRubette
addError, addError, clearErrors, getErrors, getInCount, getInput, getModel, getOutCount, getOutput, getView, hasErrors, hasView, init, newInstance, setInCount, setModel, setOutCount, setOutput, updateView
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConstructorRubette

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

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

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

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

hasProperties

public boolean hasProperties()
Description copied from class: AbstractRubette
Returns true iff this rubette has a properties dialog. Properties reflect the configuration of this Rubette, any changes in the properties dialog may affect the computation.

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

getProperties

public javax.swing.JComponent getProperties()
Description copied from class: AbstractRubette
Returns the Swing component for the properties dialog. If this rubette has no properties dialog, simply return null.

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

applyProperties

public boolean applyProperties()
Description copied from class: AbstractRubette
Makes changes in the properties dialog permanent.

Specified by:
applyProperties in interface Rubette
Overrides:
applyProperties in class AbstractRubette
Returns:
true iff the values in the properties dialog are correct

revertProperties

public void revertProperties()
Description copied from class: AbstractRubette
Reverts values in the properties dialog to the values in the Rubette.

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

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

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

setForm

public boolean setForm(Form form)

getForm

public Form getForm()

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