org.apache.oodt.cas.crawl.action

Class CrawlerAction

java.lang.Object

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

All Implemented Interfaces:

SpringSetIdInjectionType

Direct Known Subclasses:

DeleteFile, EmailNotification, ExternAction, FileBasedAction, FilemgrUniquenessChecker, GroupAction, MimeTypeCrawlerAction, MoveFile, SolrIndexingAction, TernaryAction, ToggleAction, WorkflowMgrStatusUpdate

public abstract class CrawlerAction
extends Object
implements SpringSetIdInjectionType

An action taken by the crawler during success or fail of one of its lifecycle states: preIngest, postIngestSuccess, or postIngestFail .

Author:

bfoster (Brian Foster), mattmann (Chris Mattmann)

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	LOG
List<String>	phases

Constructor Summary

Constructors

Constructor and Description
CrawlerAction()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription()
String	getId() Get a unique String id that represents this objects instance
List<String>	getPhases()
int	hashCode()
abstract boolean	performAction(File product, Metadata productMetadata)
void	setDescription(String description)
void	setId(String id) Set a unique id that represents this objects instance
void	setPhases(List<String> phases)
void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

phases

public List<String> phases

LOG

public static Logger LOG

Constructor Detail

CrawlerAction

public CrawlerAction()

Method Detail

getId

public String getId()

Description copied from interface: SpringSetIdInjectionType

Get a unique String id that represents this objects instance

Specified by:

getId in interface SpringSetIdInjectionType

Returns:

Unique String id

setId

public void setId(String id)

Description copied from interface: SpringSetIdInjectionType

Set a unique id that represents this objects instance

Specified by:

setId in interface SpringSetIdInjectionType

Parameters:

id - Unique String id

setPhases

public void setPhases(List<String> phases)

getPhases

public List<String> getPhases()

setDescription

public void setDescription(String description)

getDescription

public String getDescription()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

validate

public void validate()
              throws CrawlerActionException

Throws:

CrawlerActionException

performAction

public abstract boolean performAction(File product,
                                      Metadata productMetadata)
                               throws CrawlerActionException

Throws:

CrawlerActionException