INRIA & FluxMedia

fr.fluxmedia.transmorpher.graph
Class ApplyRuleset

java.lang.Object
  extended by java.util.Observable
      extended by fr.fluxmedia.transmorpher.graph.CallImpl
          extended by fr.fluxmedia.transmorpher.graph.ApplyImpl
              extended by fr.fluxmedia.transmorpher.graph.ApplyRuleset
All Implemented Interfaces:
Call, java.io.Serializable

public class ApplyRuleset
extends ApplyImpl

The ApplyRuleset Class introduces the use of a ruleset in a process body. Its structure is the following:
<apply-ruleset type="type" ref="name" id="id" in="channel">
{<with-param>}
</apply-ruleset>

Since:
jdk 1.3 / SAX 2.0
Author:
Jerome.Euzenat@inrialpes.fr
See Also:
Serialized Form

Field Summary
 
Fields inherited from class fr.fluxmedia.transmorpher.graph.CallImpl
attributes, id, inPorts, nullified, outPorts, parameters, process, visited
 
Constructor Summary
ApplyRuleset()
          Creates a simple instance of ApplyRuleset
ApplyRuleset(java.lang.String id, java.lang.String type)
          Creates an instance of ApplyRuleset with an id and a type
ApplyRuleset(java.lang.String id, java.lang.String type, Process process)
          Creates an instance of ApplyRuleset with an id, a type, a process
ApplyRuleset(java.lang.String id, java.lang.String type, Process process, java.lang.String reference)
          Creates an instance of ApplyRuleset with an id , a type, a process and a reference
ApplyRuleset(java.lang.String id, java.lang.String type, Process process, java.lang.String reference, java.lang.String strategy)
          Creates an instance of ApplyRuleset with an id , a type, a process, a reference and a strategy
 
Method Summary
 void createProcess(TProcessComposite currentProcess)
          Creates a TApplyRuleset corresponding to this ApplyRulset object and adds it to the composite process in the execution structure.
 void generateJavaCode(Writer file)
          Prints a java code description of this ApplyQuery instance
 void generateXML()
          Prints an XML description of this ApplyRuleset instance
 java.lang.String getStrategy()
          Gets the strategy attribute of the ApplyRuleset object
 void retroNull(PortList out, PortList in)
          Propagate the nullify of its sole output to all the input.
 void setStrategy(java.lang.String strategy)
          Sets the strategy attribute of the ApplyRuleset object
 void setUp()
          Description of the Method
 
Methods inherited from class fr.fluxmedia.transmorpher.graph.ApplyImpl
getRef, setRef
 
Methods inherited from class fr.fluxmedia.transmorpher.graph.CallImpl
addIn, addIn, addOut, addOut, clearNull, clearVisited, generateParameters, generatePorts, getAttributes, getId, getParameters, getProcess, getType, inPorts, newProcess, outPorts, retroNull, setId, setParameters, setType, toString, update
 
Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ApplyRuleset

public ApplyRuleset()
Creates a simple instance of ApplyRuleset


ApplyRuleset

public ApplyRuleset(java.lang.String id,
                    java.lang.String type)
Creates an instance of ApplyRuleset with an id and a type

Parameters:
id - The id of the instance to create
type - The type of the instance to create

ApplyRuleset

public ApplyRuleset(java.lang.String id,
                    java.lang.String type,
                    Process process)
Creates an instance of ApplyRuleset with an id, a type, a process

Parameters:
id - The id of the instance to create
type - The type of the instance to create
process - The process that owns this instance

ApplyRuleset

public ApplyRuleset(java.lang.String id,
                    java.lang.String type,
                    Process process,
                    java.lang.String reference)
Creates an instance of ApplyRuleset with an id , a type, a process and a reference

Parameters:
id - The id of the instance to create
type - The type of the instance to create
process - The process that owns this instance
reference - The name of the Ruleset called by this instance

ApplyRuleset

public ApplyRuleset(java.lang.String id,
                    java.lang.String type,
                    Process process,
                    java.lang.String reference,
                    java.lang.String strategy)
Creates an instance of ApplyRuleset with an id , a type, a process, a reference and a strategy

Parameters:
id - The id of the instance to create
type - The type of the instance to create
process - The process that owns this instance
reference - The name of the Ruleset called by this instance
strategy - Description of the Parameter
Method Detail

retroNull

public void retroNull(PortList out,
                      PortList in)
Propagate the nullify of its sole output to all the input.

Overrides:
retroNull in class ApplyImpl
Parameters:
out - Description of the Parameter
in - Description of the Parameter

setStrategy

public final void setStrategy(java.lang.String strategy)
Sets the strategy attribute of the ApplyRuleset object

Parameters:
s - The new strategy value

getStrategy

public final java.lang.String getStrategy()
Gets the strategy attribute of the ApplyRuleset object

Returns:
The strategy value

generateXML

public final void generateXML()
Prints an XML description of this ApplyRuleset instance

Specified by:
generateXML in interface Call
Specified by:
generateXML in class CallImpl

createProcess

public final void createProcess(TProcessComposite currentProcess)
Creates a TApplyRuleset corresponding to this ApplyRulset object and adds it to the composite process in the execution structure.

Specified by:
createProcess in interface Call
Overrides:
createProcess in class CallImpl
Parameters:
currentProcess - the container for this serializer

setUp

public final void setUp()
Description copied from interface: Call
Description of the Method

Specified by:
setUp in interface Call
Overrides:
setUp in class CallImpl

generateJavaCode

public void generateJavaCode(Writer file)
                      throws java.io.IOException
Prints a java code description of this ApplyQuery instance

Specified by:
generateJavaCode in interface Call
Specified by:
generateJavaCode in class CallImpl
Parameters:
file - A writer used for printing in afile
Throws:
java.io.IOException - when an IO errors occur

INRIA & FluxMedia

..no bottom yet...