Package gov.nasa.pds.objectAccess
Class ObjectAccess
java.lang.Object
gov.nasa.pds.objectAccess.ObjectAccess
- All Implemented Interfaces:
- ObjectProvider
public class ObjectAccess extends Object implements ObjectProvider
The 
ObjectAccess class is a point of entry into parsed PDS (including PDS 4/XML-schema-labeled) objects.- Author:
- dcberrio
- 
Constructor SummaryConstructors Constructor Description ObjectAccess()Creates a new instance with the current local directory as the archive root path.ObjectAccess(File archiveRoot)Constructs anObjectAccessobject and sets the archive root path.ObjectAccess(String archiveRoot)Constructs anObjectAccessobject and sets the archive root path.ObjectAccess(URL archiveRoot)Constructs anObjectAccessobject and sets the archive root path.
- 
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)XMLLabelContextgetXMLLabelContext()voidsetObservationalProduct(String relativeXmlFilePath, ProductObservational product)Writes a label given the product XML file.voidsetObservationalProduct(String relativeXmlFilePath, ProductObservational product, XMLLabelContext labelContext)Writes a label given the product XML file.
- 
Constructor Details- 
ObjectAccessCreates a new instance with the current local directory as the archive root path.
- 
ObjectAccessConstructs anObjectAccessobject and sets the archive root path.- Parameters:
- archiveRoot- the archive root path
- Throws:
- URISyntaxException
- MalformedURLException
- Exception
 
- 
ObjectAccessConstructs anObjectAccessobject and sets the archive root path.- Parameters:
- archiveRoot- the archive root path
- Throws:
- URISyntaxException
- MalformedURLException
- Exception
 
- 
ObjectAccessConstructs anObjectAccessobject and sets the archive root path.- Parameters:
- archiveRoot- the archive root path
- Throws:
- URISyntaxException
- MalformedURLException
 
 
- 
- 
Method Details- 
getProductDescription copied from interface:ObjectProviderReads a product label of a specified class, and returns an instance of that class as a result.- Specified by:
- getProductin interface- ObjectProvider
- 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
 
- 
getProductDescription copied from interface:ObjectProviderReads a product label of a specified class, and returns an instance of that class as a result.- Specified by:
- getProductin interface- ObjectProvider
- 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
 
- 
getObservationalProductDescription copied from interface:ObjectProviderGets an instance of ProductObservational.- Specified by:
- getObservationalProductin interface- ObjectProvider
- Parameters:
- relativeXmlFilePath- the XML file path and name of the product to obtain, relative to the ObjectAccess archive root
- Returns:
- an instance of ProductObservational
 
- 
setObservationalProductpublic void setObservationalProduct(String relativeXmlFilePath, ProductObservational product) throws ExceptionDescription copied from interface:ObjectProviderWrites a label given the product XML file.- Specified by:
- setObservationalProductin interface- ObjectProvider
- 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
 
- 
setObservationalProductpublic void setObservationalProduct(String relativeXmlFilePath, ProductObservational product, XMLLabelContext labelContext) throws ExceptionWrites a label given the product XML file. This method assumes that the label will be written to the local file system. Therefore, the protocol of the ObjectAccess archive root must be a 'file'.- Specified by:
- setObservationalProductin interface- ObjectProvider
- 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.
- labelContext- 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.
 
- 
getArraysDescription copied from interface:ObjectProviderGets a list of Array objects from a file area.- Specified by:
- getArraysin interface- ObjectProvider
- Parameters:
- fileArea- the file area.
- Returns:
- an list of arrays, which may be empty.
 
- 
getArraysDescription copied from interface:ObjectProviderGets a list of Array objects from an observational file area.- Specified by:
- getArraysin interface- ObjectProvider
- Parameters:
- fileArea- the observational file area.
- Returns:
- an list of arrays, which may be empty.
 
- 
getArraysDescription copied from interface:ObjectProviderGets a list of Array objects from a browse file area.- Specified by:
- getArraysin interface- ObjectProvider
- Parameters:
- fileArea- the browse file area
- Returns:
- an list of arrays, which may be empty
 
- 
getArray2DImagesDescription copied from interface:ObjectProviderReturns a list of Array2DImage objects given an observation file area object.- Specified by:
- getArray2DImagesin interface- ObjectProvider
- Returns:
- a list of image objects
 
- 
getArray3DImagesDescription copied from interface:ObjectProviderReturns a list of Array3DImage objects given an observation file area object.- Specified by:
- getArray3DImagesin interface- ObjectProvider
- Returns:
- a list of image objects
 
- 
getArray3DSpectrumsDescription copied from interface:ObjectProviderReturns a list of Array3DSpectrum objects given an observation file area object.- Specified by:
- getArray3DSpectrumsin interface- ObjectProvider
- Returns:
- a list of image objects
 
- 
getHeaderObjects- Specified by:
- getHeaderObjectsin interface- ObjectProvider
 
- 
getHeaderObjectsDescription copied from interface:ObjectProviderReturns a list of Header objects- Specified by:
- getHeaderObjectsin interface- ObjectProvider
- Returns:
- a list of Header objects
 
