ptolemy.moml

Class MoMLVariableChecker

java.lang.Object

ptolemy.moml.MoMLVariableChecker

public class MoMLVariableChecker
extends java.lang.Object

Check that all the variables are defined in a piece of MoML.

Since:

Ptolemy II 6.1

Version:

$Id: MoMLVariableChecker.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Christopher Brooks

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Constructor Summary

Constructors

Constructor and Description
MoMLVariableChecker()

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkCopy(java.lang.String momlToBeChecked, NamedObj container) Check for problems in the moml to be copied.
java.lang.String	checkCopy(java.lang.String momlToBeChecked, NamedObj container, boolean hideVariables) Check for problems in the moml to be copied.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MoMLVariableChecker

public MoMLVariableChecker()

Method Detail

checkCopy

public java.lang.String checkCopy(java.lang.String momlToBeChecked,
                                  NamedObj container)
                           throws IllegalActionException

Check for problems in the moml to be copied. If there are missing variables references, search for the variables and return MoML definitions for any found variables.

Parameters:

momlToBeChecked - The MoML string to be checked.

container - The container in which the string is to be checked.

Returns:

MoML to be inserted before the momlToBeChecked

Throws:

IllegalActionException - If there is a problem parsing the string, or validating a variable.

checkCopy

public java.lang.String checkCopy(java.lang.String momlToBeChecked,
                                  NamedObj container,
                                  boolean hideVariables)
                           throws IllegalActionException

Check for problems in the moml to be copied. If there are missing variable references, search for the variables and return MoML definitions for any found variables.

Parameters:

momlToBeChecked - The MoML string to be checked.

container - The container in which the string is to be checked.

hideVariables - If true, add MoML that will make all the found variables hidden from the user interface when they are copied.

Returns:

MoML to be inserted before the momlToBeChecked

Throws:

IllegalActionException - If there is a problem parsing the string, or validating a variable.