Package gov.nasa.pds.objectAccess
Interface ObjectProvider
- All Known Implementing Classes:
- ObjectAccess
public interface ObjectProvider
Provides access to PDS4 objects.
- 
Method SummaryModifier and Type Method Description StringgetArchiveRoot()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<Array3DImage>getArray3DImages(FileAreaObservational observationalFileArea)Returns a list of Array3DImage objects given an observation file area object.List<Array3DSpectrum>getArray3DSpectrums(FileAreaObservational observationalFileArea)Returns a list of Array3DSpectrum objects given an observation file area object.List<Array>getArrays(FileArea fileArea)Gets a list of Array objects from a file area.List<Array>getArrays(FileAreaBrowse fileArea)Gets a list of Array objects from a browse file area.List<Array>getArrays(FileAreaObservational fileArea)Gets a list of Array objects from an observational file area.List<FieldBinary>getFieldBinaries(TableBinary table)Returns a list of FieldBinary objects given a table binary object.List<Object>getFieldBinaryAndGroupFieldBinaries(TableBinary table)Returns a list of FieldBinary and GroupFieldBinary objects given a table binary object.List<Object>getFieldCharacterAndGroupFieldCharacters(TableCharacter table)Returns a list of FieldCharacter and GroupFieldCharacter objects given a table character object.List<FieldCharacter>getFieldCharacters(TableCharacter table)Returns a list of FieldCharacter objects given a table character object.List<Object>getFieldDelimitedAndGroupFieldDelimiteds(TableDelimited table)Returns a list of FieldDelimited and GroupFieldDelimited objects given a table delimited object.List<FieldDelimited>getFieldDelimiteds(TableDelimited table)Returns a list of FieldDelimited objects given a table delimited object.List<GroupFieldDelimited>getGroupFieldDelimiteds(TableDelimited table)Returns a list of GroupFieldDelimited objects given a table delimited object.List<Object>getHeaderObjects(FileArea fileArea)List<Object>getHeaderObjects(FileAreaAncillary anciilaryFileArea)List<Object>getHeaderObjects(FileAreaBrowse browseFileArea)List<Object>getHeaderObjects(FileAreaObservational observationalFileArea)Returns a list of Header objectsProductObservationalgetObservationalProduct(String relativeXmlFilePath)Gets an instance of ProductObservational.<T> TgetProduct(File labelFile, Class<T> productClass)Reads a product label of a specified class, and returns an instance of that class as a result.<T> TgetProduct(URL label, Class<T> productClass)Reads a product label of a specified class, and returns an instance of that class as a result.URLgetRoot()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(FileArea fileArea)List<Object>getTableObjects(FileAreaAncillary anciilaryFileArea)List<Object>getTableObjects(FileAreaBrowse browseFileArea)List<Object>getTableObjects(FileAreaObservational observationalFileArea)Returns a list of table objects.List<Object>getTableObjects(FileAreaObservationalSupplemental observationalFileAreaSupplemental)List<Object>getTablesAndImages(FileArea fileArea)List<Object>getTablesAndImages(FileAreaBrowse browseFileArea)List<Object>getTablesAndImages(FileAreaObservational observationalFileArea)voidsetObservationalProduct(String relativeXmlFilePath, ProductObservational product)Writes a label given the product XML file.voidsetObservationalProduct(String relativeXmlFilePath, ProductObservational product, XMLLabelContext context)Writes a label given the product XML file.
- 
Method Details- 
getArchiveRootString 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
 
- 
getRootURL 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
 
- 
getArraysGets a list of Array objects from a file area.- Parameters:
- fileArea- the file area.
- Returns:
- an list of arrays, which may be empty.
 
- 
getArraysGets a list of Array objects from an observational file area.- Parameters:
- fileArea- the observational file area.
- Returns:
- an list of arrays, which may be empty.
 
- 
getArraysGets a list of Array objects from a browse file area.- Parameters:
- fileArea- the browse file area
- Returns:
- an list of arrays, which may be empty
 
