gate.jape
Class RightHandSide

java.lang.Object
  |
  +--gate.jape.RightHandSide
All Implemented Interfaces:
JapeConstants, Serializable

public class RightHandSide
extends Object
implements JapeConstants, Serializable

The RHS of a CPSL rule. The action part. Contains an inner class created from the code in the grammar RHS.

See Also:
Serialized Form

Fields inherited from interface gate.jape.JapeConstants
APPELT_STYLE, BRILL_STYLE, DEFAULT_PRIORITY, FIRST_STYLE, INDENT_PADDING, KLEENE_PLUS, KLEENE_QUERY, KLEENE_STAR, MULTI_SPAN_BINDING, NO_BINDING, NO_KLEENE_OP, SINGLE_SPAN_BINDING
 
Constructor Summary
RightHandSide(String transducerName, String ruleName, LeftHandSide lhs)
          Construction from the transducer name, rule name and the LHS.
 
Method Summary
 void addBlock(String anonymousBlock)
          Add an anonymous block to the action class
 void addBlock(String name, String namedBlock)
          Add a named block to the action class
static void cleanUp()
          Remove class files created for actions.
 void compileActionClass()
          Compile the action class.
 void createActionClass()
          Create the action class and an instance of it.
 void defineActionClass()
          Define the action class (after deserialisation).
 String getActionClassString()
          For debugging.
 String getPhaseName()
           
 String getRuleName()
           
 void instantiateActionClass()
          Create an instance of the action class.
 void loadActionClass()
          Load the action class.
 void readActionClass()
          Read action class bytes, for storing during serialisation.
static void setActionClassNumber(int n)
          Allow setting of the initial action class number.
 void setPhaseName(String phaseName)
           
 void setRuleName(String ruleName)
           
 String shortDesc()
          Create a string representation of the object.
 String toString()
          Create a string representation of the object.
 String toString(String pad)
          Create a string representation of the object.
 void transduce(Document doc, AnnotationSet annotations, Map bindings)
          Makes changes to the document, using LHS bindings.
 void writeActionClass()
          Write out the action class file.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RightHandSide

public RightHandSide(String transducerName,
                     String ruleName,
                     LeftHandSide lhs)
Construction from the transducer name, rule name and the LHS.
Method Detail

setActionClassNumber

public static void setActionClassNumber(int n)
Allow setting of the initial action class number. Used for ensuring class name uniqueness when running more than one transducer. The long-term solution is to have separate class loaders for each transducer.

getActionClassString

public String getActionClassString()
For debugging.

addBlock

public void addBlock(String anonymousBlock)
Add an anonymous block to the action class

addBlock

public void addBlock(String name,
                     String namedBlock)
Add a named block to the action class

createActionClass

public void createActionClass()
                       throws JapeException
Create the action class and an instance of it.

writeActionClass

public void writeActionClass()
                      throws JapeException
Write out the action class file.

compileActionClass

public void compileActionClass()
                        throws JapeException
Compile the action class. First tries to use the sun.tools.javac class directly via reflection. If that fails, tries to exec javac as an external process.

readActionClass

public void readActionClass()
                     throws JapeException
Read action class bytes, for storing during serialisation.

loadActionClass

public void loadActionClass()
                     throws JapeException
Load the action class.

defineActionClass

public void defineActionClass()
                       throws JapeException
Define the action class (after deserialisation).

instantiateActionClass

public void instantiateActionClass()
                            throws JapeException
Create an instance of the action class.

cleanUp

public static void cleanUp()
Remove class files created for actions.

transduce

public void transduce(Document doc,
                      AnnotationSet annotations,
                      Map bindings)
               throws JapeException
Makes changes to the document, using LHS bindings.

toString

public String toString()
Create a string representation of the object.
Overrides:
toString in class Object

toString

public String toString(String pad)
Create a string representation of the object.

shortDesc

public String shortDesc()
Create a string representation of the object.

setPhaseName

public void setPhaseName(String phaseName)

getPhaseName

public String getPhaseName()

setRuleName

public void setRuleName(String ruleName)

getRuleName

public String getRuleName()