OmniMark Java VM

About OmniMark Java VM

OmniMark Java VM is an encapsulation of the OmniMark run-time as a Java component. OmniMark Java VM is packaged as part of OmniMark Concurrent Processing Engine, OmniMark Single Processing Engine, and OmniMark Studio for Eclipse.

You can write and compile OmniMark programs using OmniMark Studio for Eclipse, or use OmniMark Desktop Compiler or OmniMark Batch Compiler to compile. OmniMark Studio for Eclipse, OmniMark Desktop Compiler and OmniMark Batch Compiler can compile OmniMark source code into byte code which is executed by OmniMark Java VM. Compiled OmniMark programs have the extension .xvc. .xvc files are platform-independent: that is, they can be run by OmniMark Java VM on all supported platforms.

Installing and Configuring OmniMark Java VM on Windows

On a Windows machine, you install OmniMark Java VM by running the OmniMark installer. When prompted for the type of installation, choose a custom installation: you will then be able to check the optional OmniMark Java VM component along with other selections. You will be guided through the installation and licensing process.

External Function Libraries on Windows

OmniMark ships with a number of external function libraries. Your OmniMark programs can call functions in these libraries. You can also write your own external function libraries or obtain them from third parties.

When searching for external function libraries, OmniMark Java VM searches in the following order:

  1. the current directory,
  2. all directories specified by the external function list property, asset using the setExternalFunctionLibraryPaths ().

Installing and Configuring OmniMark Java VM on UNIX

On a UNIX machine, OmniMark Java VM is installed automatically when installing OmniMark Concurrent Processing Engine, OmniMark Single Processing Engine, or OmniMark Studio for Eclipse.

External Function Libraries on UNIX

OmniMark ships with a number of external function libraries. Your OmniMark programs can call functions in these libraries. You can also write your own external function libraries or obtain them from third parties.

When searching for external function libraries, OmniMark Java VM searches in the following order:

  1. all directories specified in the system-specific shared library path environment variable,
  2. all directories specified by the external function list property, asset using the setExternalFunctionLibraryPaths ().
The system-specific shared library environment variable is LD_LIBRARY_PATH.

Running OmniMark Java VM

To build a Java program that uses the OmniMark Java VM,

  • using a suitable development environment, create a Java program which instantiates a JOmniVM class,
  • use the setXVCFileName () method of the JOmniVM class to set the filename of the compiled OmniMark program that will be run,
  • call the Run () method of the JOmniVM class, and
  • compile the the Java program using 
      javac -classpath <JOmniVM installation path> <program name>.java
    and

You can then run the compiled Java program using 

  java -classpath <JOmniVM installation path>/JOmniVM.jar;..;. -Djava.library.path=<JOmniVM installation path> <program name>

Optionally, you may want to define a class that implements the JOmniLogger interface, in order to implement custom error-handling.

OmniMark Java VM Properties and Methods

For a description of the properties and methods of OmniMark Java VM, see the etr83.rtf document and the javadocs in the OmniMark Java VM installation directory.

Prerequisite Concepts