java.lang.Object
- gov.nih.mipav.model.structures.ModelSerialCloneable
- - gov.nih.mipav.model.file.FileInfoBase
  - - gov.nih.mipav.model.file.FileInfoXML

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FileInfoImageXML, FileInfoSurfaceRefXML, FileInfoSurfaceXML
```
public abstract class FileInfoXML
extends FileInfoBase
```
Abstract base clase contains the information that contains the shared information for XML images and XML surfaces.
Derived classes: FileInfoImageXML.java and FileInforSurfaceXML.java

Version:

0.1 Sept 19, 2002

Author:

Alexandra Bokinsky, Ph.D., Neva Cherniavsky, Matthew J. McAuliffe, Ph.D.

See Also:

FileIO, FileInfoXML, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class gov.nih.mipav.model.file.FileInfoBase
  FileInfoBase.AxisOrientation, FileInfoBase.ImageOrientation, FileInfoBase.Modality, FileInfoBase.Unit, FileInfoBase.UnitType

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`imageDataFileName`	Name (not path) of the (usually raw) image data file.
`protected java.lang.String`	`imageDescription`	Brief description of the image - optional XML tag.
`private static long`	`serialVersionUID`	Use serialVersionUID for interoperability.

Fields inherited from class gov.nih.mipav.model.file.FileInfoBase
ANGSTROMS, ANGSTROMS_STRING, AXIAL, axisOrientation, axisOrientationStr, BIOMAGNETIC_IMAGING, cameraMake, cameraModel, CENTIMETERS, CENTIMETERS_STRING, COLOR_FLOW_DOPPLER, COMPRESSION_BZIP2, COMPRESSION_GZIP, COMPRESSION_NONE, COMPRESSION_ZIP, COMPUTED_RADIOGRAPHY, COMPUTED_TOMOGRAPHY, conversionSpaceTimeUnits, CORONAL, DEGREES, DEGREES_STRING, DIAPHANOGRAPHY, DIGITAL_RADIOGRAPHY, DUPLEX_DOPPLER, ENDOSCOPY, exposureTime, EXTERNAL_CAMERA_PHOTOGRAPHY, FA, fileName, fileSuffix, FNumber, focalLength, focalLength35, GENERAL_MICROSCOPY, HARDCOPY, HOURS, HOURS_STRING, HZ, HZ_STRING, ICG, imageOrientation, INCHES, INCHES_STRING, INTRAORAL_RADIOGRAPHY, ISOSpeedRating, KILOMETERS, KILOMETERS_STRING, LASER_SURFACE_SCAN, MAGNETIC_RESONANCE, MAGNETIC_RESONANCE_ANGIOGRAPHY, MAGNETIC_RESONANCE_SPECTROSCOPY, MAMMOGRAPHY, METERS, METERS_STRING, MICROMETERS, MICROMETERS_STRING, MICROSEC, MICROSEC_STRING, MILES, MILES_STRING, MILLIMETERS, MILLIMETERS_STRING, MILLISEC, MILLISEC_STRING, MILS, MILS_STRING, MINUTES, MINUTES_STRING, modality, NANOMETERS, NANOMETERS_STRING, NANOSEC, NANOSEC_STRING, NUCLEAR_MEDICINE, ORI_A2P_TYPE, ORI_I2S_TYPE, ORI_L2R_TYPE, ORI_P2A_TYPE, ORI_R2L_TYPE, ORI_S2I_TYPE, ORI_UNKNOWN_TYPE, origin, OTHER, PANORAMIC_XRAY, POSITRON_EMISSION_TOMOGRAPHY, PPM, PPM_STRING, RADIO_FLUOROSCOPY, RADIOGRAPHIC_IMAGING, RADIOTHERAPY_DOSE, RADIOTHERAPY_IMAGE, RADIOTHERAPY_PLAN, RADIOTHERAPY_RECORD, RADIOTHERAPY_STRUCTURE_SET, RADS, RADS_STRING, RED_FREE, SAGITTAL, SECONDS, SECONDS_STRING, SINGLE_PHOTON_EMISSION_COMPUTED_TOMOGRAPHY, SLIDE_MICROSCOPY, sUnits, tagDescription, tagName, THERMOGRAPHY, TRANSFORM_ANOTHER_DATASET, TRANSFORM_MNI_152, TRANSFORM_SCANNER_ANATOMICAL, TRANSFORM_TALAIRACH_TOURNOUX, TRANSFORM_UNKNOWN, tUnits, ULTRASOUND, unitsOfMeasure, UNKNOWN_MEASURE, UNKNOWN_MODALITY, UNKNOWN_ORIENT, UNKNOWN_STRING, XRAY_ANGIOGRAPHY

Constructor Summary

Constructors
Constructor Description

FileInfoXML(java.lang.String name, java.lang.String directory, int format)
Main constructor for FileInfoXML.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`appendImageDescription(java.lang.String appendDescription)`	Appends a string to the image description.
`abstract void`	`displayAboutInfo(JDialogBase dlog, TransMatrix matrix)`	Displays the file information.
`void`	`finalize()`	Prepares the class for cleanup.
`java.lang.String`	`getImageDataFileName()`	Returns the name of the image data file (not the xml header).
`java.lang.String`	`getImageDescription()`	Returns description of the image.
`void`	`setImageDataFileName(java.lang.String dataFileName)`	Sets the name of the image data file (not the xml header).
`void`	`setImageDescription(java.lang.String newDescription)`	Sets the image description.
`abstract void`	`updateFileInfos(FileInfoXML fInfo)`	Used to propogate all fileInfoXML private variables to other fileinfos.

