Package ptolemy.actor.lib.xslt

Class XMLInclusion

  • All Implemented Interfaces:
    java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    public class XMLInclusion
extends Transformer
    Combine multiple XMLTokens into one XMLToken.

    The actor reads in multiple arrays of XML Tokens from the input port. It also takes a port parameter, template, that specifies how the XML tokens will be combined. The template is of the form: 

       <?xml version="1.0" standalone="no"?>
   <Node>
   $inputi,j
   </Node>
    The template is a XML Token with $input as a delimiter for where the input XML tokens should be placed, i specifies which array (i.e. which channel) and j specifies which XML Token in the array. Setting j equal to n will insert (in order) all XML tokens in that particular array into the template file. If i or j are out of bounds, $inputi,j will not be replaced. It also takes in a string parameter, headerParameter, which is the header used for the output XML token. A XML Token with the delimiters replaced with the appropriate XML Token is sent to the output port. No changes are made to the input XML Tokens besides removing the header and DTD.
    Since:
    Ptolemy II 6.1
    Version:
    $Id$
    Author:
    Christine Avanessians, Edward Lee, Thomas Feng
    Pt.AcceptedRating:
    Red (cavaness)
    Pt.ProposedRating:
    Red (cavaness)

    • Field Detail

      • template

        public PortParameter template
        The template that specifies how the XML tokens will be combined. The type of this parameter is not defined, though it is in string mode. The initial value is not defined.

      • headerParameter

        public StringParameter headerParameter
        The xml header. This parameter is a string with an initial value of <?xml version="1.0" standalone="no"?>.

    • Method Detail

      • fire

        public void fire()
          throws IllegalActionException
        Read multiple arrays of XMLTokens from the input and combine them according to the specified template. If the template contains invalid delimiters, then return the template file with the valid ones replaced and the invalid ones unmodified.
        Specified by:
        fire in interface Executable
        Overrides:
        fire in class AtomicActor<TypedIOPort>
        Throws:
        IllegalActionException - If thrown by the parent class, while reading a parameter or while reading the input.