com.exalead.mercury.mami.indexing.v10

Class FullCompactIndexField

java.lang.Object

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

com.exalead.mercury.mami.indexing.v10.IndexSlicesSpecific

com.exalead.mercury.mami.indexing.v10.FullCompactIndexField

All Implemented Interfaces:

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

public class FullCompactIndexField
extends IndexSlicesSpecific
implements com.exalead.util.Checkable, java.io.Serializable

Performs a full compact on an index field.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_SYNCHRONOUS
java.lang.String	name
boolean	synchronous

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

indexSlices

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

buildGroup

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FullCompactIndexField.
static FullCompactIndexField	fromString(java.lang.String s) String representation of this FullCompactIndexField.
java.lang.String	getName() The name of the index field to compact.
boolean	isSynchronous() Force the full compact to be executed synchronously
FullCompactIndexField	makeCopy() Creates and returns a deep copy of this FullCompactIndexField.
static FullCompactIndexField	readFrom(java.io.InputStream is) Read this FullCompactIndexField from an XML fragment.
void	setName(java.lang.String name) The name of the index field to compact.
void	setSynchronous(boolean synchronous) Force the full compact to be executed synchronously
java.lang.String	toString() String representation of this FullCompactIndexField.
FullCompactIndexField	withBuildGroup(java.lang.String buildGroup)
FullCompactIndexField	withIndexSlices(java.lang.String indexSlices)
FullCompactIndexField	withName(java.lang.String name)
FullCompactIndexField	withSynchronous(boolean synchronous)
FullCompactIndexField	withSynchronous(java.lang.Boolean synchronous)
void	writeTo(java.io.OutputStream os) Write this FullCompactIndexField as an XML fragment

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

getIndexSlices, setIndexSlices

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

name

public java.lang.String name

synchronous

public boolean synchronous

DEFAULT_SYNCHRONOUS

public static final boolean DEFAULT_SYNCHRONOUS

See Also:

Constant Field Values

Constructor Detail

FullCompactIndexField

public FullCompactIndexField()

FullCompactIndexField

public FullCompactIndexField(FullCompactIndexField o)

Copy constructor

Method Detail

withIndexSlices

public FullCompactIndexField withIndexSlices(java.lang.String indexSlices)

Overrides:

withIndexSlices in class IndexSlicesSpecific

withBuildGroup

public FullCompactIndexField withBuildGroup(java.lang.String buildGroup)

Overrides:

withBuildGroup in class IndexSlicesSpecific

setName

public void setName(java.lang.String name)

The name of the index field to compact.

getName

public java.lang.String getName()

The name of the index field to compact.

withName

public FullCompactIndexField withName(java.lang.String name)

setSynchronous

public void setSynchronous(boolean synchronous)

Force the full compact to be executed synchronously

isSynchronous

public boolean isSynchronous()

Force the full compact to be executed synchronously

withSynchronous

public FullCompactIndexField withSynchronous(boolean synchronous)

withSynchronous

public FullCompactIndexField withSynchronous(java.lang.Boolean synchronous)

makeCopy

public FullCompactIndexField makeCopy()

Creates and returns a deep copy of this FullCompactIndexField.

Overrides:

makeCopy in class IndexSlicesSpecific

readFrom

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

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

Overrides:

writeTo in class IndexSlicesSpecific

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FullCompactIndexField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FullCompactIndexField.

Overrides:

toString in class IndexSlicesSpecific

check

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

Checks this FullCompactIndexField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexSlicesSpecific

Throws:

com.exalead.util.TypedException