com.exalead.mercury.mami.crawl.v21

Class CrawlConfig

java.lang.Object

exa.bee.config.Versioned

com.exalead.mercury.mami.crawl.v21.CrawlConfig

All Implemented Interfaces:

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

public class CrawlConfig
extends exa.bee.config.Versioned
implements com.exalead.util.Checkable, java.io.Serializable, Cloneable

The crawl configuration.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_VERBOSE
java.util.List<ICrawler>	iCrawler
boolean	verbose

Fields inherited from class exa.bee.config.Versioned

version

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this CrawlConfig.
CrawlConfig	clone() Creates and returns a deep copy of this CrawlConfig.
static CrawlConfig	fromString(java.lang.String s) String representation of this CrawlConfig.
java.util.List<ICrawler>	getICrawler()
java.util.Map<java.lang.String,ICrawler>	getICrawlerAsMap() Get the map of ICrawler, indexed by name
ICrawler	getICrawlerByName(java.lang.String _lookup) Get the ICrawler for which the name matches _lookup
boolean	isVerbose()
CrawlConfig	makeCopy() Creates and returns a deep copy of this CrawlConfig.
static CrawlConfig	readFrom(java.io.InputStream is) Read this CrawlConfig from an XML fragment.
boolean	removeICrawlerByName(java.lang.String _lookup) Removes the ICrawler for which the name matches _lookup
void	setVerbose(boolean verbose)
java.lang.String	toString() String representation of this CrawlConfig.
CrawlConfig	withICrawler(java.util.Collection<ICrawler> __values)
CrawlConfig	withICrawler(ICrawler... __values)
CrawlConfig	withVerbose(boolean verbose)
CrawlConfig	withVerbose(java.lang.Boolean verbose)
CrawlConfig	withVersion(long version)
CrawlConfig	withVersion(java.lang.Long version)
void	writeTo(java.io.OutputStream os) Write this CrawlConfig as an XML fragment

Methods inherited from class exa.bee.config.Versioned

getVersion, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

iCrawler

public java.util.List<ICrawler> iCrawler

verbose

public boolean verbose

DEFAULT_VERBOSE

public static final boolean DEFAULT_VERBOSE

See Also:

Constant Field Values

Constructor Detail

CrawlConfig

public CrawlConfig()

CrawlConfig

public CrawlConfig(CrawlConfig o)

Copy constructor

Method Detail

withVersion

public CrawlConfig withVersion(long version)

Overrides:

withVersion in class exa.bee.config.Versioned

withVersion

public CrawlConfig withVersion(java.lang.Long version)

Overrides:

withVersion in class exa.bee.config.Versioned

getICrawler

public java.util.List<ICrawler> getICrawler()

getICrawlerByName

public ICrawler getICrawlerByName(java.lang.String _lookup)

Get the ICrawler for which the name matches _lookup

Returns:

null if no matching ICrawler is found

getICrawlerAsMap

public java.util.Map<java.lang.String,ICrawler> getICrawlerAsMap()

Get the map of ICrawler, indexed by name

removeICrawlerByName

public boolean removeICrawlerByName(java.lang.String _lookup)

Removes the ICrawler for which the name matches _lookup

Returns:

false if no matching ICrawler is found, true if one was found

withICrawler

public CrawlConfig withICrawler(ICrawler... __values)

withICrawler

public CrawlConfig withICrawler(java.util.Collection<ICrawler> __values)

setVerbose

public void setVerbose(boolean verbose)

isVerbose

public boolean isVerbose()

withVerbose

public CrawlConfig withVerbose(boolean verbose)

withVerbose

public CrawlConfig withVerbose(java.lang.Boolean verbose)

clone

public CrawlConfig clone()

Creates and returns a deep copy of this CrawlConfig.

Overrides:

clone in class exa.bee.config.Versioned

makeCopy

public CrawlConfig makeCopy()

Creates and returns a deep copy of this CrawlConfig.

Overrides:

makeCopy in class exa.bee.config.Versioned

readFrom

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

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

Overrides:

writeTo in class exa.bee.config.Versioned

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CrawlConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CrawlConfig.

Overrides:

toString in class exa.bee.config.Versioned

check

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

Checks this CrawlConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class exa.bee.config.Versioned

Throws:

com.exalead.util.TypedException