public interface ObjectProvider
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getArchiveRoot()
Gets the root file path of the object archive(s) for this ObjectProvider.
|
java.util.List<Array2DImage> |
getArray2DImages(FileAreaObservational observationalFileArea)
Returns a list of Array2DImage objects given an observation file area object.
|
java.util.List<Array3DImage> |
getArray3DImages(FileAreaObservational observationalFileArea)
Returns a list of Array3DImage objects given an observation file area object.
|
java.util.List<Array3DSpectrum> |
getArray3DSpectrums(FileAreaObservational observationalFileArea)
Returns a list of Array3DSpectrum objects given an observation file area object.
|
java.util.List<Array> |
getArrays(FileArea fileArea)
Gets a list of Array objects from a file area.
|
java.util.List<Array> |
getArrays(FileAreaBrowse fileArea)
Gets a list of Array objects from a browse file area.
|
java.util.List<Array> |
getArrays(FileAreaObservational fileArea)
Gets a list of Array objects from an observational file area.
|
java.util.List<java.lang.Object> |
getDataObjects(Product product) |
java.util.List<FieldBinary> |
getFieldBinaries(TableBinary table)
Returns a list of FieldBinary objects given a table binary object.
|
java.util.List<java.lang.Object> |
getFieldBinaryAndGroupFieldBinaries(TableBinary table)
Returns a list of FieldBinary and GroupFieldBinary objects given a table binary object.
|
java.util.List<java.lang.Object> |
getFieldCharacterAndGroupFieldCharacters(TableCharacter table)
Returns a list of FieldCharacter and GroupFieldCharacter objects given a table character
object.
|
java.util.List<FieldCharacter> |
getFieldCharacters(TableCharacter table)
Returns a list of FieldCharacter objects given a table character object.
|
java.util.List<java.lang.Object> |
getFieldDelimitedAndGroupFieldDelimiteds(TableDelimited table)
Returns a list of FieldDelimited and GroupFieldDelimited objects given a table delimited
object.
|
java.util.List<FieldDelimited> |
getFieldDelimiteds(TableDelimited table)
Returns a list of FieldDelimited objects given a table delimited object.
|
java.util.List<GroupFieldDelimited> |
getGroupFieldDelimiteds(TableDelimited table)
Returns a list of GroupFieldDelimited objects given a table delimited object.
|
java.util.List<java.lang.Object> |
getHeaderObjects(FileArea fileArea) |
java.util.List<java.lang.Object> |
getHeaderObjects(FileAreaAncillary anciilaryFileArea) |
java.util.List<java.lang.Object> |
getHeaderObjects(FileAreaBrowse browseFileArea) |
java.util.List<java.lang.Object> |
getHeaderObjects(FileAreaObservational observationalFileArea)
Returns a list of Header objects
|
long |
getObjectLength(java.lang.Object obj) |
ProductObservational |
getObservationalProduct(java.lang.String relativeXmlFilePath)
Gets an instance of ProductObservational.
|
long |
getOffset(java.lang.Object obj) |
<T> T |
getProduct(java.io.File labelFile,
java.lang.Class<T> productClass)
Reads a product label of a specified class, and returns an instance of that class as a result.
|
<T> T |
getProduct(java.net.URL label,
java.lang.Class<T> productClass)
Reads a product label of a specified class, and returns an instance of that class as a result.
|
java.net.URL |
getRoot()
Gets the root file path of the object archive(s) for this ObjectProvider.
|
java.util.List<TableBinary> |
getTableBinaries(FileAreaObservational observationalFileArea)
Returns a list of TableBinary objects given an observation file area object.
|
java.util.List<TableCharacter> |
getTableCharacters(FileAreaObservational observationalFileArea)
Returns a list of TableCharacter objects given an observation file area object.
|
java.util.List<TableDelimited> |
getTableDelimiteds(FileAreaObservational observationalFileArea)
Returns a list of TableDelimited objects given an observation file area object.
|
java.util.List<java.lang.Object> |
getTableObjects(FileArea fileArea) |
java.util.List<java.lang.Object> |
getTableObjects(FileAreaAncillary anciilaryFileArea) |
java.util.List<java.lang.Object> |
getTableObjects(FileAreaBrowse browseFileArea) |
java.util.List<java.lang.Object> |
getTableObjects(FileAreaObservational observationalFileArea)
Returns a list of table objects.
|
java.util.List<java.lang.Object> |
getTableObjects(FileAreaObservationalSupplemental observationalFileAreaSupplemental) |
java.util.List<java.lang.Object> |
getTablesAndImages(FileArea fileArea) |
java.util.List<java.lang.Object> |
getTablesAndImages(FileAreaBrowse browseFileArea) |
java.util.List<java.lang.Object> |
getTablesAndImages(FileAreaObservational observationalFileArea) |
void |
setObservationalProduct(java.lang.String relativeXmlFilePath,
ProductObservational product)
Writes a label given the product XML file.
|
void |
setObservationalProduct(java.lang.String relativeXmlFilePath,
ProductObservational product,
XMLLabelContext context)
Writes a label given the product XML file.
|
java.lang.String getArchiveRoot()
java.net.URL getRoot()
java.util.List<java.lang.Object> getDataObjects(Product product) throws ParseException
ParseException
java.util.List<Array> getArrays(FileArea fileArea)
fileArea
- the file area.java.util.List<Array> getArrays(FileAreaObservational fileArea)
fileArea
- the observational file area.java.util.List<Array> getArrays(FileAreaBrowse fileArea)
fileArea
- the browse file areajava.util.List<Array2DImage> getArray2DImages(FileAreaObservational observationalFileArea)
observationalFileArea
- java.util.List<Array3DImage> getArray3DImages(FileAreaObservational observationalFileArea)
observationalFileArea
- java.util.List<Array3DSpectrum> getArray3DSpectrums(FileAreaObservational observationalFileArea)
observationalFileArea
- java.util.List<java.lang.Object> getTableObjects(FileAreaObservational observationalFileArea)
observationalFileArea
- java.util.List<java.lang.Object> getTableObjects(FileAreaBrowse browseFileArea)
java.util.List<java.lang.Object> getTableObjects(FileAreaAncillary anciilaryFileArea)
java.util.List<java.lang.Object> getTableObjects(FileAreaObservationalSupplemental observationalFileAreaSupplemental)
java.util.List<java.lang.Object> getTableObjects(FileArea fileArea)
java.util.List<java.lang.Object> getTablesAndImages(FileAreaObservational observationalFileArea)
java.util.List<java.lang.Object> getTablesAndImages(FileAreaBrowse browseFileArea)
java.util.List<java.lang.Object> getTablesAndImages(FileArea fileArea)
java.util.List<java.lang.Object> getHeaderObjects(FileAreaObservational observationalFileArea)
observationalFileArea
- java.util.List<java.lang.Object> getHeaderObjects(FileAreaBrowse browseFileArea)
java.util.List<java.lang.Object> getHeaderObjects(FileAreaAncillary anciilaryFileArea)
java.util.List<java.lang.Object> getHeaderObjects(FileArea fileArea)
java.util.List<TableCharacter> getTableCharacters(FileAreaObservational observationalFileArea)
observationalFileArea
- java.util.List<TableBinary> getTableBinaries(FileAreaObservational observationalFileArea)
observationalFileArea
- java.util.List<TableDelimited> getTableDelimiteds(FileAreaObservational observationalFileArea)
observationalFileArea
- java.util.List<FieldCharacter> getFieldCharacters(TableCharacter table)
table
- TableCharacter objectjava.util.List<FieldBinary> getFieldBinaries(TableBinary table)
table
- TableBinary objectjava.util.List<FieldDelimited> getFieldDelimiteds(TableDelimited table)
table
- TableDelimited objectjava.util.List<GroupFieldDelimited> getGroupFieldDelimiteds(TableDelimited table)
table
- TableDelimited objectjava.util.List<java.lang.Object> getFieldDelimitedAndGroupFieldDelimiteds(TableDelimited table)
table
- TableDelimited objectjava.util.List<java.lang.Object> getFieldCharacterAndGroupFieldCharacters(TableCharacter table)
table
- TableCharacter objectjava.util.List<java.lang.Object> getFieldBinaryAndGroupFieldBinaries(TableBinary table)
table
- TableBinary objectProductObservational getObservationalProduct(java.lang.String relativeXmlFilePath)
relativeXmlFilePath
- the XML file path and name of the product to obtain, relative to the
ObjectAccess archive root<T> T getProduct(java.io.File labelFile, java.lang.Class<T> productClass) throws ParseException
T
- the product object classlabelFile
- the file containing the XML labelproductClass
- the product object classParseException
- if there is an error parsing the label<T> T getProduct(java.net.URL label, java.lang.Class<T> productClass) throws ParseException
T
- the product object classlabel
- the url containing the XML labelproductClass
- the product object classParseException
- if there is an error parsing the labelvoid setObservationalProduct(java.lang.String relativeXmlFilePath, ProductObservational product) throws java.lang.Exception
relativeXmlFilePath
- the XML file path and name of the product to set, relative to the
ObjectAccess archive rootproduct
- The Product_Observational object to serialize into an XML file.java.lang.Exception
void setObservationalProduct(java.lang.String relativeXmlFilePath, ProductObservational product, XMLLabelContext context) throws java.lang.Exception
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.java.lang.Exception
- If there was an error creating the XML file.long getOffset(java.lang.Object obj) throws java.lang.Exception
java.lang.Exception
long getObjectLength(java.lang.Object obj) throws java.lang.Exception
java.lang.Exception
Copyright © 2023 Planetary Data System. All rights reserved.