org.autoplot.pds

Class Pds3DataSourceFactory

java.lang.Object

org.autoplot.datasource.AbstractDataSourceFactory

org.autoplot.pds.Pds3DataSourceFactory

All Implemented Interfaces:

DataSourceFactory

public class Pds3DataSourceFactory
extends AbstractDataSourceFactory

Factory for resolving PDS3 URIs.

Constructor Summary

Constructors

Constructor and Description
Pds3DataSourceFactory()

Method Summary

Modifier and Type	Method and Description
java.util.List<CompletionContext>	getCompletions(CompletionContext cc, ProgressMonitor mon) return a list of context-sensitive completions.
static PDS3DataObject	getDataObjectPds3(java.net.URL url, java.lang.String name) return information about how this data is stored in PDS3DataObject.
DataSource	getDataSource(java.net.URI uri) return a dataSource for the url
static org.w3c.dom.Document	getDocumentWithImports(java.net.URL labelUrl) read in the PDS label, resolving STRUCTURES which are loaded with a pointer.
static org.w3c.dom.Document	getDocumentWithImports(java.net.URL labelUrl, int depth) read in the PDS label, resolving STRUCTURES which are loaded with a pointer.
protected static FilePointer	getFileResource(java.net.URL labelFile, ProgressMonitor mon)
static java.net.URL	identifyRoot(java.net.URL location) identify the root of the volume.This was motivated by a LABL in SOFTWARE in a volume which didn't have DATA, and I had everything mounted in /project/pds/mirror/DATA.The root will often have DATA, DOCUMENT, and a README.txt file.
boolean	reject(java.lang.String suri, java.util.List<java.lang.String> problems, ProgressMonitor mon) quick check to see that an uri looks acceptable.

Methods inherited from class org.autoplot.datasource.AbstractDataSourceFactory

getCapability, getDescription, isFileResource, supportsDiscovery

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pds3DataSourceFactory

public Pds3DataSourceFactory()

Method Detail

getDataSource

public DataSource getDataSource(java.net.URI uri)
                         throws java.lang.Exception

Description copied from interface: DataSourceFactory

return a dataSource for the url

Specified by:

getDataSource in interface DataSourceFactory

Specified by:

getDataSource in class AbstractDataSourceFactory

Parameters:

uri - the URI

Returns:

the DataSource

Throws:

java.lang.Exception - any exception may occur.

getDataObjectPds3

public static PDS3DataObject getDataObjectPds3(java.net.URL url,
                                               java.lang.String name)
                                        throws java.io.IOException,
                                               PDSException,
                                               javax.xml.xpath.XPathExpressionException

return information about how this data is stored in PDS3DataObject.

Parameters:

url - URL of label

name - the object name

Returns:

PDS3DataObject

Throws:

java.io.IOException

PDSException

javax.xml.xpath.XPathExpressionException

reject

public boolean reject(java.lang.String suri,
                      java.util.List<java.lang.String> problems,
                      ProgressMonitor mon)

Description copied from interface: DataSourceFactory

quick check to see that an uri looks acceptable. since 2012b, this should provide a list of objects marking reasons for rejecting. Though each object is simply a marker, toString method of each should provide some meaningful information to developers. This list will be passed into the editor if available.

Specified by:

reject in interface DataSourceFactory

Overrides:

reject in class AbstractDataSourceFactory

Parameters:

suri - the uri.

problems - list to which problems should be added. TODO: human readable or PROB_TIMERANGE?

mon - a progress monitor, for example to monitor a file download.

Returns:

true if the string cannot be used as a URI.

getDocumentWithImports

public static org.w3c.dom.Document getDocumentWithImports(java.net.URL labelUrl)
                                                   throws java.io.IOException,
                                                          PDSException

read in the PDS label, resolving STRUCTURES which are loaded with a pointer. This will look in the current directory, and in the LABEL directory next to the DATA directory.

Parameters:

labelUrl - the URL of the LABEL file

Returns:

a document model of the LABEL, with imports resolved.

Throws:

java.io.IOException

PDSException

identifyRoot

public static java.net.URL identifyRoot(java.net.URL location)
                                 throws FileSystem.FileSystemOfflineException,
                                        java.net.UnknownHostException,
                                        java.io.FileNotFoundException,
                                        java.io.IOException

identify the root of the volume.This was motivated by a LABL in SOFTWARE in a volume which didn't have DATA, and I had everything mounted in /project/pds/mirror/DATA.The root will often have DATA, DOCUMENT, and a README.txt file.

Parameters:

location - a location within the volume

Returns:

the root of the volume or null if it can't be found.

Throws:

FileSystem.FileSystemOfflineException

java.net.UnknownHostException

java.io.FileNotFoundException

java.io.IOException

getDocumentWithImports

public static org.w3c.dom.Document getDocumentWithImports(java.net.URL labelUrl,
                                                          int depth)
                                                   throws java.io.IOException,
                                                          PDSException

read in the PDS label, resolving STRUCTURES which are loaded with a pointer. This will look in the current directory, and in the LABEL directory next to the DATA directory. Note the Pointer must appear at /LABEL/*/POINTER[@object="STRUCTURE"] or /LABEL/POINTER[@object="STRUCTURE"], and Pointer is left in the Document.

Parameters:

labelUrl - the URL of the LABEL file

depth - number of levels deep, this is limited to 4.

Returns:

a document model of the LABEL, with imports resolved.

Throws:

java.io.IOException

PDSException

getFileResource

protected static FilePointer getFileResource(java.net.URL labelFile,
                                             ProgressMonitor mon)
                                      throws java.io.IOException,
                                             java.net.URISyntaxException,
                                             javax.xml.parsers.ParserConfigurationException,
                                             org.xml.sax.SAXException,
                                             javax.xml.xpath.XPathExpressionException,
                                             PDSException

Throws:

java.io.IOException

java.net.URISyntaxException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

javax.xml.xpath.XPathExpressionException

PDSException

getCompletions

public java.util.List<CompletionContext> getCompletions(CompletionContext cc,
                                                        ProgressMonitor mon)
                                                 throws java.lang.Exception

Description copied from interface: DataSourceFactory

return a list of context-sensitive completions. If an exception is thrown, then an a error dialog is displayed for RuntimeExceptions. Compile-time exceptions may be displayed more gently, relying on getMessage to aid the human operator.

Specified by:

getCompletions in interface DataSourceFactory

Overrides:

getCompletions in class AbstractDataSourceFactory

Parameters:

cc - the context for the completion.

mon - a progress monitor, for example to monitor a file download.

Returns:

a set of completions

Throws:

java.lang.Exception