com.exalead.mercury.mami.indexing.v10

Class AreDocumentsSearchable

java.lang.Object

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

com.exalead.mercury.mami.indexing.v10.AreDocumentsSearchable

All Implemented Interfaces:

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

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

Tests whether documents prior to a given serial number are searchable, that is, available on the index slices.
A Serial value is retrieved from PAPI set_checkpoint calls.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_IGNORE_DETACHED_REPLICAS
static boolean	DEFAULT_ON_ALL_REPLICAS
boolean	ignoreDetachedReplicas
boolean	onAllReplicas
long	serial

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

buildGroup

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AreDocumentsSearchable.
static AreDocumentsSearchable	fromString(java.lang.String s) String representation of this AreDocumentsSearchable.
long	getSerial()
boolean	isIgnoreDetachedReplicas() Ignores detached replicas.
boolean	isOnAllReplicas() Are searchable on all replicas. By default, it must be available on the master only.
AreDocumentsSearchable	makeCopy() Creates and returns a deep copy of this AreDocumentsSearchable.
static AreDocumentsSearchable	readFrom(java.io.InputStream is) Read this AreDocumentsSearchable from an XML fragment.
void	setIgnoreDetachedReplicas(boolean ignoreDetachedReplicas) Ignores detached replicas.
void	setOnAllReplicas(boolean onAllReplicas) Are searchable on all replicas. By default, it must be available on the master only.
void	setSerial(long serial)
java.lang.String	toString() String representation of this AreDocumentsSearchable.
AreDocumentsSearchable	withBuildGroup(java.lang.String buildGroup)
AreDocumentsSearchable	withIgnoreDetachedReplicas(boolean ignoreDetachedReplicas)
AreDocumentsSearchable	withIgnoreDetachedReplicas(java.lang.Boolean ignoreDetachedReplicas)
AreDocumentsSearchable	withOnAllReplicas(boolean onAllReplicas)
AreDocumentsSearchable	withOnAllReplicas(java.lang.Boolean onAllReplicas)
AreDocumentsSearchable	withSerial(long serial)
AreDocumentsSearchable	withSerial(java.lang.Long serial)
void	writeTo(java.io.OutputStream os) Write this AreDocumentsSearchable 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

serial

public long serial

onAllReplicas

public boolean onAllReplicas

DEFAULT_ON_ALL_REPLICAS

public static final boolean DEFAULT_ON_ALL_REPLICAS

See Also:

Constant Field Values

ignoreDetachedReplicas

public boolean ignoreDetachedReplicas

DEFAULT_IGNORE_DETACHED_REPLICAS

public static final boolean DEFAULT_IGNORE_DETACHED_REPLICAS

See Also:

Constant Field Values

Constructor Detail

AreDocumentsSearchable

public AreDocumentsSearchable()

AreDocumentsSearchable

public AreDocumentsSearchable(AreDocumentsSearchable o)

Copy constructor

Method Detail

withBuildGroup

public AreDocumentsSearchable withBuildGroup(java.lang.String buildGroup)

Overrides:

withBuildGroup in class BuildGroupSpecific

setSerial

public void setSerial(long serial)

getSerial

public long getSerial()

withSerial

public AreDocumentsSearchable withSerial(long serial)

withSerial

public AreDocumentsSearchable withSerial(java.lang.Long serial)

setOnAllReplicas

public void setOnAllReplicas(boolean onAllReplicas)

Are searchable on all replicas.
By default, it must be available on the master only.

isOnAllReplicas

public boolean isOnAllReplicas()

Are searchable on all replicas.
By default, it must be available on the master only.

withOnAllReplicas

public AreDocumentsSearchable withOnAllReplicas(boolean onAllReplicas)

withOnAllReplicas

public AreDocumentsSearchable withOnAllReplicas(java.lang.Boolean onAllReplicas)

setIgnoreDetachedReplicas

public void setIgnoreDetachedReplicas(boolean ignoreDetachedReplicas)

Ignores detached replicas.

isIgnoreDetachedReplicas

public boolean isIgnoreDetachedReplicas()

Ignores detached replicas.

withIgnoreDetachedReplicas

public AreDocumentsSearchable withIgnoreDetachedReplicas(boolean ignoreDetachedReplicas)

withIgnoreDetachedReplicas

public AreDocumentsSearchable withIgnoreDetachedReplicas(java.lang.Boolean ignoreDetachedReplicas)

makeCopy

public AreDocumentsSearchable makeCopy()

Creates and returns a deep copy of this AreDocumentsSearchable.

Overrides:

makeCopy in class BuildGroupSpecific

readFrom

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

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

Overrides:

writeTo in class BuildGroupSpecific

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AreDocumentsSearchable.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AreDocumentsSearchable.

Overrides:

toString in class BuildGroupSpecific

check

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

Checks this AreDocumentsSearchable.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BuildGroupSpecific

Throws:

com.exalead.util.TypedException