- 
getHeaderObjects- Specified by:
- getHeaderObjectsin interface- ObjectProvider
 
- 
getHeaderObjects- Specified by:
- getHeaderObjectsin interface- ObjectProvider
 
- 
getTableObjectsDescription copied from interface:ObjectProviderReturns a list of table objects.- Specified by:
- getTableObjectsin interface- ObjectProvider
- Returns:
- a list of table objects
 
- 
getTableObjects- Specified by:
- getTableObjectsin interface- ObjectProvider
 
- 
getTableObjects- Specified by:
- getTableObjectsin interface- ObjectProvider
 
- 
getTableObjectspublic List<Object> getTableObjects(FileAreaObservationalSupplemental observationalFileAreaSupplemental)- Specified by:
- getTableObjectsin interface- ObjectProvider
 
- 
getTableObjects- Specified by:
- getTableObjectsin interface- ObjectProvider
 
- 
getTablesAndImages- Specified by:
- getTablesAndImagesin interface- ObjectProvider
 
- 
getTablesAndImages- Specified by:
- getTablesAndImagesin interface- ObjectProvider
 
- 
getTablesAndImages- Specified by:
- getTablesAndImagesin interface- ObjectProvider
 
- 
getTableCharactersDescription copied from interface:ObjectProviderReturns a list of TableCharacter objects given an observation file area object.- Specified by:
- getTableCharactersin interface- ObjectProvider
- Returns:
- list of TableCharacter objects
 
- 
getTableBinariesDescription copied from interface:ObjectProviderReturns a list of TableBinary objects given an observation file area object.- Specified by:
- getTableBinariesin interface- ObjectProvider
- Returns:
- list of TableBinary objects
 
- 
getTableDelimitedsDescription copied from interface:ObjectProviderReturns a list of TableDelimited objects given an observation file area object.- Specified by:
- getTableDelimitedsin interface- ObjectProvider
- Returns:
- list of TableDelimited objects
 
- 
getFieldCharactersDescription copied from interface:ObjectProviderReturns a list of FieldCharacter objects given a table character object.- Specified by:
- getFieldCharactersin interface- ObjectProvider
- Parameters:
- table- TableCharacter object
- Returns:
- list of FieldCharacter objects
 
- 
getFieldDelimitedsDescription copied from interface:ObjectProviderReturns a list of FieldDelimited objects given a table delimited object.- Specified by:
- getFieldDelimitedsin interface- ObjectProvider
- Parameters:
- table- TableDelimited object
- Returns:
- list of FieldDelimited objects
 
- 
getGroupFieldDelimitedsDescription copied from interface:ObjectProviderReturns a list of GroupFieldDelimited objects given a table delimited object.- Specified by:
- getGroupFieldDelimitedsin interface- ObjectProvider
- Parameters:
- table- TableDelimited object
- Returns:
- list of GroupFieldDelimited objects
 
- 
getFieldDelimitedAndGroupFieldDelimitedsDescription copied from interface:ObjectProviderReturns a list of FieldDelimited and GroupFieldDelimited objects given a table delimited object.- Specified by:
- getFieldDelimitedAndGroupFieldDelimitedsin interface- ObjectProvider
- Parameters:
- table- TableDelimited object
- Returns:
- list of FieldDelimited and GroupFieldDelimited objects
 
- 
getFieldCharacterAndGroupFieldCharactersDescription copied from interface:ObjectProviderReturns a list of FieldCharacter and GroupFieldCharacter objects given a table character object.- Specified by:
- getFieldCharacterAndGroupFieldCharactersin interface- ObjectProvider
- Parameters:
- table- TableCharacter object
- Returns:
- list of FieldCharacter and GroupFieldCharacter objects
 
- 
getFieldBinaryAndGroupFieldBinariesDescription copied from interface:ObjectProviderReturns a list of FieldBinary and GroupFieldBinary objects given a table binary object.- Specified by:
- getFieldBinaryAndGroupFieldBinariesin interface- ObjectProvider
- Parameters:
- table- TableBinary object
- Returns:
- list of FieldBinary and GroupFieldBinary objects
 
- 
getFieldBinariesDescription copied from interface:ObjectProviderReturns a list of FieldBinary objects given a table binary object.- Specified by:
- getFieldBinariesin interface- ObjectProvider
- Parameters:
- table- TableBinary object
- Returns:
- list of FieldBinary objects
 
- 
getArchiveRootDescription copied from interface:ObjectProviderGets the root file path of the object archive(s) for this ObjectProvider.- Specified by:
- getArchiveRootin interface- ObjectProvider
- Returns:
- the root file path of the object archive(s) for this ObjectProvider
 
- 
getRootDescription copied from interface:ObjectProviderGets the root file path of the object archive(s) for this ObjectProvider.- Specified by:
- getRootin interface- ObjectProvider
- Returns:
- the root file path of the object archive(s) for this ObjectProvider
 
- 
getXMLLabelContext
 
-