Module omix.api
Package omix.plugin.ovl

Interface OVLProgram

public interface OVLProgram
This interface represents a program specified in the Omix Visualization Language (OVL).
Since:
Omix 1.3.11
Author:
Dr. Peter Droste, Omix Visualization

  • Method Details

    • getNamespace

      String getNamespace()
      The namespace of the program.
      • empty string if program is document embedded
      • plugin ID if program is defined in an Omix plugin
      Returns:
      namespace

    • getOVLItemExtension

      OVLItemExtension getOVLItemExtension​(Class<?> type)
      Returns an instance of OVLItemExtension representing the "extend" block in the OVL program.
      Example code:
      OVL:
      extend Metabolite{
      //....
      }
      can be referenced by:
      getExtension(Metabolite.class)
      Parameters:
      type - class of the extend block
      Returns:
      OVLItemExtension or null

    • getOVLItemExtension

      OVLItemExtension getOVLItemExtension​(ClassType type)
      Returns an instance of OVLItemExtension representing the "extend" block in the OVL program.
      Parameters:
      type - class type of the extend block
      Returns:
      OVLItemExtension or null

    • getOVLClass

      OVLClass getOVLClass​(String className)
      Returns an object if OVLClass representing an OVL class.
      Parameters:
      className -
      Returns:
      OVLClass or null if unavailable

    • getOVLItemExtensions

      Map<? extends ClassType,​? extends OVLItemExtension> getOVLItemExtensions()
      Returns all OVLItemExtensions defined in this program.
      Returns:
      map of ovl item extensions

    • getOVLClasses

      Map<String,​? extends OVLClass> getOVLClasses()
      Returns all OVL classes
      Returns:
      OVL classes

    • getErrorMessages

      Collection<? extends OVLCompilerMessage> getErrorMessages()
      Returns a list of errors from the OVL Compiler occurred during the compilation of the program code.
      Returns:
      errors

    • getWarnings

      Collection<? extends OVLCompilerMessage> getWarnings()
      Returns a list of warnings from the OVL Compiler occurred during the compilation of the program code.
      Returns:
      warnings