Class OpenMathReader

java.lang.Object
org.episteme.core.io.AbstractResourceReader<Object>
org.episteme.core.mathematics.loaders.openmath.OpenMathReader
All Implemented Interfaces:
ResourceIO<Object>, ResourceReader<Object>
public class OpenMathReader extends AbstractResourceReader<Object>
OpenMath Reader for mathematical objects.

OpenMath is an extensible standard for representing the semantics of mathematical objects. This reader parses OpenMath XML and converts it to Episteme mathematical objects where possible.

Supported OpenMath Elements:

  • OMI: Integers → Long
  • OMF: Floats → RealDouble
  • OMSTR: Strings → String
  • OMV: Variables → OpenMathVariable
  • OMS: Symbols → OpenMathSymbol
  • OMA: Applications → OpenMathApplication (or Complex for complex_cartesian)
  • OMBIND: Bindings → OpenMathBinding
  • OMB: Byte arrays → byte[]

Example: 

OpenMathReader reader = new OpenMathReader();
Object obj = reader.read(new File("expression.om"));
if (obj instanceof Complex) {
    Complex c = (Complex) obj;
    System.out.println("Complex number: " + c);
}

* @see OpenMath.org
Since:
1.0
Author:
Silvere Martin-Michiellot, Gemini AI (Google DeepMind)
See Also:

  • Constructor Details

    • OpenMathReader

      public OpenMathReader()

  • Method Details

    • getResourcePath

      public String getResourcePath()
      Description copied from interface: ResourceIO
      Returns the base path where this resource is located.

    • getResourceType

      public Class<Object> getResourceType()
      Description copied from interface: ResourceIO
      Returns the type of resource.

    • getName

      public String getName()
      Description copied from interface: ResourceIO
      Returns the display name of this resource handler. MUST be implemented with I18N support.
      Returns:
      the display name

    • getDescription

      public String getDescription()
      Description copied from interface: ResourceIO
      Returns a short description of this resource handler. MUST be implemented with I18N support.
      Returns:
      the description

    • getLongDescription

      public String getLongDescription()
      Description copied from interface: ResourceIO
      Returns a long description of this resource handler. MUST be implemented with I18N support.
      Returns:
      the long description

    • getCategory

      public String getCategory()
      Description copied from interface: ResourceIO
      Returns the category for grouping. MUST be implemented with I18N support.
      Returns:
      the category name

    • getSupportedVersions

      public String[] getSupportedVersions()
      Description copied from interface: ResourceIO
      Returns the supported versions of the format this reader/writer handles.

      Each implementation MUST override this method to declare which versions of the underlying format are supported. The returned array should contain version strings in the format's standard notation (e.g., "3.0", "2.1", "Level 3 Version 2").

      Examples:

      • MathML: {"3.0", "2.0"}
      • SBML: {"Level 3 Version 2", "Level 3 Version 1", "Level 2 Version 5"}
      • PhyloXML: {"1.10", "1.00"}

      Returns:
      array of supported version strings, never null (empty array if version-agnostic)

    • getSupportedExtensions

      public String[] getSupportedExtensions()
      Description copied from interface: ResourceIO
      Returns the supported file extensions (e.g., ".h5", ".fits").

    • loadFromSource

      protected Object loadFromSource(String resourceId) throws Exception
      Specified by:
      loadFromSource in class AbstractResourceReader<Object>
      Throws:
      Exception

    • loadFromInputStream

      protected Object loadFromInputStream(InputStream is, String id) throws Exception
      Overrides:
      loadFromInputStream in class AbstractResourceReader<Object>
      Throws:
      Exception

    • read

      public Object read(InputStream input) throws OpenMathException
      Reads an OpenMath object from an input stream.
      Parameters:
      input - the input stream containing OpenMath XML
      Returns:
      the parsed mathematical object
      Throws:
      OpenMathException - if parsing fails

    • read

      public Object read(File file) throws OpenMathException
      Reads an OpenMath object from a file.
      Parameters:
      file - the file containing OpenMath XML
      Returns:
      the parsed mathematical object
      Throws:
      OpenMathException - if parsing fails

    • readFromString

      public Object readFromString(String openmath) throws OpenMathException
      Reads an OpenMath object from a string.
      Parameters:
      openmath - the OpenMath XML as a string
      Returns:
      the parsed mathematical object
      Throws:
      OpenMathException - if parsing fails