Package ptolemy.data.ontologies

Class OntologyAnnotationAttribute

  • All Implemented Interfaces:
    java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable
    public class OntologyAnnotationAttribute
extends StringAttribute
    An annotation specifying a single ontology constraints in a model. The name of the ontology is specified as a StringAttribute, but it will also fall back to a name-convention based method for backward compatibility.
    Since:
    Ptolemy II 10.0
    Version:
    $Id$
    Author:
    Ben Lickly, Man-Kit Leung
    Pt.AcceptedRating:
    Red (mankit)
    Pt.ProposedRating:
    Red (mankit)

    • Field Detail

      • ontologySolverName

        public StringAttribute ontologySolverName
        Name of the OntologySolver to which this annotation belongs.

    • Constructor Detail

      • OntologyAnnotationAttribute

        public OntologyAnnotationAttribute​(NamedObj container,
                                   java.lang.String name)
                            throws IllegalActionException,
                                   NameDuplicationException
        Construct an OntologyAnnotationAttribute with the specified name and container. If a reasonable default exists, initialize the ontology solver name, as well.
        Parameters:
        container - Container
        name - The given name for the attribute.
        Throws:
        IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.
        NameDuplicationException - If the name coincides with an attribute already in the container.

    • Method Detail

      • getOntologySolverIdentifier

        public java.lang.String getOntologySolverIdentifier()
                                             throws IllegalActionException
        Return the name of the ontology solver for which this annotation attribute is a constraint. First try to look in the ontologySolverName attribute, and then fall back to the naming convention based on the annotation name.
        Returns:
        A String representing the name of the referred ontology solver.
        Throws:
        IllegalActionException - If an OntologySolver name cannot be determined.