org.rubato.rubettes.score
Class LilyPondOutRubette

java.lang.Object
  extended by org.rubato.base.AbstractRubette
      extended by org.rubato.base.SimpleAbstractRubette
          extended by org.rubato.rubettes.score.LilyPondOutRubette
All Implemented Interfaces:
Rubette

public class LilyPondOutRubette
extends SimpleAbstractRubette

A rubette that converts a Score denotator to LilyPond code and writes it to a file

Author:
Florian Thalmann

Constructor Summary
LilyPondOutRubette()
          Creates a basic LilyPondOutRubette.
 
Method Summary
 boolean applyProperties()
          Makes changes in the properties dialog permanent.
 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 getShortDescription()
          Returns a short description.
 boolean hasInfo()
          Returns true iff this Rubette has an info label.
 void run(RunInfo runInfo)
          Runs the Rubette.
 
Methods inherited from class org.rubato.base.SimpleAbstractRubette
duplicate, fromXML, getProperties, getProperty, getRubetteProperties, hasProperties, putProperty, revertProperties, toXML
 
Methods inherited from class org.rubato.base.AbstractRubette
addError, addError, clearErrors, getErrors, getInCount, getInput, getModel, getOutCount, getOutput, getOutTip, 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

LilyPondOutRubette

public LilyPondOutRubette()
Creates a basic LilyPondOutRubette.

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

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 SimpleAbstractRubette
Returns:
true iff the values in the properties dialog are correct

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

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

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