gov.nasa.pds.harvest.crawler.metadata.extractor
Class Pds4MetExtractor

java.lang.Object
  extended by gov.nasa.pds.harvest.crawler.metadata.extractor.Pds4MetExtractor
All Implemented Interfaces:
gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Direct Known Subclasses:
BundleMetExtractor, CollectionMetExtractor

public class Pds4MetExtractor
extends Object
implements gov.nasa.jpl.oodt.cas.metadata.MetExtractor

Class to extract metadata from a PDS4 XML file.

Author:
mcayanan

Field Summary
protected  Pds4MetExtractorConfig config
          A metadata extraction configuration.
protected  XMLExtractor extractor
          An XMLExtractor to get the metadata.
 
Constructor Summary
Pds4MetExtractor(Pds4MetExtractorConfig config)
          Default constructor.
 
Method Summary
 gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(File product)
          Extract the metadata
 gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(File product, File configFile)
          No need to be implemented.
 gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(File product, gov.nasa.jpl.oodt.cas.metadata.MetExtractorConfig config)
          No need to be implemented.
 gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(File product, String configFile)
          No need to be implemented.
protected  gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(List<XPath> xPaths)
          Extracts metadata
 gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(String product)
          Extract the metadata.
 gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(URL product)
          Extract the metadata.
 gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(URL product, gov.nasa.jpl.oodt.cas.metadata.MetExtractorConfig config)
          No need to be implemented.
protected  List<ReferenceEntry> getReferences(List<net.sf.saxon.tinytree.TinyElementImpl> references, File product)
          Extracts the metadata found in an association entry.
 void setConfigFile(File configFile)
          No need to be implemented.
 void setConfigFile(gov.nasa.jpl.oodt.cas.metadata.MetExtractorConfig config)
           
 void setConfigFile(String configFile)
          No need to be implemented.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

config

protected Pds4MetExtractorConfig config
A metadata extraction configuration.


extractor

protected XMLExtractor extractor
An XMLExtractor to get the metadata.

Constructor Detail

Pds4MetExtractor

public Pds4MetExtractor(Pds4MetExtractorConfig config)
Default constructor.

Parameters:
config - The configuration that contains what metadata and what object types to extract.
Method Detail

extractMetadata

public gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(File product)
                                                        throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
Extract the metadata

Specified by:
extractMetadata in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Parameters:
product - A PDS4 xml file
Returns:
a class representation of the extracted metadata
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException - If an error occured while performing metadata extraction.

extractMetadata

protected gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(List<XPath> xPaths)
                                                           throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
Extracts metadata

Parameters:
xPaths - A list of xpath expressions.
Returns:
A metadata object containing the extracted metadata.
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException - If a bad xPath expression was encountered.

getReferences

protected List<ReferenceEntry> getReferences(List<net.sf.saxon.tinytree.TinyElementImpl> references,
                                             File product)
                                      throws XPathExpressionException,
                                             gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
Extracts the metadata found in an association entry.

Parameters:
references - A list of association entries.
product - The product.
Returns:
A list of ReferenceEntry objects, which holds the association metadata.
Throws:
XPathExpressionException - If there was an invalid XPath expression.
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException

extractMetadata

public gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(String product)
                                                        throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
Extract the metadata.

Specified by:
extractMetadata in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Parameters:
product - A PDS4 xml file.
Returns:
a class representation of the extracted metadata.
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException

extractMetadata

public gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(URL product)
                                                        throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
Extract the metadata.

Specified by:
extractMetadata in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Parameters:
product - A PDS4 xml file.
Returns:
a class representation of the extracted metadata.
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException

extractMetadata

public gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(File product,
                                                               File configFile)
                                                        throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
No need to be implemented.

Specified by:
extractMetadata in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException

extractMetadata

public gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(File product,
                                                               String configFile)
                                                        throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
No need to be implemented.

Specified by:
extractMetadata in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException

extractMetadata

public gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(File product,
                                                               gov.nasa.jpl.oodt.cas.metadata.MetExtractorConfig config)
                                                        throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
No need to be implemented.

Specified by:
extractMetadata in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException

extractMetadata

public gov.nasa.jpl.oodt.cas.metadata.Metadata extractMetadata(URL product,
                                                               gov.nasa.jpl.oodt.cas.metadata.MetExtractorConfig config)
                                                        throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
No need to be implemented.

Specified by:
extractMetadata in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException

setConfigFile

public void setConfigFile(File configFile)
                   throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
No need to be implemented.

Specified by:
setConfigFile in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException

setConfigFile

public void setConfigFile(String configFile)
                   throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
No need to be implemented.

Specified by:
setConfigFile in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor
Throws:
gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException

setConfigFile

public void setConfigFile(gov.nasa.jpl.oodt.cas.metadata.MetExtractorConfig config)
Specified by:
setConfigFile in interface gov.nasa.jpl.oodt.cas.metadata.MetExtractor


Copyright © 2010-2013 Planetary Data System. All Rights Reserved.