Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.49 KB

java-library.rst

File metadata and controls

42 lines (30 loc) · 1.49 KB

OME-XML Java library

The OME-XML Java library is a collection of Java packages for manipulating OME-XML metadata structures. The OME-XML Java library's metadata processing facilities form the backbone of the :bf:`Bio-Formats <>` library's support for OME-XML conversion.

Download

The ome-xml artifacts are hosted on the Maven Central Repository under the group org.openmicroscopy and distributed under the 2-Clause BSD license.

Installation

To use, add ome-xml.jar to your classpath or build path.

Usage

Refer to the :javadoc:`online API documentation <>`, specifically the ome.xml.* packages. For an example of usage, see the :bf_source:`Screen Plate Well unit test <components/formats-bsd/test/loci/formats/utests/SPWModelMock.java>`.

The OMENode is the root ("OME") node of the OME-XML. Each XML element has its own node type (e.g. "Image" has ImageNode) with its own accessor and mutator methods, to make navigation of the OME-XML structure easier than it would be with a raw DOM object. However, there are some limitations to what can be done with the API. If your application needs access to a node's backing DOM element to work with it directly, you can call getDOMElement() on a node.

Source code

The OME-XML Java library is an open source project—the source code is freely accessible via the https://github.com/ome/ome-model Git repository.