com.exalead.mercury.mami.indexing.v10

Class RemoveDocumentCacheEntries

java.lang.Object

com.exalead.mercury.mami.indexing.v10.BuildGroupSpecific

com.exalead.mercury.mami.indexing.v10.RemoveDocumentCacheEntries

All Implemented Interfaces:

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

public class RemoveDocumentCacheEntries
extends BuildGroupSpecific
implements com.exalead.util.Checkable, java.io.Serializable

* Erased documents from cache. * The buildGroup is mandatory. *

*
• if source is null, all sources are erased.
*
• if source is not null and prefix is null, the whole source is erased.
*
• if source and prefix are not null, documents in source whose uri begin with prefix are erased.
*

* Note that after running some batches of removals, it is required to commit the cache, so that further * repushes take correctly the removals into account. * Also note that "source=null" and "prefix!=null" is not supported.

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class com.exalead.mercury.mami.indexing.v10.BuildGroupSpecific

buildGroup

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this RemoveDocumentCacheEntries.
static RemoveDocumentCacheEntries	fromString(java.lang.String s) String representation of this RemoveDocumentCacheEntries.
java.lang.String	getPrefix()
java.lang.String	getSource()
RemoveDocumentCacheEntries	makeCopy() Creates and returns a deep copy of this RemoveDocumentCacheEntries.
static RemoveDocumentCacheEntries	readFrom(java.io.InputStream is) Read this RemoveDocumentCacheEntries from an XML fragment.
void	setPrefix(java.lang.String prefix)
void	setSource(java.lang.String source)
java.lang.String	toString() String representation of this RemoveDocumentCacheEntries.
RemoveDocumentCacheEntries	withBuildGroup(java.lang.String buildGroup)
RemoveDocumentCacheEntries	withPrefix(java.lang.String prefix)
RemoveDocumentCacheEntries	withSource(java.lang.String source)
void	writeTo(java.io.OutputStream os) Write this RemoveDocumentCacheEntries as an XML fragment

Methods inherited from class com.exalead.mercury.mami.indexing.v10.BuildGroupSpecific

getBuildGroup, setBuildGroup

Methods inherited from class java.lang.Object

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

Field Detail

source

public java.lang.String source

prefix

public java.lang.String prefix

Constructor Detail

RemoveDocumentCacheEntries

public RemoveDocumentCacheEntries()

RemoveDocumentCacheEntries

public RemoveDocumentCacheEntries(RemoveDocumentCacheEntries o)

Copy constructor

Method Detail

withBuildGroup

public RemoveDocumentCacheEntries withBuildGroup(java.lang.String buildGroup)

Overrides:

withBuildGroup in class BuildGroupSpecific

setSource

public void setSource(java.lang.String source)

getSource

public java.lang.String getSource()

withSource

public RemoveDocumentCacheEntries withSource(java.lang.String source)

setPrefix

public void setPrefix(java.lang.String prefix)

getPrefix

public java.lang.String getPrefix()

withPrefix

public RemoveDocumentCacheEntries withPrefix(java.lang.String prefix)

makeCopy

public RemoveDocumentCacheEntries makeCopy()

Creates and returns a deep copy of this RemoveDocumentCacheEntries.

Overrides:

makeCopy in class BuildGroupSpecific

readFrom

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

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

Overrides:

writeTo in class BuildGroupSpecific

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RemoveDocumentCacheEntries.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RemoveDocumentCacheEntries.

Overrides:

toString in class BuildGroupSpecific

check

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

Checks this RemoveDocumentCacheEntries.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BuildGroupSpecific

Throws:

com.exalead.util.TypedException