org.apache.oodt.cas.filemgr.metadata.extractors

Class AbstractFilemgrMetExtractor

java.lang.Object

org.apache.oodt.cas.filemgr.metadata.extractors.AbstractFilemgrMetExtractor

All Implemented Interfaces:

FilemgrMetExtractor

Direct Known Subclasses:

CoreMetExtractor, DateTimeExpandMetExtractor, FileAttributesExtractor, FilenameRegexMetExtractor, FinalFileLocationExtractor, MimeTypeExtractor, TikaAutoDetectExtractor

public abstract class AbstractFilemgrMetExtractor
extends Object
implements FilemgrMetExtractor

Version:

$Revision$

An abstract base class providing functionality to any sub-classing FilemgrMetExtractors.

.

Author:

mattmann

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	configuration

Constructor Summary

Constructors

Constructor and Description
AbstractFilemgrMetExtractor()

Method Summary

Modifier and Type	Method and Description
protected void	addMetadataIfUndefined(Metadata origMet, Metadata destMet, String key, String val)
void	configure(Properties props) Sets the configuration for this Metadata extractor.
abstract void	doConfigure()
abstract Metadata	doExtract(Product product, Metadata met)
Metadata	extractMetadata(Product product, Metadata met) Extracts Metadata from the given Product.
protected File	getProductFile(Product product)
protected String	getRootRefPath(List<Reference> refs, String productTypeRepoPath)
protected void	merge(Metadata src, Metadata dest)
protected void	validateProduct(Product product, Metadata met)

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected Properties configuration

Constructor Detail

AbstractFilemgrMetExtractor

public AbstractFilemgrMetExtractor()

Method Detail

extractMetadata

public Metadata extractMetadata(Product product,
                                Metadata met)
                         throws MetExtractionException

Description copied from interface: FilemgrMetExtractor

Extracts Metadata from the given Product.

Specified by:

extractMetadata in interface FilemgrMetExtractor

Parameters:

product - The given Product.

met - The original Metadata provided during ingestion.

Returns:

Extracted Metadata derived from the existing Metadata and Product provided.

Throws:

MetExtractionException

configure

public void configure(Properties props)

Description copied from interface: FilemgrMetExtractor

Sets the configuration for this Metadata extractor.

Specified by:

configure in interface FilemgrMetExtractor

Parameters:

props - The Properties object to configure this Metadata extractor with.

doExtract

public abstract Metadata doExtract(Product product,
                                   Metadata met)
                            throws MetExtractionException

Throws:

MetExtractionException

doConfigure

public abstract void doConfigure()

validateProduct

protected void validateProduct(Product product,
                               Metadata met)
                        throws MetExtractionException

Throws:

MetExtractionException

addMetadataIfUndefined

protected void addMetadataIfUndefined(Metadata origMet,
                                      Metadata destMet,
                                      String key,
                                      String val)

merge

protected void merge(Metadata src,
                     Metadata dest)

getProductFile

protected File getProductFile(Product product)
                       throws MetExtractionException

Throws:

MetExtractionException

getRootRefPath

protected String getRootRefPath(List<Reference> refs,
                                String productTypeRepoPath)
                         throws URISyntaxException

Throws:

URISyntaxException