com.exalead.mercury.mami.crawl.v20

Class ClearDocuments

java.lang.Object

com.exalead.mercury.mami.crawl.v20.CrawlerCommand

com.exalead.mercury.mami.crawl.v20.ClearDocuments

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ClearDocuments
extends CrawlerCommand
implements java.io.Serializable, java.lang.Cloneable

Erase all documents that match the prefix

See Also:

Serialized Form

Field Summary

Fields

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

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

crawlerName

Constructor Summary

Constructors

Constructor and Description
ClearDocuments() Creates a new ClearDocuments instance.
ClearDocuments(ClearDocuments o) Creates a new ClearDocuments instance by deeply copying a given ClearDocuments instance.

Method Summary

Modifier and Type	Method and Description
ClearDocuments	clone() Creates and returns a deep copy of this object.
java.lang.String	getPrefix() If not null, clear only documents whose url matches this prefix.
void	setPrefix(java.lang.String value) Sets the value of the prefix property.
ClearDocuments	withCrawlerName(java.lang.String value)
ClearDocuments	withPrefix(java.lang.String value)

Methods inherited from class com.exalead.mercury.mami.crawl.v20.CrawlerCommand

getCrawlerName, setCrawlerName

Methods inherited from class java.lang.Object

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

Field Detail

prefix

protected java.lang.String prefix

Constructor Detail

ClearDocuments

public ClearDocuments()

Creates a new ClearDocuments instance.

ClearDocuments

public ClearDocuments(ClearDocuments o)

Creates a new ClearDocuments instance by deeply copying a given ClearDocuments instance.

Parameters:

o - The instance to copy.

Throws:

java.lang.NullPointerException - if o is null.

Method Detail

getPrefix

public java.lang.String getPrefix()

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

Returns:

possible object is String

setPrefix

public void setPrefix(java.lang.String value)

Sets the value of the prefix property.

Parameters:

value - allowed object is String

withPrefix

public ClearDocuments withPrefix(java.lang.String value)

withCrawlerName

public ClearDocuments withCrawlerName(java.lang.String value)

Overrides:

withCrawlerName in class CrawlerCommand

clone

public ClearDocuments clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class CrawlerCommand

Returns:

A deep copy of this object.