Methods inherited from class gov.nih.mipav.model.file.FileInfoBase
copyCoreInfo, copyCoreInfo, displayAboutInfo, displayPrimaryInfo, getAboutInfo, getAllSameDimUnits, getAreaUnitsOfMeasureStr, getAxisDirection, getAxisOrientation, getAxisOrientation, getAxisOrientationFromStr, getAxisOrientationStr, getCameraMake, getCameraModel, getCompressionType, getDataType, getDataTypeFromStr, getEndianess, getEndianessFromStr, getExposureTime, getExtents, getFileDirectory, getFileFormat, getFileName, getFileSuffix, getFNumber, getFocalLength, getFocalLength35, getImageOrientation, getImageOrientationFromStr, getImageOrientationStr, getIs2_5D, getISOSpeedRating, getLPSOrigin, getLUT, getMax, getMaxB, getMaxG, getMaxR, getMin, getMinB, getMinG, getMinR, getModality, getModalityFromStr, getModalityStr, getModalityStr, getMultiFile, getNumOfBytesPerPixel, getOffset, getOrigin, getOrigin, getOriginalEndianess, getOriginAtSlice, getPhotometric, getPixelPadValue, getPrimaryInfo, getRescaleIntercept, getRescaleSlope, getResolution, getResolutions, getSize, getSliceThickness, getUnitsOfMeasure, getUnitsOfMeasure, getUnitsOfMeasureAbbrevStr, getUnitsOfMeasureAbbrevStr, getUnitsOfMeasureFromStr, getUnitsOfMeasureStr, getUnitsOfMeasureStr, getVolumeUnitsOfMeasureStr, isDicomOrdered, oppositeOrient, sameAxis, setAxisOrientation, setAxisOrientation, setCameraMake, setCameraModel, setCompressionType, setDataType, setEndianess, setExposureTime, setExtents, setExtents, setFileDirectory, setFileFormat, setFileName, setFileSuffix, setFNumber, setFocalLength, setFocalLength35, setImageOrientation, setISOSpeedRating, setLUT, setMax, setMaxB, setMaxG, setMaxR, setMin, setMinB, setMinG, setMinR, setModality, setMultiFile, setOffset, setOrigin, setOrigin, setOriginalEndianess, setPhotometric, setPixelPadValue, setRescaleIntercept, setRescaleSlope, setResolutions, setResolutions, setSliceThickness, setTagDescription, setTagName, setUnitsOfMeasure, setUnitsOfMeasure, setUnitsOfMeasure, setUnitsOfMeasure, toString

Methods inherited from class gov.nih.mipav.model.structures.ModelSerialCloneable
clone, nativeClone

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    Use serialVersionUID for interoperability.
    
    See Also:
    
    Constant Field Values
  - imageDataFileName
```
protected java.lang.String imageDataFileName
```
    Name (not path) of the (usually raw) image data file. The name of the image xml header file is stored in FileInfoBase.getFileName().
    
    See Also:
    
    FileInfoBase.getFileName(), FileInfoBase.setFileName(String)
  - imageDescription
```
protected java.lang.String imageDescription
```
    Brief description of the image - optional XML tag.
- Constructor Detail
  - FileInfoXML
```
public FileInfoXML(java.lang.String name,
                   java.lang.String directory,
                   int format)
```
    Main constructor for FileInfoXML.
    
    Parameters:
    
    name - String file name
    
    directory - String file directory
    
    format - int file format (data type)
- Method Detail
  - displayAboutInfo
```
public abstract void displayAboutInfo(JDialogBase dlog,
                                      TransMatrix matrix)
```
    Displays the file information.
    
    Specified by:
    
    displayAboutInfo in class FileInfoBase
    
    Parameters:
    
    dlog - JDialogBase dialog box that is written to
    
    matrix - transformation matrix
  - updateFileInfos
```
public abstract void updateFileInfos(FileInfoXML fInfo)
```
    Used to propogate all fileInfoXML private variables to other fileinfos.
    
    Parameters:
    
    fInfo - FileInfoXML file info to be copied into
  - appendImageDescription
```
public void appendImageDescription(java.lang.String appendDescription)
```
    Appends a string to the image description.
    
    Parameters:
    
    appendDescription - a brief description of the image to be appended.
  - finalize
```
public void finalize()
```
    Prepares the class for cleanup.
    
    Overrides:
    
    finalize in class FileInfoBase
  - getImageDataFileName
```
public java.lang.String getImageDataFileName()
```
    Returns the name of the image data file (not the xml header).
    
    Returns:
    
    name of the image data file
  - getImageDescription
```
public java.lang.String getImageDescription()
```
    Returns description of the image.
    
    Returns:
    
    a brief description of the image.
  - setImageDataFileName
```
public void setImageDataFileName(java.lang.String dataFileName)
```
    Sets the name of the image data file (not the xml header).
    
    Parameters:
    
    dataFileName - image data file name (not path)
  - setImageDescription
```
public void setImageDescription(java.lang.String newDescription)
```
    Sets the image description.
    
    Parameters:
    
    newDescription - a brief description of the image.

Class FileInfoXML

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class gov.nih.mipav.model.structures.ModelSerialCloneable

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

imageDataFileName

imageDescription

Constructor Detail

FileInfoXML

Method Detail

displayAboutInfo

updateFileInfos

appendImageDescription

finalize

getImageDataFileName

getImageDescription

setImageDataFileName

setImageDescription