com.norconex.collector.core.data

Class CrawlState

java.lang.Object

com.norconex.collector.core.data.CrawlState

All Implemented Interfaces:

Serializable

public class CrawlState
extends Object
implements Serializable

Reference processing status.

Author:

Pascal Essiembre

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CrawlState	BAD_STATUS
static CrawlState	DELETED
static CrawlState	ERROR
static CrawlState	MODIFIED
static CrawlState	NEW
static CrawlState	NOT_FOUND
static CrawlState	PREMATURE For collectors that support it, this state indicates a previously crawled document is not yet ready to be re-crawled.
static CrawlState	REJECTED
static CrawlState	UNMODIFIED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CrawlState(String state) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
int	hashCode()
boolean	isGoodState() Returns whether a reference should be considered "good" (the corresponding document is not in a "bad" state, such as being rejected or produced an error.
boolean	isNewOrModified() Returns whether a state indicates new or modified.
boolean	isOneOf(CrawlState... states)
boolean	isSkipped() Returns whether a state indicate the document is to be skipped (UNMODIFIED or PREMATURE).
String	toString()
static CrawlState	valueOf(String state)

Methods inherited from class java.lang.Object

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

Field Detail

NEW

public static final CrawlState NEW

MODIFIED

public static final CrawlState MODIFIED

UNMODIFIED

public static final CrawlState UNMODIFIED

ERROR

public static final CrawlState ERROR

REJECTED

public static final CrawlState REJECTED

BAD_STATUS

public static final CrawlState BAD_STATUS

DELETED

public static final CrawlState DELETED

NOT_FOUND

public static final CrawlState NOT_FOUND

PREMATURE

public static final CrawlState PREMATURE

For collectors that support it, this state indicates a previously crawled document is not yet ready to be re-crawled. It may or may not be re-crawled in the next crawl session (if ready).

Since:

1.5.0

Constructor Detail

CrawlState

protected CrawlState(String state)

Constructor.

Parameters:

state - state code

Method Detail

isGoodState

public boolean isGoodState()

Returns whether a reference should be considered "good" (the corresponding document is not in a "bad" state, such as being rejected or produced an error. This implementation will consider as good these reference statuses: NEW, MODIFIED, UNMODIFIED, and PREMATURE. This method can be overridden to provide different logic for a valid reference.

Returns:

true if status is valid.

isNewOrModified

public boolean isNewOrModified()

Returns whether a state indicates new or modified.

Returns:

true if new or modified

isSkipped

public boolean isSkipped()

Returns whether a state indicate the document is to be skipped (UNMODIFIED or PREMATURE).

Returns:

true if skipped

Since:

1.6.0

isOneOf

public boolean isOneOf(CrawlState... states)

valueOf

public static CrawlState valueOf(String state)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object