gov.nasa.pds.objectAccess

Class ImageExporter

java.lang.Object

gov.nasa.pds.objectAccess.ObjectExporter

gov.nasa.pds.objectAccess.ImageExporter

Direct Known Subclasses:

ThreeDImageExporter, ThreeDSpectrumExporter, TwoDImageExporter

public abstract class ImageExporter
extends ObjectExporter

Super class for all image exporter types.

Author:

mcayanan

Constructor Summary

Constructors

Constructor and Description
ImageExporter(FileAreaObservational fileArea, ObjectProvider provider) Constructor.
ImageExporter(File label, int fileAreaIndex) Constructor.
ImageExporter(File label, String dataFile) Constructor.
ImageExporter(URL label, int fileAreaIndex) Constructor.
ImageExporter(URL label, String dataFile) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
DisplaySettings	getDisplaySettings(String id) Get the display settings associated with the given identifier.
protected void	parseLabel(File label, int fileAreaIndex)
protected void	parseLabel(File label, String dataFile) Parse the label.
protected void	parseLabel(URL label, int fileAreaIndex) Parse the label.
protected void	parseLabel(URL label, String dataFile) Parse the label.
void	setDisplaySettings(List<DisplaySettings> displaySettings) Set the display settings.

Methods inherited from class gov.nasa.pds.objectAccess.ObjectExporter

getObjectProvider, getObservationalFileArea, setObjectProvider, setObservationalFileArea

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageExporter

public ImageExporter(File label,
             String dataFile)
              throws Exception

Constructor.

Parameters:

label - label file.

dataFile - data file referenced by the given label

Throws:

Exception - If there was an error parsing the label

ImageExporter

public ImageExporter(URL label,
             String dataFile)
              throws Exception

Constructor.

Parameters:

label - label file url.

dataFile - data file referenced by the given label

Throws:

Exception - If there was an error parsing the label

ImageExporter

public ImageExporter(File label,
             int fileAreaIndex)
              throws Exception

Constructor.

Parameters:

label - label file.

fileAreaIndex - The index of the File_Area_Observational element that contains the image to export.

Throws:

Exception - If an error occurred parsing the label.

ImageExporter

public ImageExporter(URL label,
             int fileAreaIndex)
              throws Exception

Constructor.

Parameters:

label - label file.

fileAreaIndex - The index of the File_Area_Observational element that contains the image to export.

Throws:

Exception - If an error occurred parsing the label.

ImageExporter

public ImageExporter(FileAreaObservational fileArea,
             ObjectProvider provider)
              throws IOException

Constructor.

Parameters:

fileArea - The File_Area_Observational element containing the image to export.

provider - The ObjectProvider associated with the image to export.

Throws:

IOException

Method Detail

parseLabel

protected void parseLabel(File label,
              int fileAreaIndex)
                   throws Exception

Overrides:

parseLabel in class ObjectExporter

Throws:

Exception

parseLabel

protected void parseLabel(URL label,
              int fileAreaIndex)
                   throws Exception

Parse the label.

Overrides:

parseLabel in class ObjectExporter

Parameters:

label - The label file.

fileAreaIndex - The index of the File_Area_Observational element that contains the image to export.

Throws:

Exception - If an error occurred while parsing the label.

parseLabel

protected void parseLabel(File label,
              String dataFile)
                   throws Exception

Parse the label.

Parameters:

label - The label file.

fileAreaIndex - The index of the File_Area_Observational element that contains the image to export.

Throws:

Exception - If an error occurred while parsing the label.

parseLabel

protected void parseLabel(URL label,
              String dataFile)
                   throws Exception

Parse the label.

Parameters:

label - The label file.

dataFile - The name of the data file of the File_Area_Observational element that contains the image to export.

Throws:

Exception - If an error occurred while parsing the label.

setDisplaySettings

public void setDisplaySettings(List<DisplaySettings> displaySettings)

Set the display settings.

Parameters:

displaySettings - A list of DisplaySettings.

getDisplaySettings

public DisplaySettings getDisplaySettings(String id)

Get the display settings associated with the given identifier.

Parameters:

id - The identifier to search.

Returns:

The display settings associated with the given identifier. Returns null if none was found.