com.exalead.mercury.mami.indexing.v10

Class RepushFromDocumentCache

java.lang.Object

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

com.exalead.mercury.mami.indexing.v10.RepushFromDocumentCache

All Implemented Interfaces:

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

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

Repushes documents from the document cache to the PAPI.
This is an asynchronous operation. The cache enumeration is controlled by the "source" and "prefix" attributes.
Documents are repushed with a cache=false directive, which means that repushed documents will not be sent to the cache.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_SYNC
java.lang.String	prefix
java.lang.String	source
boolean	sync
java.lang.String	toBuildGroup

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

buildGroup

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this RepushFromDocumentCache.
static RepushFromDocumentCache	fromString(java.lang.String s) String representation of this RepushFromDocumentCache.
java.lang.String	getPrefix() URI prefix for the document enumeration from the cache.
java.lang.String	getSource() Name of the source that will be enumerated from the cache.
java.lang.String	getToBuildGroup() Name of the build group the documents will be pushed to.
boolean	isSync() Triggers a commit at the end of the push operation.
RepushFromDocumentCache	makeCopy() Creates and returns a deep copy of this RepushFromDocumentCache.
static RepushFromDocumentCache	readFrom(java.io.InputStream is) Read this RepushFromDocumentCache from an XML fragment.
void	setPrefix(java.lang.String prefix) URI prefix for the document enumeration from the cache.
void	setSource(java.lang.String source) Name of the source that will be enumerated from the cache.
void	setSync(boolean sync) Triggers a commit at the end of the push operation.
void	setToBuildGroup(java.lang.String toBuildGroup) Name of the build group the documents will be pushed to.
java.lang.String	toString() String representation of this RepushFromDocumentCache.
RepushFromDocumentCache	withBuildGroup(java.lang.String buildGroup)
RepushFromDocumentCache	withPrefix(java.lang.String prefix)
RepushFromDocumentCache	withSource(java.lang.String source)
RepushFromDocumentCache	withSync(boolean sync)
RepushFromDocumentCache	withSync(java.lang.Boolean sync)
RepushFromDocumentCache	withToBuildGroup(java.lang.String toBuildGroup)
void	writeTo(java.io.OutputStream os) Write this RepushFromDocumentCache 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

toBuildGroup

public java.lang.String toBuildGroup

source

public java.lang.String source

prefix

public java.lang.String prefix

sync

public boolean sync

DEFAULT_SYNC

public static final boolean DEFAULT_SYNC

See Also:

Constant Field Values

Constructor Detail

RepushFromDocumentCache

public RepushFromDocumentCache()

RepushFromDocumentCache

public RepushFromDocumentCache(RepushFromDocumentCache o)

Copy constructor

Method Detail

withBuildGroup

public RepushFromDocumentCache withBuildGroup(java.lang.String buildGroup)

Overrides:

withBuildGroup in class BuildGroupSpecific

setToBuildGroup

public void setToBuildGroup(java.lang.String toBuildGroup)

Name of the build group the documents will be pushed to.
If null, the documents will be pushed to the same build group they are originated from.

getToBuildGroup

public java.lang.String getToBuildGroup()

Name of the build group the documents will be pushed to.
If null, the documents will be pushed to the same build group they are originated from.

withToBuildGroup

public RepushFromDocumentCache withToBuildGroup(java.lang.String toBuildGroup)

setSource

public void setSource(java.lang.String source)

Name of the source that will be enumerated from the cache.

getSource

public java.lang.String getSource()

Name of the source that will be enumerated from the cache.

withSource

public RepushFromDocumentCache withSource(java.lang.String source)

setPrefix

public void setPrefix(java.lang.String prefix)

URI prefix for the document enumeration from the cache. Optional (when provided document URIs must match the prefix).

getPrefix

public java.lang.String getPrefix()

URI prefix for the document enumeration from the cache. Optional (when provided document URIs must match the prefix).

withPrefix

public RepushFromDocumentCache withPrefix(java.lang.String prefix)

setSync

public void setSync(boolean sync)

Triggers a commit at the end of the push operation.

isSync

public boolean isSync()

Triggers a commit at the end of the push operation.

withSync

public RepushFromDocumentCache withSync(boolean sync)

withSync

public RepushFromDocumentCache withSync(java.lang.Boolean sync)

makeCopy

public RepushFromDocumentCache makeCopy()

Creates and returns a deep copy of this RepushFromDocumentCache.

Overrides:

makeCopy in class BuildGroupSpecific

readFrom

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

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

Overrides:

writeTo in class BuildGroupSpecific

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RepushFromDocumentCache.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RepushFromDocumentCache.

Overrides:

toString in class BuildGroupSpecific

check

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

Checks this RepushFromDocumentCache.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BuildGroupSpecific

Throws:

com.exalead.util.TypedException