nilus

Class MarshalXML

java.lang.Object

nilus.MarshalXML

public class MarshalXML
extends Object

This class is used to convert Java architecture for XML binding (JAXB) objects to XML.

Author:

Sean Herbert and Marie Roch

Field Summary

Fields

Modifier and Type	Field and Description
protected JAXBContext	jxbc
protected Marshaller	jxbm
static String	schema
static String	schemaLoc

Constructor Summary

Constructors

Constructor and Description
MarshalXML() Nilus Marshaller class for Tethys w default schema location
MarshalXML(String loc) Nilus Marshaler class for Tehtys with specific schema location

Method Summary

Modifier and Type	Method and Description
JAXBContext	createInstance(Class c) createInstance Create an instance of a Tethys schema class.
private void	initMarshalXML(String loc) Initialize the XML
String	marshal(Object jaxb) Marshal an object to XML contained in a String.
void	marshal(Object jaxb, OutputStream out) Marshal an object to XML, writing out the result to an OutputStream or one of its derived classes
void	marshal(Object jaxb, PrintWriter out) Marshal an object to XML, writing out the result to a PrintWriter output stream.
void	marshal(Object jaxb, String filename) Marshal object to XML that will be stored in file
Document	marshalToDOM(Object jaxb) Marshal an object to a DOM document with a single element which is the marshalled representation of the JAXB object
Deployment	unmarshallDeployment(String xml) Given a string with a valid Deployment document, unmarshal to plain-old Java objects (POJOs) generated by the JAXB compiler.

Methods inherited from class java.lang.Object

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

Field Detail

schema

public static String schema

schemaLoc

public static String schemaLoc

jxbc

protected JAXBContext jxbc

jxbm

protected Marshaller jxbm

Constructor Detail

MarshalXML

public MarshalXML()
           throws JAXBException

Nilus Marshaller class for Tethys w default schema location

Throws:

JAXBException - Unable to marshal

MarshalXML

public MarshalXML(String loc)
           throws JAXBException

Nilus Marshaler class for Tehtys with specific schema location

Parameters:

loc - - Use null or "" for no location

Throws:

JAXBException - Unable to marshal

Method Detail

initMarshalXML

private void initMarshalXML(String loc)
                     throws JAXBException

Initialize the XML

Parameters:

loc - Schema specification/location

Throws:

JAXBException

marshal

public void marshal(Object jaxb,
                    String filename)
             throws FileNotFoundException,
                    JAXBException

Marshal object to XML that will be stored in file

Parameters:

jaxb - - Object to be marshaled

filename - - name of file to be written

Throws:

FileNotFoundException - Unable to open file for output

JAXBException - Erorr marshaling to XML

marshal

public String marshal(Object jaxb)
               throws JAXBException

Marshal an object to XML contained in a String.

Parameters:

jaxb - - Object to be marshaled

Returns:

String

Throws:

JAXBException - Error marshaling to XML

marshal

public void marshal(Object jaxb,
                    PrintWriter out)
             throws JAXBException

Marshal an object to XML, writing out the result to a PrintWriter output stream.

Parameters:

jaxb - - Object to be marshalled

out - - Writer stream to which object should be marshalled

Throws:

JAXBException - Erorr marshaling to XML

marshal

public void marshal(Object jaxb,
                    OutputStream out)
             throws JAXBException

Marshal an object to XML, writing out the result to an OutputStream or one of its derived classes

Parameters:

jaxb - - Object to be marshalled

out - - java.io.OutpuStrream to which object should be marshalled

Throws:

JAXBException - Error marshaling to XML

marshalToDOM

public Document marshalToDOM(Object jaxb)
                      throws JAXBException,
                             ParserConfigurationException

Marshal an object to a DOM document with a single element which is the marshalled representation of the JAXB object

Parameters:

jaxb - JAX object to be marshaled to DOM

Returns:

Resulting DOM Document

Throws:

JAXBException - Unable to marshal

ParserConfigurationException - Internal problem

createInstance

public JAXBContext createInstance(Class c)
                           throws JAXBException

createInstance Create an instance of a Tethys schema class. In general, this should be done using a top level schema class. For example, to create a detections document: instance = MarshalXML.createInstance(nilus.Detections.class);

Parameters:

c - Create an instance of the specified schema class (Tethys schema object

Returns:

Representation of object as JAXBContext

Throws:

JAXBException - Unable to create the instance

unmarshallDeployment

public Deployment unmarshallDeployment(String xml)
                                throws JAXBException

Given a string with a valid Deployment document, unmarshal to plain-old Java objects (POJOs) generated by the JAXB compiler.

Parameters:

xml - - UTF-8 string

Returns:

Deployment object

Throws:

JAXBException