ome.specification

Class XMLWriter

java.lang.Object

ome.specification.XMLWriter

public class XMLWriter
extends Object

Methods to write the XML tags to the files.

Since:

3.0-Beta4

Version:

3.0 (Internal version: $Revision: $Date: $)

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIG_ENDIAN_ATTRIBUTE Identifies the BigEndian attribute.
static String	BIN_DATA_TAG Identifies the BinData tag.
static String	COMPRESSION_ATTRIBUTE Identifies the Compression attribute.
static String	DIMENSION_ORDER_ATTRIBUTE Identifies the DimensionOrder attribute.
static String	ID_ATTRIBUTE Identifies the ID attribute.
static String	IMAGE_TAG Identifies the Image tag.
private static String	JAXP_SCHEMA_LANGUAGE The schema language.
static String	LENGTH_ATTRIBUTE Identifies the Length attribute.
static String	NAME_ATTRIBUTE Identifies the Name attribute.
static String	OME_TAG Identifies the OME tag.
static String	PIXELS_TAG Identifies the Pixels tag.
static String	PIXELS_TYPE_ATTRIBUTE Identifies the PixelType attribute.
private static String	PLANE A default plane.
private static String	SCHEMA_LOCATION The schema location.
private static String[]	SCHEMAS The schemas.
static String	SIZE_C_ATTRIBUTE Identifies the SizeC attribute.
static String	SIZE_T_ATTRIBUTE Identifies the SizeT attribute.
static String	SIZE_X_ATTRIBUTE Identifies the SizeX attribute.
static String	SIZE_Y_ATTRIBUTE Identifies the SizeY attribute.
static String	SIZE_Z_ATTRIBUTE Identifies the SizeZ attribute.
private static String	XML_NS The XML namespace.
private static String	XSI_NS The XSI namespace.

Constructor Summary

Constructors

Constructor and Description
XMLWriter() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
private void	copyValues(File file, byte[] values) Copies the array to the file.
private String	createXMLDocument(OME ome, boolean binaryData) Creates the String version of the XML file creating using the specified root node.
private void	validate(File file) Validates if the file is compatible with the latest model.
void	writeFile(File file, OME ome) Writes the data to the file.
void	writeFile(File file, OME ome, boolean binaryData) Writes the data to the file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID_ATTRIBUTE

public static final String ID_ATTRIBUTE

Identifies the ID attribute.

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

Identifies the Name attribute.

See Also:

Constant Field Values

DIMENSION_ORDER_ATTRIBUTE

public static final String DIMENSION_ORDER_ATTRIBUTE

Identifies the DimensionOrder attribute.

See Also:

Constant Field Values

PIXELS_TYPE_ATTRIBUTE

public static final String PIXELS_TYPE_ATTRIBUTE

Identifies the PixelType attribute.

See Also:

Constant Field Values

SIZE_C_ATTRIBUTE

public static final String SIZE_C_ATTRIBUTE

Identifies the SizeC attribute.

See Also:

Constant Field Values

SIZE_T_ATTRIBUTE

public static final String SIZE_T_ATTRIBUTE

Identifies the SizeT attribute.

See Also:

Constant Field Values

SIZE_Z_ATTRIBUTE

public static final String SIZE_Z_ATTRIBUTE

Identifies the SizeZ attribute.

See Also:

Constant Field Values

SIZE_X_ATTRIBUTE

public static final String SIZE_X_ATTRIBUTE

Identifies the SizeX attribute.

See Also:

Constant Field Values

SIZE_Y_ATTRIBUTE

public static final String SIZE_Y_ATTRIBUTE

Identifies the SizeY attribute.

See Also:

Constant Field Values

COMPRESSION_ATTRIBUTE

public static final String COMPRESSION_ATTRIBUTE

Identifies the Compression attribute.

See Also:

Constant Field Values

BIG_ENDIAN_ATTRIBUTE

public static final String BIG_ENDIAN_ATTRIBUTE

Identifies the BigEndian attribute.

See Also:

Constant Field Values

LENGTH_ATTRIBUTE

public static final String LENGTH_ATTRIBUTE

Identifies the Length attribute.

See Also:

Constant Field Values

OME_TAG

public static final String OME_TAG

Identifies the OME tag.

See Also:

Constant Field Values

IMAGE_TAG

public static final String IMAGE_TAG

Identifies the Image tag.

See Also:

Constant Field Values

PIXELS_TAG

public static final String PIXELS_TAG

Identifies the Pixels tag.

See Also:

Constant Field Values

BIN_DATA_TAG

public static final String BIN_DATA_TAG

Identifies the BinData tag.

See Also:

Constant Field Values

JAXP_SCHEMA_LANGUAGE

private static final String JAXP_SCHEMA_LANGUAGE

The schema language.

See Also:

Constant Field Values

SCHEMAS

private static final String[] SCHEMAS

The schemas.

XML_NS

private static final String XML_NS

The XML namespace.

See Also:

Constant Field Values

XSI_NS

private static final String XSI_NS

The XSI namespace.

See Also:

Constant Field Values

SCHEMA_LOCATION

private static final String SCHEMA_LOCATION

The schema location.

See Also:

Constant Field Values

PLANE

private static final String PLANE

A default plane.

See Also:

Constant Field Values

Constructor Detail

XMLWriter

public XMLWriter()

Creates a new instance.

Method Detail

copyValues

private void copyValues(File file,
              byte[] values)
                 throws Exception

Copies the array to the file.

Parameters:

file - The file where to copy the array

values - The array to copy.

Throws:

Exception - Thrown if an error occurred while copy the data.

createXMLDocument

private String createXMLDocument(OME ome,
                       boolean binaryData)
                          throws Exception

Creates the String version of the XML file creating using the specified root node.

Parameters:

ome - The root node.

binaryData - Pass true to add the binary data, false otherwise.

Returns:

See above.

Throws:

Exception - Thrown if an error occurred while writing the XML file.

validate

private void validate(File file)
               throws Exception

Validates if the file is compatible with the latest model.

Parameters:

file - The file to validate.

Throws:

Exception - Thrown if the file cannot be validated.

writeFile

public void writeFile(File file,
             OME ome)
               throws Exception

Writes the data to the file. Binary data will be added.

Parameters:

file - The file to handle.

ome - The element to write to the file.

Throws:

Exception - Thrown if an error occurred while writing the XML file.

writeFile

public void writeFile(File file,
             OME ome,
             boolean binaryData)
               throws Exception

Writes the data to the file.

Parameters:

file - The file to handle.

ome - The element to write to the file.

binaryData - Pass true to add the binary data, false otherwise.

Throws:

Exception - Thrown if an error occurred while writing the XML file.