public class ObjectAccess extends Object implements ObjectProvider
ObjectAccess class is a point of entry into parsed PDS (including PDS 4/XML-schema-labeled) objects.| Constructor and Description |
|---|
ObjectAccess()
Creates a new instance with the current local directory as the archive root
path.
|
ObjectAccess(File archiveRoot)
Constructs an
ObjectAccess object and sets the archive root path. |
ObjectAccess(String archiveRoot)
Constructs an
ObjectAccess object and sets the archive root path. |
ObjectAccess(URL archiveRoot)
Constructs an
ObjectAccess object and sets the archive root path. |
| Modifier and Type | Method and Description |
|---|---|
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<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 objects
|
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.
|
<T> T |
getProduct(URL label,
Class<T> productClass)
Reads a product label of a specified class, and returns an instance of that class
as a result.
|
URL |
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(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) |
XMLLabelContext |
getXMLLabelContext() |
void |
setObservationalProduct(String relativeXmlFilePath,
ProductObservational product)
Writes a label given the product XML file.
|
void |
setObservationalProduct(String relativeXmlFilePath,
ProductObservational product,
XMLLabelContext labelContext)
Writes a label given the product XML file.
|
public ObjectAccess()
throws MalformedURLException,
URISyntaxException
public ObjectAccess(String archiveRoot) throws MalformedURLException, URISyntaxException
ObjectAccess object and sets the archive root path.archiveRoot - the archive root pathURISyntaxExceptionMalformedURLExceptionExceptionpublic ObjectAccess(File archiveRoot) throws MalformedURLException, URISyntaxException
ObjectAccess object and sets the archive root path.archiveRoot - the archive root pathURISyntaxExceptionMalformedURLExceptionExceptionpublic ObjectAccess(URL archiveRoot) throws URISyntaxException, MalformedURLException
ObjectAccess object and sets the archive root path.archiveRoot - the archive root pathURISyntaxExceptionMalformedURLExceptionpublic <T> T getProduct(File labelFile, Class<T> productClass) throws ParseException
ObjectProvidergetProduct in interface ObjectProviderT - the product object classlabelFile - the file containing the XML labelproductClass - the product object classParseException - if there is an error parsing the labelpublic <T> T getProduct(URL label, Class<T> productClass) throws ParseException
ObjectProvidergetProduct in interface ObjectProviderT - the product object classlabel - the url containing the XML labelproductClass - the product object classParseException - if there is an error parsing the labelpublic ProductObservational getObservationalProduct(String relativeXmlFilePath)
ObjectProvidergetObservationalProduct in interface ObjectProviderrelativeXmlFilePath - the XML file path and name of the product to obtain, relative
to the ObjectAccess archive rootpublic void setObservationalProduct(String relativeXmlFilePath, ProductObservational product) throws Exception
ObjectProvidersetObservationalProduct in interface ObjectProviderrelativeXmlFilePath - 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.Exceptionpublic void setObservationalProduct(String relativeXmlFilePath, ProductObservational product, XMLLabelContext labelContext) throws Exception
setObservationalProduct in interface ObjectProviderrelativeXmlFilePath - 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.labelContext - A context to use when creating the XML file. Can be set to null.Exception - If there was an error creating the XML file.public List<Array> getArrays(FileArea fileArea)
ObjectProvidergetArrays in interface ObjectProviderfileArea - the file area.public List<Array> getArrays(FileAreaObservational fileArea)
ObjectProvidergetArrays in interface ObjectProviderfileArea - the observational file area.public List<Array> getArrays(FileAreaBrowse fileArea)
ObjectProvidergetArrays in interface ObjectProviderfileArea - the browse file areapublic List<Array2DImage> getArray2DImages(FileAreaObservational observationalFileArea)
ObjectProvidergetArray2DImages in interface ObjectProviderpublic List<Array3DImage> getArray3DImages(FileAreaObservational observationalFileArea)
ObjectProvidergetArray3DImages in interface ObjectProviderpublic List<Array3DSpectrum> getArray3DSpectrums(FileAreaObservational observationalFileArea)
ObjectProvidergetArray3DSpectrums in interface ObjectProviderpublic List<Object> getHeaderObjects(FileAreaAncillary anciilaryFileArea)
getHeaderObjects in interface ObjectProviderpublic List<Object> getHeaderObjects(FileAreaObservational observationalFileArea)
ObjectProvidergetHeaderObjects in interface ObjectProviderpublic List<Object> getHeaderObjects(FileAreaBrowse browseFileArea)
getHeaderObjects in interface ObjectProviderpublic List<Object> getHeaderObjects(FileArea fileArea)
getHeaderObjects in interface ObjectProviderpublic List<Object> getTableObjects(FileAreaObservational observationalFileArea)
ObjectProvidergetTableObjects in interface ObjectProviderpublic List<Object> getTableObjects(FileAreaBrowse browseFileArea)
getTableObjects in interface ObjectProviderpublic List<Object> getTableObjects(FileAreaAncillary anciilaryFileArea)
getTableObjects in interface ObjectProviderpublic List<Object> getTableObjects(FileAreaObservationalSupplemental observationalFileAreaSupplemental)
getTableObjects in interface ObjectProviderpublic List<Object> getTableObjects(FileArea fileArea)
getTableObjects in interface ObjectProviderpublic List<Object> getTablesAndImages(FileArea fileArea)
getTablesAndImages in interface ObjectProviderpublic List<Object> getTablesAndImages(FileAreaObservational observationalFileArea)
getTablesAndImages in interface ObjectProviderpublic List<Object> getTablesAndImages(FileAreaBrowse browseFileArea)
getTablesAndImages in interface ObjectProviderpublic List<TableCharacter> getTableCharacters(FileAreaObservational observationalFileArea)
ObjectProvidergetTableCharacters in interface ObjectProviderpublic List<TableBinary> getTableBinaries(FileAreaObservational observationalFileArea)
ObjectProvidergetTableBinaries in interface ObjectProviderpublic List<TableDelimited> getTableDelimiteds(FileAreaObservational observationalFileArea)
ObjectProvidergetTableDelimiteds in interface ObjectProviderpublic List<FieldCharacter> getFieldCharacters(TableCharacter table)
ObjectProvidergetFieldCharacters in interface ObjectProvidertable - TableCharacter objectpublic List<FieldDelimited> getFieldDelimiteds(TableDelimited table)
ObjectProvidergetFieldDelimiteds in interface ObjectProvidertable - TableDelimited objectpublic List<GroupFieldDelimited> getGroupFieldDelimiteds(TableDelimited table)
ObjectProvidergetGroupFieldDelimiteds in interface ObjectProvidertable - TableDelimited objectpublic List<Object> getFieldDelimitedAndGroupFieldDelimiteds(TableDelimited table)
ObjectProvidergetFieldDelimitedAndGroupFieldDelimiteds in interface ObjectProvidertable - TableDelimited objectpublic List<Object> getFieldCharacterAndGroupFieldCharacters(TableCharacter table)
ObjectProvidergetFieldCharacterAndGroupFieldCharacters in interface ObjectProvidertable - TableCharacter objectpublic List<Object> getFieldBinaryAndGroupFieldBinaries(TableBinary table)
ObjectProvidergetFieldBinaryAndGroupFieldBinaries in interface ObjectProvidertable - TableBinary objectpublic List<FieldBinary> getFieldBinaries(TableBinary table)
ObjectProvidergetFieldBinaries in interface ObjectProvidertable - TableBinary objectpublic String getArchiveRoot()
ObjectProvidergetArchiveRoot in interface ObjectProviderpublic URL getRoot()
ObjectProvidergetRoot in interface ObjectProviderpublic XMLLabelContext getXMLLabelContext()
Copyright © 2020. All rights reserved.