gov.noaa.pmel.tmap.iosp

Class IOSPDocument

java.lang.Object

org.jdom.Document

gov.noaa.pmel.tmap.iosp.IOSPDocument

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.jdom.Parent

Direct Known Subclasses:

FerretConfig

public class IOSPDocument
extends org.jdom.Document

The Document class is the base class for all XML documents used by the IOSP code.

Author:

Roland Schweitzer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IOSPDocument() The default constructor which invokes the super class org.jdom.Document.
IOSPDocument(org.jdom.Document doc) Turn an existing JDOM document into an IOSPDocument.

Method Summary

Methods

Modifier and Type	Method and Description
org.jdom.Element	getElementByXPath(java.lang.String xpathValue) A utility class that returns an element based on the XPath to that element.
java.lang.String	toCompactString() Returns the document as a String without any extra white space.
java.lang.String	toEncodedJavaScriptSafeURLString() An attempt to return an encoded string that is usable in JavaScript variable assignments.
java.lang.String	toEncodedURLString() Returns the document encoded by the URLEncoder class after striping carriage returns and line feeds.
java.lang.String	toJavaScriptSafeString() Attempt to return the document as a string that can be used in a JavaScript variable assignment.
java.lang.String	toString() Convert the document to a string use the JDOM default getPrettyPrint format.
java.lang.String	toString(org.jdom.output.Format format) Return a pretty printed string formatted according to the JDOM Format
void	write(java.io.File file) Write the document to the File
void	write(java.lang.String fileName) Write the document to the file specified by the path in the input String

Methods inherited from class org.jdom.Document

addContent, addContent, addContent, addContent, clone, cloneContent, detachRootElement, equals, getBaseURI, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getDocType, getDocument, getParent, getProperty, getRootElement, hashCode, hasRootElement, indexOf, removeContent, removeContent, removeContent, removeContent, setBaseURI, setContent, setContent, setContent, setContent, setDocType, setProperty, setRootElement

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IOSPDocument

public IOSPDocument()

The default constructor which invokes the super class org.jdom.Document.

IOSPDocument

public IOSPDocument(org.jdom.Document doc)

Turn an existing JDOM document into an IOSPDocument.

Parameters:

doc - The document to be used.

Method Detail

getElementByXPath

public org.jdom.Element getElementByXPath(java.lang.String xpathValue)
                                   throws org.jdom.JDOMException

A utility class that returns an element based on the XPath to that element.

Parameters:

xpathValue - the XPath string of the element to be found.

Returns:

the element specified by the XPath.

Throws:

org.jdom.JDOMException

toCompactString

public java.lang.String toCompactString()

Returns the document as a String without any extra white space.

Returns:

the document as a compact string.

toEncodedURLString

public java.lang.String toEncodedURLString()
                                    throws java.io.UnsupportedEncodingException

Returns the document encoded by the URLEncoder class after striping carriage returns and line feeds.

Returns:

the encoded string

Throws:

java.io.UnsupportedEncodingException

toEncodedJavaScriptSafeURLString

public java.lang.String toEncodedJavaScriptSafeURLString()
                                                  throws java.io.UnsupportedEncodingException

An attempt to return an encoded string that is usable in JavaScript variable assignments.

Returns:

the encoded string

Throws:

java.io.UnsupportedEncodingException

toJavaScriptSafeString

public java.lang.String toJavaScriptSafeString()

Attempt to return the document as a string that can be used in a JavaScript variable assignment.

Returns:

the docuement as a string

toString

public java.lang.String toString(org.jdom.output.Format format)

Return a pretty printed string formatted according to the JDOM Format

Parameters:

format - the Format object that controls the pretty printing.

Returns:

the pretty printed string.

toString

public java.lang.String toString()

Convert the document to a string use the JDOM default getPrettyPrint format.

Overrides:

toString in class org.jdom.Document

write

public void write(java.lang.String fileName)

Write the document to the file specified by the path in the input String

Parameters:

fileName - the file path

write

public void write(java.io.File file)

Write the document to the File

Parameters:

file - the File to write to