com.exalead.mercury.mami.indexing.v10

Class RepushSingleDocumentFromDocumentCache

java.lang.Object

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

com.exalead.mercury.mami.indexing.v10.RepushSingleDocumentFromDocumentCache

All Implemented Interfaces:

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

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

Repushes a document from the document cache to the PAPI.
This is an asynchronous operation. The cache retrieval is controlled by the "source" and "uri" attributes.
The document is repushed with a cache=false directive, which means that it 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	source
boolean	sync
java.lang.String	toBuildGroup
java.lang.String	uri

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

buildGroup

Constructor Summary

Constructors

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

Method Summary

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

uri

public java.lang.String uri

sync

public boolean sync

DEFAULT_SYNC

public static final boolean DEFAULT_SYNC

See Also:

Constant Field Values

Constructor Detail

RepushSingleDocumentFromDocumentCache

public RepushSingleDocumentFromDocumentCache()

RepushSingleDocumentFromDocumentCache

public RepushSingleDocumentFromDocumentCache(RepushSingleDocumentFromDocumentCache o)

Copy constructor

Method Detail

withBuildGroup

public RepushSingleDocumentFromDocumentCache withBuildGroup(java.lang.String buildGroup)

Overrides:

withBuildGroup in class BuildGroupSpecific

setToBuildGroup

public void setToBuildGroup(java.lang.String toBuildGroup)

Name of the build group the document will be pushed to.
If null, the document will be pushed to the same build group it is originated from.

getToBuildGroup

public java.lang.String getToBuildGroup()

Name of the build group the document will be pushed to.
If null, the document will be pushed to the same build group it is originated from.

withToBuildGroup

public RepushSingleDocumentFromDocumentCache withToBuildGroup(java.lang.String toBuildGroup)

setSource

public void setSource(java.lang.String source)

Name of the source of the document.

getSource

public java.lang.String getSource()

Name of the source of the document.

withSource

public RepushSingleDocumentFromDocumentCache withSource(java.lang.String source)

setUri

public void setUri(java.lang.String uri)

URI of the document.

getUri

public java.lang.String getUri()

URI of the document.

withUri

public RepushSingleDocumentFromDocumentCache withUri(java.lang.String uri)

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 RepushSingleDocumentFromDocumentCache withSync(boolean sync)

withSync

public RepushSingleDocumentFromDocumentCache withSync(java.lang.Boolean sync)

makeCopy

public RepushSingleDocumentFromDocumentCache makeCopy()

Creates and returns a deep copy of this RepushSingleDocumentFromDocumentCache.

Overrides:

makeCopy in class BuildGroupSpecific

readFrom

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

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

Overrides:

writeTo in class BuildGroupSpecific

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RepushSingleDocumentFromDocumentCache.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RepushSingleDocumentFromDocumentCache.

Overrides:

toString in class BuildGroupSpecific

check

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

Checks this RepushSingleDocumentFromDocumentCache.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BuildGroupSpecific

Throws:

com.exalead.util.TypedException