com.exalead.mercury.mami.crawl.v21

Class IRoot

java.lang.Object

com.exalead.mercury.mami.crawl.v21.IRoot

All Implemented Interfaces:

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

Direct Known Subclasses:

Feed, Root

public abstract class IRoot
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable, Cloneable

No documentation for this element.

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this IRoot.
abstract IRoot	clone()
static IRoot	fromString(java.lang.String s) String representation of this IRoot.
java.lang.String	getGroup() Key used to group rules and root urls.
java.lang.String	getKvs() A semi-colon separated list of key-values.
int	getPriority() Priority shift.
java.lang.String	getUrl() The root url.
boolean	isSite() Enable site-mode: only crawl urls that belong to this 'site'.
IRoot	makeCopy()
static IRoot	readFrom(java.io.InputStream is) Read this IRoot from an XML fragment.
void	setGroup(java.lang.String group) Key used to group rules and root urls.
void	setKvs(java.lang.String kvs) A semi-colon separated list of key-values.
void	setPriority(int priority) Priority shift.
void	setSite(boolean site) Enable site-mode: only crawl urls that belong to this 'site'.
void	setUrl(java.lang.String url) The root url.
java.lang.String	toString() String representation of this IRoot.
IRoot	withGroup(java.lang.String group)
IRoot	withKvs(java.lang.String kvs)
IRoot	withPriority(int priority)
IRoot	withPriority(java.lang.Integer priority)
IRoot	withSite(boolean site)
IRoot	withSite(java.lang.Boolean site)
IRoot	withUrl(java.lang.String url)
void	writeTo(java.io.OutputStream os)

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

priority

public int priority

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

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

kvs

public java.lang.String kvs

Constructor Detail

IRoot

public IRoot()

IRoot

public IRoot(IRoot o)

Copy constructor

Method Detail

setUrl

public void setUrl(java.lang.String url)

The root url.

getUrl

public java.lang.String getUrl()

The root url.

withUrl

public IRoot withUrl(java.lang.String url)

setSite

public void setSite(boolean site)

Enable site-mode: only crawl urls that belong to this 'site'.

isSite

public boolean isSite()

Enable site-mode: only crawl urls that belong to this 'site'.

withSite

public IRoot withSite(boolean site)

withSite

public IRoot withSite(java.lang.Boolean site)

setPriority

public void setPriority(int priority)

Priority shift. Increase or decrease priority. 0 means normal, -1 is higher priority, +1 lower.

getPriority

public int getPriority()

Priority shift. Increase or decrease priority. 0 means normal, -1 is higher priority, +1 lower.

withPriority

public IRoot withPriority(int priority)

withPriority

public IRoot withPriority(java.lang.Integer priority)

setGroup

public void setGroup(java.lang.String group)

Key used to group rules and root urls.

getGroup

public java.lang.String getGroup()

Key used to group rules and root urls.

withGroup

public IRoot withGroup(java.lang.String group)

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 IRoot withKvs(java.lang.String kvs)

clone

public abstract IRoot clone()

Overrides:

clone in class java.lang.Object

makeCopy

public IRoot makeCopy()

readFrom

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

Read this IRoot 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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this IRoot.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IRoot.

Overrides:

toString in class java.lang.Object

check

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

Checks this IRoot.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException