Class Pds4MetExtractor
- java.lang.Object
-
- gov.nasa.pds.harvest.search.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
Fields Modifier and Type Field Description protected Pds4MetExtractorConfigconfigA metadata extraction configuration.protected XMLExtractorextractorAn XMLExtractor to get the metadata.
-
Constructor Summary
Constructors Constructor Description Pds4MetExtractor(Pds4MetExtractorConfig config)Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description gov.nasa.jpl.oodt.cas.metadata.MetadataextractMetadata(File product)Extract the metadatagov.nasa.jpl.oodt.cas.metadata.MetadataextractMetadata(File product, gov.nasa.jpl.oodt.cas.metadata.MetExtractorConfig config)No need to be implemented.gov.nasa.jpl.oodt.cas.metadata.MetadataextractMetadata(File product, File configFile)No need to be implemented.gov.nasa.jpl.oodt.cas.metadata.MetadataextractMetadata(File product, String configFile)No need to be implemented.gov.nasa.jpl.oodt.cas.metadata.MetadataextractMetadata(String product)Extract the metadata.gov.nasa.jpl.oodt.cas.metadata.MetadataextractMetadata(URL product)Extract the metadata.gov.nasa.jpl.oodt.cas.metadata.MetadataextractMetadata(URL product, gov.nasa.jpl.oodt.cas.metadata.MetExtractorConfig config)No need to be implemented.protected List<Slot>extractMetadata(List<XPath> xPaths)Extracts metadataprotected List<ReferenceEntry>getReferences(List<net.sf.saxon.tree.tiny.TinyElementImpl> references, File product)Extracts the metadata found in an association entry.voidsetConfigFile(gov.nasa.jpl.oodt.cas.metadata.MetExtractorConfig config)voidsetConfigFile(File configFile)No need to be implemented.voidsetConfigFile(String configFile)No need to be implemented.
-
-
-
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:
extractMetadatain interfacegov.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:
extractMetadatain interfacegov.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:
extractMetadatain interfacegov.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:
extractMetadatain interfacegov.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:
extractMetadatain interfacegov.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:
extractMetadatain interfacegov.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:
extractMetadatain interfacegov.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:
setConfigFilein interfacegov.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:
setConfigFilein interfacegov.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:
setConfigFilein interfacegov.nasa.jpl.oodt.cas.metadata.MetExtractor
-
-