- 
getArray2DImagesReturns a list of Array2DImage objects given an observation file area object.- Parameters:
- observationalFileArea-
- Returns:
- a list of image objects
 
- 
getArray3DImagesReturns a list of Array3DImage objects given an observation file area object.- Parameters:
- observationalFileArea-
- Returns:
- a list of image objects
 
- 
getArray3DSpectrumsReturns a list of Array3DSpectrum objects given an observation file area object.- Parameters:
- observationalFileArea-
- Returns:
- a list of image objects
 
- 
getTableObjectsReturns a list of table objects.- Parameters:
- observationalFileArea-
- Returns:
- a list of table objects
 
- 
getTableObjects
- 
getTableObjects
- 
getTableObjects
- 
getTableObjects
- 
getTablesAndImages
- 
getTablesAndImages
- 
getTablesAndImages
- 
getHeaderObjectsReturns a list of Header objects- Parameters:
- observationalFileArea-
- Returns:
- a list of Header objects
 
- 
getHeaderObjects
- 
getHeaderObjects
- 
getHeaderObjects
- 
getTableCharactersReturns a list of TableCharacter objects given an observation file area object.- Parameters:
- observationalFileArea-
- Returns:
- list of TableCharacter objects
 
- 
getTableBinariesReturns a list of TableBinary objects given an observation file area object.- Parameters:
- observationalFileArea-
- Returns:
- list of TableBinary objects
 
- 
getTableDelimitedsReturns a list of TableDelimited objects given an observation file area object.- Parameters:
- observationalFileArea-
- Returns:
- list of TableDelimited objects
 
- 
getFieldCharactersReturns a list of FieldCharacter objects given a table character object.- Parameters:
- table- TableCharacter object
- Returns:
- list of FieldCharacter objects
 
- 
getFieldBinariesReturns a list of FieldBinary objects given a table binary object.- Parameters:
- table- TableBinary object
- Returns:
- list of FieldBinary objects
 
- 
getFieldDelimitedsReturns a list of FieldDelimited objects given a table delimited object.- Parameters:
- table- TableDelimited object
- Returns:
- list of FieldDelimited objects
 
- 
getGroupFieldDelimitedsReturns a list of GroupFieldDelimited objects given a table delimited object.- Parameters:
- table- TableDelimited object
- Returns:
- list of GroupFieldDelimited objects
 
- 
getFieldDelimitedAndGroupFieldDelimitedsReturns a list of FieldDelimited and GroupFieldDelimited objects given a table delimited object.- Parameters:
- table- TableDelimited object
- Returns:
- list of FieldDelimited and GroupFieldDelimited objects
 
- 
getFieldCharacterAndGroupFieldCharactersReturns a list of FieldCharacter and GroupFieldCharacter objects given a table character object.- Parameters:
- table- TableCharacter object
- Returns:
- list of FieldCharacter and GroupFieldCharacter objects
 
- 
getFieldBinaryAndGroupFieldBinariesReturns a list of FieldBinary and GroupFieldBinary objects given a table binary object.- Parameters:
- table- TableBinary object
- Returns:
- list of FieldBinary and GroupFieldBinary objects
 
- 
getObservationalProductGets 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
 
- 
getProductReads 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
 
- 
getProductReads 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:
- label- the url 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
 
- 
setObservationalProductvoid setObservationalProduct(String relativeXmlFilePath, ProductObservational product) throws ExceptionWrites 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
- product- The Product_Observational object to serialize into an XML file.
- Throws:
- Exception
 
- 
setObservationalProductvoid setObservationalProduct(String relativeXmlFilePath, ProductObservational product, XMLLabelContext context) throws ExceptionWrites 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.
- product- The Product_Observational object to serialize into an XML file.
- context- A context to use when creating the XML file. Can be set to null.
- Throws:
- Exception- If there was an error creating the XML file.
 
 
-