FileSurfaceRefXML (MIPAV API Documentation)

java.lang.Object
- gov.nih.mipav.model.file.FileBase
- - gov.nih.mipav.model.file.FileXML
  - - gov.nih.mipav.model.file.FileSurfaceRefXML

Direct Known Subclasses:

FileSurfaceRefXML_J3D, FileSurfaceRefXML_WM
```
public abstract class FileSurfaceRefXML
extends FileXML
```
Inherits from FileXML, reads SurfaceRef.XML files based on the "surfaceref.xsd" file. Defines specific variables for reading and writing surfaceref.xml files:

Nested Class Summary
- Nested classes/interfaces inherited from class gov.nih.mipav.model.file.FileXML
  FileXML.XMLAttributes

Field Summary

Fields
Modifier and Type	Field	Description
`protected static java.lang.String[]`	`m_kMaterialStr`	array of strings representing the tags under in the xml schema.
`protected static java.lang.String[]`	`m_kSurfaceStr`	array of strings representing the tags under in the xml schema.

Fields inherited from class gov.nih.mipav.model.file.FileXML
bw, fileDir, fileInfo, fileName, m_kHandler, MIPAV_HEADER, pInterface, TAB, tabLevel, W3C_XML_SCHEMA, XML_ENCODING, XML_HEADER

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

FileSurfaceRefXML(java.lang.String fName, java.lang.String fDir)
Constructs new file object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

void finalize()
Prepares class for cleanup.
- Methods inherited from class gov.nih.mipav.model.file.FileXML
  closedTag, closedTag, closedTag, 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
  - m_kSurfaceStr
```
protected static final java.lang.String[] m_kSurfaceStr
```
    array of strings representing the tags under in the xml schema.
  - m_kMaterialStr
```
protected static final java.lang.String[] m_kMaterialStr
```
    array of strings representing the tags under in the xml schema.
- Constructor Detail
  - FileSurfaceRefXML
```
public FileSurfaceRefXML(java.lang.String fName,
                         java.lang.String fDir)
```
    Constructs new file object.
    
    Parameters:
    
    fName - File name.
    
    fDir - File directory.
- Method Detail
  - finalize
```
public void finalize()
```
    Prepares class for cleanup.
    
    Overrides:
    
    finalize in class FileXML