com.exalead.mercury.mami.crawl.v21

Class ForceCrawlUrl

java.lang.Object

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

com.exalead.mercury.mami.crawl.v21.ForceCrawlUrl

All Implemented Interfaces:

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

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

Force the crawl of a url through the crawl pipeline of a crawler.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_GROUP
static int	DEFAULT_PRIORITY
static boolean	DEFAULT_SITE
java.lang.String	group
java.lang.String	kvs
int	priority
boolean	site
java.lang.String	url

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

crawlerName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ForceCrawlUrl.
ForceCrawlUrl	clone() Creates and returns a deep copy of this ForceCrawlUrl.
static ForceCrawlUrl	fromString(java.lang.String s) String representation of this ForceCrawlUrl.
java.lang.String	getGroup()
java.lang.String	getKvs() a semi-colon separated list of key-values.
int	getPriority()
java.lang.String	getUrl()
boolean	isSite()
ForceCrawlUrl	makeCopy() Creates and returns a deep copy of this ForceCrawlUrl.
static ForceCrawlUrl	readFrom(java.io.InputStream is) Read this ForceCrawlUrl from an XML fragment.
void	setGroup(java.lang.String group)
void	setKvs(java.lang.String kvs) a semi-colon separated list of key-values.
void	setPriority(int priority)
void	setSite(boolean site)
void	setUrl(java.lang.String url)
java.lang.String	toString() String representation of this ForceCrawlUrl.
ForceCrawlUrl	withCrawlerName(java.lang.String crawlerName)
ForceCrawlUrl	withGroup(java.lang.String group)
ForceCrawlUrl	withKvs(java.lang.String kvs)
ForceCrawlUrl	withPriority(int priority)
ForceCrawlUrl	withPriority(java.lang.Integer priority)
ForceCrawlUrl	withSite(boolean site)
ForceCrawlUrl	withSite(java.lang.Boolean site)
ForceCrawlUrl	withUrl(java.lang.String url)
void	writeTo(java.io.OutputStream os) Write this ForceCrawlUrl 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

url

public java.lang.String url

site

public boolean site

DEFAULT_SITE

public static final boolean DEFAULT_SITE

See Also:

Constant Field Values

group

public java.lang.String group

DEFAULT_GROUP

public static final java.lang.String DEFAULT_GROUP

See Also:

Constant Field Values

priority

public int priority

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

kvs

public java.lang.String kvs

Constructor Detail

ForceCrawlUrl

public ForceCrawlUrl()

ForceCrawlUrl

public ForceCrawlUrl(ForceCrawlUrl o)

Copy constructor

Method Detail

withCrawlerName

public ForceCrawlUrl withCrawlerName(java.lang.String crawlerName)

Overrides:

withCrawlerName in class CrawlerCommand

setUrl

public void setUrl(java.lang.String url)

getUrl

public java.lang.String getUrl()

withUrl

public ForceCrawlUrl withUrl(java.lang.String url)

setSite

public void setSite(boolean site)

isSite

public boolean isSite()

withSite

public ForceCrawlUrl withSite(boolean site)

withSite

public ForceCrawlUrl withSite(java.lang.Boolean site)

setGroup

public void setGroup(java.lang.String group)

getGroup

public java.lang.String getGroup()

withGroup

public ForceCrawlUrl withGroup(java.lang.String group)

setPriority

public void setPriority(int priority)

getPriority

public int getPriority()

withPriority

public ForceCrawlUrl withPriority(int priority)

withPriority

public ForceCrawlUrl withPriority(java.lang.Integer priority)

setKvs

public void setKvs(java.lang.String kvs)

a semi-colon separated list of key-values. example: "key1=value1;key2=value2"

getKvs

public java.lang.String getKvs()

a semi-colon separated list of key-values. example: "key1=value1;key2=value2"

withKvs

public ForceCrawlUrl withKvs(java.lang.String kvs)

clone

public ForceCrawlUrl clone()

Creates and returns a deep copy of this ForceCrawlUrl.

Specified by:

clone in class CrawlerCommand

makeCopy

public ForceCrawlUrl makeCopy()

Creates and returns a deep copy of this ForceCrawlUrl.

Overrides:

makeCopy in class CrawlerCommand

readFrom

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

Read this ForceCrawlUrl 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 ForceCrawlUrl as an XML fragment

Overrides:

writeTo in class CrawlerCommand

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ForceCrawlUrl.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ForceCrawlUrl.

Overrides:

toString in class CrawlerCommand

check

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

Checks this ForceCrawlUrl.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class CrawlerCommand

Throws:

com.exalead.util.TypedException