org.apache.oodt.cas.crawl.action

Class FileBasedAction

java.lang.Object

org.apache.oodt.cas.crawl.action.CrawlerAction

org.apache.oodt.cas.crawl.action.FileBasedAction

All Implemented Interfaces:

SpringSetIdInjectionType

Direct Known Subclasses:

IngestAncillary

public abstract class FileBasedAction
extends CrawlerAction

This class provides some basic support for actions revolving around files. It allows action to support file selection based on configuration, metadata, or the current file being handled by the crawler. In addition, it supports the usage of FileSettings to provide conformance amongst extending actions. Finally, it captures a flag for indicating whether the action should fail should the file not exist.

Author:

pramirez (Paul Ramirez), mattmann (Chris Mattmann)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	failMissingFile
protected String	file
protected String	fileKey
protected FileSettings	fileSettings

Fields inherited from class org.apache.oodt.cas.crawl.action.CrawlerAction

LOG, phases

Constructor Summary

Constructors

Constructor and Description
FileBasedAction()

Method Summary

Modifier and Type	Method and Description
File	getSelectedFile(File product, Metadata metadata)
boolean	performAction(File product, Metadata metadata)
abstract boolean	performFileAction(File actionFile, Metadata metadata)
void	setFailMissingFile(boolean failMissingFile)
void	setFile(String file)
void	setFileExtension(String fileExtension)
void	setFileKey(String fileKey)
void	setFilePrefix(String filePrefix)
void	setFileSuffix(String fileSuffix)
void	setKeepExistingExtension(boolean keepExistingExtension)

Methods inherited from class org.apache.oodt.cas.crawl.action.CrawlerAction

equals, getDescription, getId, getPhases, hashCode, setDescription, setId, setPhases, validate

Methods inherited from class java.lang.Object

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

Field Detail

file

protected String file

fileKey

protected String fileKey

fileSettings

protected FileSettings fileSettings

failMissingFile

protected boolean failMissingFile

Constructor Detail

FileBasedAction

public FileBasedAction()

Method Detail

setFilePrefix

public void setFilePrefix(String filePrefix)

setFileSuffix

public void setFileSuffix(String fileSuffix)

setFileExtension

public void setFileExtension(String fileExtension)

setKeepExistingExtension

public void setKeepExistingExtension(boolean keepExistingExtension)

setFile

public void setFile(String file)

setFileKey

public void setFileKey(String fileKey)

setFailMissingFile

public void setFailMissingFile(boolean failMissingFile)

getSelectedFile

public File getSelectedFile(File product,
                            Metadata metadata)

performAction

public boolean performAction(File product,
                             Metadata metadata)
                      throws CrawlerActionException

Specified by:

performAction in class CrawlerAction

Throws:

CrawlerActionException

performFileAction

public abstract boolean performFileAction(File actionFile,
                                          Metadata metadata)