edu.sc.seis.fissuresUtil.xml

Class DataSetToXMLStAX

java.lang.Object

edu.sc.seis.fissuresUtil.xml.DataSetToXMLStAX

public class DataSetToXMLStAX
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	saveLocally
protected boolean	useDataSetRef If true, then each dataset is put into a separate dsml file.

Constructor Summary

Constructors

Constructor and Description
DataSetToXMLStAX()

Method Summary

Modifier and Type	Method and Description
void	createFile(DataSet dataset, java.io.File dataDirectory, java.io.File outFile) creates an XML file from a Dataset.
static java.lang.String	createFileName(DataSet dataset)
void	insertDSInfo(javax.xml.stream.XMLStreamWriter writer, DataSet dataset, java.io.File directory) inserts the pertinent data into a dataSetElement.
java.io.File	save(DataSet dataset, java.io.File saveDirectory) Saves the given dataset to an xml file in the given directory.
void	writeDataSet(javax.xml.stream.XMLStreamWriter writer, DataSet dataset, java.io.File directory) inserts the dataset, and all child datasets recursively, into the document, along with dataset seismograms and parameters if they can be stored.
void	writeDataSetStartElement(javax.xml.stream.XMLStreamWriter writer)
void	writeDataSetWithNSInfo(javax.xml.stream.XMLStreamWriter writer, DataSet dataset, java.io.File directory) writes the dataset with a namespace-attributed start element and then does the same thing as the above method.
void	writeParameter(javax.xml.stream.XMLStreamWriter writer, java.lang.String name, java.lang.Object parameter) inserts the parameter into the given element.
void	writeParameter(javax.xml.stream.XMLStreamWriter writer, java.lang.String name, java.lang.String typeDef, java.lang.String typeName, java.lang.String value) inserts the parameter into the given element.
void	writeRef(javax.xml.stream.XMLStreamWriter writer, DataSet dataset, java.io.File directory) inserts the child dataset as a datasetRef element.
void	writeRef(javax.xml.stream.XMLStreamWriter writer, java.lang.String datasetURL, java.lang.String linkTitle) inserts the child dataset as a datasetRef element.
void	writeURLDataSetSeismogram(javax.xml.stream.XMLStreamWriter writer, URLDataSetSeismogram urlDSS, java.net.URL base)

Methods inherited from class java.lang.Object

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

Field Detail

saveLocally

protected boolean saveLocally

useDataSetRef

protected boolean useDataSetRef

If true, then each dataset is put into a separate dsml file. Otherwise the child datasets are embedded in the parent dsml file.

Constructor Detail

DataSetToXMLStAX

public DataSetToXMLStAX()

Method Detail

save

public java.io.File save(DataSet dataset,
                         java.io.File saveDirectory)
                  throws java.io.IOException,
                         javax.xml.stream.XMLStreamException

Saves the given dataset to an xml file in the given directory. The file is returned.

Throws:

java.io.IOException

javax.xml.stream.XMLStreamException

createFileName

public static java.lang.String createFileName(DataSet dataset)

createFile

public void createFile(DataSet dataset,
                       java.io.File dataDirectory,
                       java.io.File outFile)
                throws java.io.IOException,
                       javax.xml.stream.XMLStreamException

creates an XML file from a Dataset. Remember that you'll only want to use this if you don't plan on playing around with the innards very much... unless you want to do such things, which is pretty nasty, if I say so myself.

Throws:

java.io.IOException

javax.xml.stream.XMLStreamException

writeDataSet

public void writeDataSet(javax.xml.stream.XMLStreamWriter writer,
                         DataSet dataset,
                         java.io.File directory)
                  throws javax.xml.stream.XMLStreamException,
                         java.io.IOException

inserts the dataset, and all child datasets recursively, into the document, along with dataset seismograms and parameters if they can be stored. Note that all dataSetSeismograms are converted to URLDataSetSeismograms and stored in a directory structure that mirrors the dataset structure under the given directory.

Throws:

javax.xml.stream.XMLStreamException

java.io.IOException

writeDataSetWithNSInfo

public void writeDataSetWithNSInfo(javax.xml.stream.XMLStreamWriter writer,
                                   DataSet dataset,
                                   java.io.File directory)
                            throws javax.xml.stream.XMLStreamException,
                                   java.io.IOException

writes the dataset with a namespace-attributed start element and then does the same thing as the above method.

Throws:

javax.xml.stream.XMLStreamException

java.io.IOException

writeDataSetStartElement

public void writeDataSetStartElement(javax.xml.stream.XMLStreamWriter writer)
                              throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

insertDSInfo

public void insertDSInfo(javax.xml.stream.XMLStreamWriter writer,
                         DataSet dataset,
                         java.io.File directory)
                  throws javax.xml.stream.XMLStreamException,
                         java.io.IOException

inserts the pertinent data into a dataSetElement. This should be called directly after writeDataSetStartElement.

Throws:

javax.xml.stream.XMLStreamException

java.io.IOException

writeURLDataSetSeismogram

public void writeURLDataSetSeismogram(javax.xml.stream.XMLStreamWriter writer,
                                      URLDataSetSeismogram urlDSS,
                                      java.net.URL base)
                               throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeRef

public void writeRef(javax.xml.stream.XMLStreamWriter writer,
                     DataSet dataset,
                     java.io.File directory)
              throws javax.xml.stream.XMLStreamException,
                     java.io.IOException

inserts the child dataset as a datasetRef element. The URL is assumed to be in a subdirectory relative to the current dataset.

Throws:

javax.xml.stream.XMLStreamException

java.io.IOException

writeRef

public void writeRef(javax.xml.stream.XMLStreamWriter writer,
                     java.lang.String datasetURL,
                     java.lang.String linkTitle)
              throws javax.xml.stream.XMLStreamException

inserts the child dataset as a datasetRef element. The URL is assumed to be in a subdirectory relative to the current dataset.

Throws:

javax.xml.stream.XMLStreamException

writeParameter

public void writeParameter(javax.xml.stream.XMLStreamWriter writer,
                           java.lang.String name,
                           java.lang.Object parameter)
                    throws javax.xml.stream.XMLStreamException

inserts the parameter into the given element.

Throws:

javax.xml.stream.XMLStreamException

writeParameter

public void writeParameter(javax.xml.stream.XMLStreamWriter writer,
                           java.lang.String name,
                           java.lang.String typeDef,
                           java.lang.String typeName,
                           java.lang.String value)
                    throws javax.xml.stream.XMLStreamException

inserts the parameter into the given element.

Throws:

javax.xml.stream.XMLStreamException