Class 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
    • 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 List<Slot> extractMetadata​(List<XPath> xPaths)
                                      throws gov.nasa.jpl.oodt.cas.metadata.exceptions.MetExtractionException
        Extracts metadata
        Parameters:
        xPaths - A list of xpath expressions.
        Returns:
        A list of Slots that contain 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.tree.tiny.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