com.exalead.mercury.mami.crawl.v21

Class ClearDocuments

java.lang.Object

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

com.exalead.mercury.mami.crawl.v21.ClearDocuments

All Implemented Interfaces:

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

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

Erase all documents that match the prefix

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	prefix

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

crawlerName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ClearDocuments.
ClearDocuments	clone() Creates and returns a deep copy of this ClearDocuments.
static ClearDocuments	fromString(java.lang.String s) String representation of this ClearDocuments.
java.lang.String	getPrefix() If not null, clear only documents whose url matches this prefix.
ClearDocuments	makeCopy() Creates and returns a deep copy of this ClearDocuments.
static ClearDocuments	readFrom(java.io.InputStream is) Read this ClearDocuments from an XML fragment.
void	setPrefix(java.lang.String prefix) If not null, clear only documents whose url matches this prefix.
java.lang.String	toString() String representation of this ClearDocuments.
ClearDocuments	withCrawlerName(java.lang.String crawlerName)
ClearDocuments	withPrefix(java.lang.String prefix)
void	writeTo(java.io.OutputStream os) Write this ClearDocuments 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

Constructor Detail

ClearDocuments

public ClearDocuments()

ClearDocuments

public ClearDocuments(ClearDocuments o)

Copy constructor

Method Detail

withCrawlerName

public ClearDocuments withCrawlerName(java.lang.String crawlerName)

Overrides:

withCrawlerName in class CrawlerCommand

setPrefix

public void setPrefix(java.lang.String prefix)

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

getPrefix

public java.lang.String getPrefix()

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

withPrefix

public ClearDocuments withPrefix(java.lang.String prefix)

clone

public ClearDocuments clone()

Creates and returns a deep copy of this ClearDocuments.

Specified by:

clone in class CrawlerCommand

makeCopy

public ClearDocuments makeCopy()

Creates and returns a deep copy of this ClearDocuments.

Overrides:

makeCopy in class CrawlerCommand

readFrom

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

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

Overrides:

writeTo in class CrawlerCommand

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ClearDocuments.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ClearDocuments.

Overrides:

toString in class CrawlerCommand

check

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

Checks this ClearDocuments.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class CrawlerCommand

Throws:

com.exalead.util.TypedException