com.exalead.mercury.mami.crawl.v21

Class CleanDocuments

java.lang.Object

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

com.exalead.mercury.mami.crawl.v21.CleanDocuments

All Implemented Interfaces:

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

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

Erase all documents from the index, that do not match the current "accept" or "index" crawl rules.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DELETE_FROM_INDEX_ONLY
boolean	deleteFromIndexOnly
java.lang.String	prefix

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

crawlerName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this CleanDocuments.
CleanDocuments	clone() Creates and returns a deep copy of this CleanDocuments.
static CleanDocuments	fromString(java.lang.String s) String representation of this CleanDocuments.
java.lang.String	getPrefix() If not null, clean only documents whose url matches this prefix.
boolean	isDeleteFromIndexOnly() whether to delete the documents in the index only, or from both the box and the index.
CleanDocuments	makeCopy() Creates and returns a deep copy of this CleanDocuments.
static CleanDocuments	readFrom(java.io.InputStream is) Read this CleanDocuments from an XML fragment.
void	setDeleteFromIndexOnly(boolean deleteFromIndexOnly) whether to delete the documents in the index only, or from both the box and the index.
void	setPrefix(java.lang.String prefix) If not null, clean only documents whose url matches this prefix.
java.lang.String	toString() String representation of this CleanDocuments.
CleanDocuments	withCrawlerName(java.lang.String crawlerName)
CleanDocuments	withDeleteFromIndexOnly(boolean deleteFromIndexOnly)
CleanDocuments	withDeleteFromIndexOnly(java.lang.Boolean deleteFromIndexOnly)
CleanDocuments	withPrefix(java.lang.String prefix)
void	writeTo(java.io.OutputStream os) Write this CleanDocuments 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

deleteFromIndexOnly

public boolean deleteFromIndexOnly

DEFAULT_DELETE_FROM_INDEX_ONLY

public static final boolean DEFAULT_DELETE_FROM_INDEX_ONLY

See Also:

Constant Field Values

prefix

public java.lang.String prefix

Constructor Detail

CleanDocuments

public CleanDocuments()

CleanDocuments

public CleanDocuments(CleanDocuments o)

Copy constructor

Method Detail

withCrawlerName

public CleanDocuments withCrawlerName(java.lang.String crawlerName)

Overrides:

withCrawlerName in class CrawlerCommand

setDeleteFromIndexOnly

public void setDeleteFromIndexOnly(boolean deleteFromIndexOnly)

whether to delete the documents in the index only, or from both the box and the index.

isDeleteFromIndexOnly

public boolean isDeleteFromIndexOnly()

whether to delete the documents in the index only, or from both the box and the index.

withDeleteFromIndexOnly

public CleanDocuments withDeleteFromIndexOnly(boolean deleteFromIndexOnly)

withDeleteFromIndexOnly

public CleanDocuments withDeleteFromIndexOnly(java.lang.Boolean deleteFromIndexOnly)

setPrefix

public void setPrefix(java.lang.String prefix)

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

getPrefix

public java.lang.String getPrefix()

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

withPrefix

public CleanDocuments withPrefix(java.lang.String prefix)

clone

public CleanDocuments clone()

Creates and returns a deep copy of this CleanDocuments.

Specified by:

clone in class CrawlerCommand

makeCopy

public CleanDocuments makeCopy()

Creates and returns a deep copy of this CleanDocuments.

Overrides:

makeCopy in class CrawlerCommand

readFrom

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

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

Overrides:

writeTo in class CrawlerCommand

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CleanDocuments.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CleanDocuments.

Overrides:

toString in class CrawlerCommand

check

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

Checks this CleanDocuments.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class CrawlerCommand

Throws:

com.exalead.util.TypedException