com.exalead.mercury.mami.crawl.v21

Class RefreshDocuments

java.lang.Object

com.exalead.mercury.mami.crawl.v21.CrawlerCommand

com.exalead.mercury.mami.crawl.v21.RefreshDocuments

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable, java.lang.Cloneable

public class RefreshDocuments
extends CrawlerCommand
implements com.exalead.util.Checkable, java.io.Serializable, Cloneable

Refresh all urls that match the prefix and have not been refreshed for the last maxAgeS seconds.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_FORCE
static boolean	DEFAULT_FORCE_FOLLOW
static int	DEFAULT_PRIORITY
boolean	force
boolean	forceFollow
int	maxAgeS
java.lang.String	prefix
int	priority

Fields inherited from class com.exalead.mercury.mami.crawl.v21.CrawlerCommand

crawlerName

Constructor Summary

Constructors

Constructor and Description
RefreshDocuments()
RefreshDocuments(RefreshDocuments o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this RefreshDocuments.
RefreshDocuments	clone() Creates and returns a deep copy of this RefreshDocuments.
static RefreshDocuments	fromString(java.lang.String s) String representation of this RefreshDocuments.
int	getMaxAgeS() How old a document must be to be refreshed.
java.lang.String	getPrefix() If not null, refresh only documents whose url matches this prefix.
int	getPriority() Which priority to refresh the documents with.
boolean	isForce() Whether to force refreshing the urls, preventing the crawler from ignoring "too recently crawled" urls.
boolean	isForceFollow() Whether to force following links on refreshed documents, even if they are already known.
RefreshDocuments	makeCopy() Creates and returns a deep copy of this RefreshDocuments.
static RefreshDocuments	readFrom(java.io.InputStream is) Read this RefreshDocuments from an XML fragment.
void	setForce(boolean force) Whether to force refreshing the urls, preventing the crawler from ignoring "too recently crawled" urls.
void	setForceFollow(boolean forceFollow) Whether to force following links on refreshed documents, even if they are already known.
void	setMaxAgeS(int maxAgeS) How old a document must be to be refreshed.
void	setPrefix(java.lang.String prefix) If not null, refresh only documents whose url matches this prefix.
void	setPriority(int priority) Which priority to refresh the documents with.
java.lang.String	toString() String representation of this RefreshDocuments.
RefreshDocuments	withCrawlerName(java.lang.String crawlerName)
RefreshDocuments	withForce(boolean force)
RefreshDocuments	withForce(java.lang.Boolean force)
RefreshDocuments	withForceFollow(boolean forceFollow)
RefreshDocuments	withForceFollow(java.lang.Boolean forceFollow)
RefreshDocuments	withMaxAgeS(int maxAgeS)
RefreshDocuments	withMaxAgeS(java.lang.Integer maxAgeS)
RefreshDocuments	withPrefix(java.lang.String prefix)
RefreshDocuments	withPriority(int priority)
RefreshDocuments	withPriority(java.lang.Integer priority)
void	writeTo(java.io.OutputStream os) Write this RefreshDocuments as an XML fragment

Methods inherited from class com.exalead.mercury.mami.crawl.v21.CrawlerCommand

getCrawlerName, setCrawlerName

Methods inherited from class java.lang.Object

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

Field Detail

prefix

public java.lang.String prefix

maxAgeS

public int maxAgeS

priority

public int priority

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

force

public boolean force

DEFAULT_FORCE

public static final boolean DEFAULT_FORCE

See Also:

Constant Field Values

forceFollow

public boolean forceFollow

DEFAULT_FORCE_FOLLOW

public static final boolean DEFAULT_FORCE_FOLLOW

See Also:

Constant Field Values

Constructor Detail

RefreshDocuments

public RefreshDocuments()

RefreshDocuments

public RefreshDocuments(RefreshDocuments o)

Copy constructor

Method Detail

withCrawlerName

public RefreshDocuments withCrawlerName(java.lang.String crawlerName)

Overrides:

withCrawlerName in class CrawlerCommand

setPrefix

public void setPrefix(java.lang.String prefix)

If not null, refresh only documents whose url matches this prefix. Must be a valid URL.

getPrefix

public java.lang.String getPrefix()

If not null, refresh only documents whose url matches this prefix. Must be a valid URL.

withPrefix

public RefreshDocuments withPrefix(java.lang.String prefix)

setMaxAgeS

public void setMaxAgeS(int maxAgeS)

How old a document must be to be refreshed. Younger documents are not refreshed.

getMaxAgeS

public int getMaxAgeS()

How old a document must be to be refreshed. Younger documents are not refreshed.

withMaxAgeS

public RefreshDocuments withMaxAgeS(int maxAgeS)

withMaxAgeS

public RefreshDocuments withMaxAgeS(java.lang.Integer maxAgeS)

setPriority

public void setPriority(int priority)

Which priority to refresh the documents with. 0 is the highest priority. The lowest is the number of the last fifo.

getPriority

public int getPriority()

Which priority to refresh the documents with. 0 is the highest priority. The lowest is the number of the last fifo.

withPriority

public RefreshDocuments withPriority(int priority)

withPriority

public RefreshDocuments withPriority(java.lang.Integer priority)

setForce

public void setForce(boolean force)

Whether to force refreshing the urls, preventing the crawler from ignoring "too recently crawled" urls.

isForce

public boolean isForce()

Whether to force refreshing the urls, preventing the crawler from ignoring "too recently crawled" urls.

withForce

public RefreshDocuments withForce(boolean force)

withForce

public RefreshDocuments withForce(java.lang.Boolean force)

setForceFollow

public void setForceFollow(boolean forceFollow)

Whether to force following links on refreshed documents, even if they are already known. This is useful to force refresh of documents linked by a feed listing only updated documents.

isForceFollow

public boolean isForceFollow()

Whether to force following links on refreshed documents, even if they are already known. This is useful to force refresh of documents linked by a feed listing only updated documents.

withForceFollow

public RefreshDocuments withForceFollow(boolean forceFollow)

withForceFollow

public RefreshDocuments withForceFollow(java.lang.Boolean forceFollow)

clone

public RefreshDocuments clone()

Creates and returns a deep copy of this RefreshDocuments.

Specified by:

clone in class CrawlerCommand

makeCopy

public RefreshDocuments makeCopy()

Creates and returns a deep copy of this RefreshDocuments.

Overrides:

makeCopy in class CrawlerCommand

readFrom

public static RefreshDocuments readFrom(java.io.InputStream is)
                                 throws javax.xml.bind.JAXBException

Read this RefreshDocuments from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this RefreshDocuments as an XML fragment

Overrides:

writeTo in class CrawlerCommand

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static RefreshDocuments fromString(java.lang.String s)
                                   throws javax.xml.bind.JAXBException,
                                          java.io.UnsupportedEncodingException

String representation of this RefreshDocuments.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RefreshDocuments.

Overrides:

toString in class CrawlerCommand

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this RefreshDocuments.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class CrawlerCommand

Throws:

com.exalead.util.TypedException