Package ptolemy.cg.kernel.generic.html

Class HTMLCodeGenerator

  • All Implemented Interfaces:
    java.lang.Cloneable, Changeable, Debuggable, DebugListener, Decorator, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    public class HTMLCodeGenerator
extends GenericCodeGenerator
    Generate a HTML description of a model.

    To generate an HTML version of a model, use: 

     java -classpath $PTII ptolemy.cg.kernel.generic.html.HTMLCodeGenerator -generatorPackage ptolemy.cg.kernel.generic.html -generatorPackageList generic.html adapter/generic/html/demo/HierarchicalModel/HierarchicalModel.xml
    Since:
    Ptolemy II 10.0
    Version:
    $Id$
    Author:
    Man-Kit Leung, Bert Rodiers
    Pt.AcceptedRating:
    red (rodiers)
    Pt.ProposedRating:
    red (rodiers)

    • Constructor Detail

      • HTMLCodeGenerator

        public HTMLCodeGenerator​(NamedObj container,
                         java.lang.String name)
                  throws IllegalActionException,
                         NameDuplicationException
        Create a new instance of the HTMLCodeGenerator. The value of the generatorPackageList parameter of the base class is set to generic.html
        Parameters:
        container - The container.
        name - The name of the HTMLCodeGenerator.
        Throws:
        IllegalActionException - If the super class throws the exception or error occurs when setting the file path.
        NameDuplicationException - If the super class throws the exception or an error occurs when setting the file path.

    • Method Detail

      • comment

        public java.lang.String comment​(java.lang.String comment)
        Return a formatted comment containing the specified string. In this base class, the comments is a HTML-style comment, which begins with "" followed by the platform dependent end of line character(s): under Unix: "\n", under Windows: "\n\r". Subclasses may override this produce comments that match the code generation language.
        Overrides:
        comment in class GenericCodeGenerator
        Parameters:
        comment - The string to put in the comment.
        Returns:
        A formatted comment.

      • _generateCode

        protected int _generateCode​(java.lang.StringBuffer code)
                     throws KernelException
        Generate HTML and append it to the given string buffer. Write the code to the directory specified by the codeDirectory parameter. The file name is a sanitized version of the model name with a suffix that is based on last package name of the generatorPackage parameter. Thus if the codeDirectory is $HOME, the name of the model is Foo and the generatorPackage is ptolemy.cg.kernel.generic.html, then the file that is written will be $HOME/Foo.html This method is the main entry point to generate html.
        Overrides:
        _generateCode in class GenericCodeGenerator
        Parameters:
        code - The given string buffer.
        Returns:
        The return value of the last subprocess that was executed. or -1 if no commands were executed.
        Throws:
        KernelException - If the target file cannot be overwritten or write-to-file throw any exception.

      • _getAdapterClassFilter

        protected java.lang.Class<?> _getAdapterClassFilter()
        Return the filter class to find adapters. All adapters have to extend this class.
        Overrides:
        _getAdapterClassFilter in class GenericCodeGenerator
        Returns:
        The base class for the adapters.