Package gov.nih.mipav.model.file

Class FileDataProvenance

java.lang.Object

gov.nih.mipav.model.file.FileBase

gov.nih.mipav.model.file.FileXML

gov.nih.mipav.model.file.FileDataProvenance

public class FileDataProvenance
extends FileXML

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	FileDataProvenance.ProvenanceXMLHandler	Handle events generated while parsing the XML file.

Nested classes/interfaces inherited from class gov.nih.mipav.model.file.FileXML

FileXML.XMLAttributes

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	DATA_PROVENANCE	The MIPAV XML header comment.
private java.io.File	file	File reference.
private ProvenanceHolder	pHolder	The provenance holder to write from and read into
private static java.lang.String	XML_ENCODING	The charset the XML file is written in.
private static java.lang.String	XML_HEADER	The XML version description header.

Fields inherited from class gov.nih.mipav.model.file.FileXML

bw, fileDir, fileInfo, fileName, m_kHandler, MIPAV_HEADER, pInterface, TAB, tabLevel, W3C_XML_SCHEMA

Fields inherited from class gov.nih.mipav.model.file.FileBase

BIG_ENDIAN, bitsPerPixel, fileNames, LITTLE_ENDIAN, pBarVisible, raFile, READ, READ_WRITE

Constructor Summary

Constructors

Constructor	Description
FileDataProvenance(java.lang.String fn, java.lang.String fDir, ProvenanceHolder ph)	VOI reader/writer constructor.

Method Summary

Modifier and Type	Method	Description
void	writeXML()	Writes the data provenance into xml formatted file

Methods inherited from class gov.nih.mipav.model.file.FileXML

closedTag, closedTag, closedTag, finalize, openTag, readHeader, setPBar

Methods inherited from class gov.nih.mipav.model.file.FileBase

addProgressChangeListener, bytesToDouble, bytesToFloat, bytesToInt, bytesToShort, doubleToBytes, fireProgressStateChanged, fireProgressStateChanged, fireProgressStateChanged, floatToBytes, getBufferDouble, getBufferFloat, getBufferInt, getBufferLong, getBufferShort, getBufferUShort, getDataType, getDouble, getFloat, getInt, getLong, getProgressChangeListeners, getRaFile, getSignedShort, getString, getUInt, getUnsignedByte, getUnsignedShort, intToBytes, isBigEndian, isProgressBarVisible, linkProgress, longToBytes, readDouble, readFloat, readInt, readLong, readShort, readString, readUnsignedShort, removeProgressChangeListener, setBigEndian, setBufferFloat, setBufferInt, setBufferLong, setBufferShort, setBufferString, setDataType, setEndianess, shortToBytes, writeBytes, writeDouble, writeFloat, writeInt, writeLong, writeShort

Methods inherited from class java.lang.Object

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

Field Detail

XML_ENCODING

private static final java.lang.String XML_ENCODING

The charset the XML file is written in.

See Also:

Constant Field Values

XML_HEADER

private static final java.lang.String XML_HEADER

The XML version description header.

See Also:

Constant Field Values

DATA_PROVENANCE

private static final java.lang.String DATA_PROVENANCE

The MIPAV XML header comment.

See Also:

Constant Field Values

file

private java.io.File file

File reference.

pHolder

private ProvenanceHolder pHolder

The provenance holder to write from and read into

Constructor Detail

FileDataProvenance

public FileDataProvenance(java.lang.String fn,
                          java.lang.String fDir,
                          ProvenanceHolder ph)

VOI reader/writer constructor.

Parameters:

fileName - file name

fileDir - file directory

image - image model: needed during the read process to ensure the VOI "fits" in the image space.

Method Detail

writeXML

public void writeXML()
              throws java.io.IOException

Writes the data provenance into xml formatted file

Throws:

java.io.IOException