de.gerdiproject.harvest.etls.events

Class HarvestStartedEvent

java.lang.Object

de.gerdiproject.harvest.etls.events.HarvestStartedEvent

All Implemented Interfaces:

IEvent

public class HarvestStartedEvent
extends Object
implements IEvent

This event signifies that a harvest has been started.

Author:

Robin Weiss

Constructor Summary

Constructors

Constructor and Description
HarvestStartedEvent(String harvesterHash, int maxHarvestableDocuments) Constructor that sets up the payload, and uses the current time as the start timestamp.
HarvestStartedEvent(String harvesterHash, int maxHarvestableDocuments, long timestamp) Constructor that sets up the payload, and allows to define the start timestamp.

Method Summary

Modifier and Type	Method and Description
String	getHarvesterHash() Returns the version hash of the harvested documents.
int	getMaxHarvestableDocuments() Returns the maximum number of harvestable documents.
long	getStartTimestamp() Returns the unix timestamp at which the event was created.

Methods inherited from class java.lang.Object

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

Constructor Detail

HarvestStartedEvent

public HarvestStartedEvent(String harvesterHash,
                           int maxHarvestableDocuments)

Constructor that sets up the payload, and uses the current time as the start timestamp.

Parameters:

harvesterHash - a hash value representing the current state of the source data

maxHarvestableDocuments - the maximum number of expected documents

HarvestStartedEvent

public HarvestStartedEvent(String harvesterHash,
                           int maxHarvestableDocuments,
                           long timestamp)

Constructor that sets up the payload, and allows to define the start timestamp.

Parameters:

harvesterHash - a hash value representing the current state of the source data

maxHarvestableDocuments - the maximum number of expected documents

timestamp - the time at wich the harvest started

Method Detail

getStartTimestamp

public long getStartTimestamp()

Returns the unix timestamp at which the event was created.

Returns:

the unix timestamp at which the event was created

getHarvesterHash

public String getHarvesterHash()

Returns the version hash of the harvested documents.

Returns:

the version hash of the harvested documents

getMaxHarvestableDocuments

public int getMaxHarvestableDocuments()

Returns the maximum number of harvestable documents.

Returns:

the maximum number of harvestable documents