gov.nasa.pds.objectAccess
Interface ObjectProvider

All Known Implementing Classes:
ObjectAccess

public interface ObjectProvider

Provides access to PDS4 objects.


Method Summary
 String getArchiveRoot()
          Gets the root file path of the object archive(s) for this ObjectProvider.
 List<Array2DImage> getArray2DImages(FileAreaObservational observationalFileArea)
          Returns a list of Array2DImage objects given an observation file area object.
 List<FieldBinary> getFieldBinaries(TableBinary table)
          Returns a list of FieldBinary objects given a table binary object.
 List<FieldCharacter> getFieldCharacters(TableCharacter table)
          Returns a list of FieldCharacter objects given a table character object.
 ProductObservational getObservationalProduct(String relativeXmlFilePath)
          Gets an instance of ProductObservational.
<T> T
getProduct(File labelFile, Class<T> productClass)
          Reads a product label of a specified class, and returns an instance of that class as a result.
 File getRoot()
          Gets the root file path of the object archive(s) for this ObjectProvider.
 List<TableBinary> getTableBinaries(FileAreaObservational observationalFileArea)
          Returns a list of TableBinary objects given an observation file area object.
 List<TableCharacter> getTableCharacters(FileAreaObservational observationalFileArea)
          Returns a list of TableCharacter objects given an observation file area object.
 List<TableDelimited> getTableDelimiteds(FileAreaObservational observationalFileArea)
          Returns a list of TableDelimited objects given an observation file area object.
 List<Object> getTableObjects(FileAreaObservational observationalFileArea)
          Returns a list of table objects.
 void setObservationalProduct(String relativeXmlFilePath, ProductObservational product)
          Writes a label given the product XML file.
 

Method Detail

getArchiveRoot

String getArchiveRoot()
Gets the root file path of the object archive(s) for this ObjectProvider.

Returns:
the root file path of the object archive(s) for this ObjectProvider

getRoot

File getRoot()
Gets the root file path of the object archive(s) for this ObjectProvider.

Returns:
the root file path of the object archive(s) for this ObjectProvider

getArray2DImages

List<Array2DImage> getArray2DImages(FileAreaObservational observationalFileArea)
Returns a list of Array2DImage objects given an observation file area object.

Parameters:
observationalFileArea -
Returns:

getTableObjects

List<Object> getTableObjects(FileAreaObservational observationalFileArea)
Returns a list of table objects.

Parameters:
observationalFileArea -
Returns:

getTableCharacters

List<TableCharacter> getTableCharacters(FileAreaObservational observationalFileArea)
Returns a list of TableCharacter objects given an observation file area object.

Parameters:
observationalFileArea -
Returns:
list of TableCharacter objects

getTableBinaries

List<TableBinary> getTableBinaries(FileAreaObservational observationalFileArea)
Returns a list of TableBinary objects given an observation file area object.

Parameters:
observationalFileArea -
Returns:
list of TableBinary objects

getTableDelimiteds

List<TableDelimited> getTableDelimiteds(FileAreaObservational observationalFileArea)
Returns a list of TableDelimited objects given an observation file area object.

Parameters:
observationalFileArea -
Returns:
list of TableDelimited objects

getFieldCharacters

List<FieldCharacter> getFieldCharacters(TableCharacter table)
Returns a list of FieldCharacter objects given a table character object.

Parameters:
table - TableCharacter object
Returns:
list of FieldCharacter objects

getFieldBinaries

List<FieldBinary> getFieldBinaries(TableBinary table)
Returns a list of FieldBinary objects given a table binary object.

Parameters:
table - TableBinary object
Returns:

getObservationalProduct

ProductObservational getObservationalProduct(String relativeXmlFilePath)
Gets an instance of ProductObservational.

Parameters:
relativeXmlFilePath - the XML file path and name of the product to obtain, relative to the ObjectAccess archive root
Returns:
an instance of ProductObservational

getProduct

<T> T getProduct(File labelFile,
                 Class<T> productClass)
             throws ParseException
Reads a product label of a specified class, and returns an instance of that class as a result.

Type Parameters:
T - the product object class
Parameters:
labelFile - the file containing the XML label
productClass - the product object class
Returns:
an instance of the product object
Throws:
ParseException - if there is an error parsing the label

setObservationalProduct

void setObservationalProduct(String relativeXmlFilePath,
                             ProductObservational product)
Writes a label given the product XML file.

Parameters:
relativeXmlFilePath - the XML file path and name of the product to set, relative to the ObjectAccess archive root


Copyright © 2014. All Rights Reserved.