com.exalead.mercury.mami.indexing.v10

Class CompactIndex

java.lang.Object

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

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

com.exalead.mercury.mami.indexing.v10.CompactIndex

All Implemented Interfaces:

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

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

Performs a compact on the index.
Index compact will merge all selected slots into a new slot.
For the compaction, you will need twice the disk space used by the compacted slots.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_SYNCHRONOUS
int	gen0
int	gen1
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
CompactIndex()
CompactIndex(CompactIndex o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this CompactIndex.
static CompactIndex	fromString(java.lang.String s) String representation of this CompactIndex.
int	getGen0() Lower gen bound to compact
int	getGen1() Upper gen bound to compact
boolean	isSynchronous() Force the compact to be executed synchronously
CompactIndex	makeCopy() Creates and returns a deep copy of this CompactIndex.
static CompactIndex	readFrom(java.io.InputStream is) Read this CompactIndex from an XML fragment.
void	setGen0(int gen0) Lower gen bound to compact
void	setGen1(int gen1) Upper gen bound to compact
void	setSynchronous(boolean synchronous) Force the compact to be executed synchronously
java.lang.String	toString() String representation of this CompactIndex.
CompactIndex	withBuildGroup(java.lang.String buildGroup)
CompactIndex	withGen0(int gen0)
CompactIndex	withGen0(java.lang.Integer gen0)
CompactIndex	withGen1(int gen1)
CompactIndex	withGen1(java.lang.Integer gen1)
CompactIndex	withIndexSlices(java.lang.String indexSlices)
CompactIndex	withSynchronous(boolean synchronous)
CompactIndex	withSynchronous(java.lang.Boolean synchronous)
void	writeTo(java.io.OutputStream os) Write this CompactIndex 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

gen0

public int gen0

gen1

public int gen1

synchronous

public boolean synchronous

DEFAULT_SYNCHRONOUS

public static final boolean DEFAULT_SYNCHRONOUS

See Also:

Constant Field Values

Constructor Detail

CompactIndex

public CompactIndex()

CompactIndex

public CompactIndex(CompactIndex o)

Copy constructor

Method Detail

withIndexSlices

public CompactIndex withIndexSlices(java.lang.String indexSlices)

Overrides:

withIndexSlices in class IndexSlicesSpecific

withBuildGroup

public CompactIndex withBuildGroup(java.lang.String buildGroup)

Overrides:

withBuildGroup in class IndexSlicesSpecific

setGen0

public void setGen0(int gen0)

Lower gen bound to compact

getGen0

public int getGen0()

Lower gen bound to compact

withGen0

public CompactIndex withGen0(int gen0)

withGen0

public CompactIndex withGen0(java.lang.Integer gen0)

setGen1

public void setGen1(int gen1)

Upper gen bound to compact

getGen1

public int getGen1()

Upper gen bound to compact

withGen1

public CompactIndex withGen1(int gen1)

withGen1

public CompactIndex withGen1(java.lang.Integer gen1)

setSynchronous

public void setSynchronous(boolean synchronous)

Force the compact to be executed synchronously

isSynchronous

public boolean isSynchronous()

Force the compact to be executed synchronously

withSynchronous

public CompactIndex withSynchronous(boolean synchronous)

withSynchronous

public CompactIndex withSynchronous(java.lang.Boolean synchronous)

makeCopy

public CompactIndex makeCopy()

Creates and returns a deep copy of this CompactIndex.

Overrides:

makeCopy in class IndexSlicesSpecific

readFrom

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

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

Overrides:

writeTo in class IndexSlicesSpecific

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CompactIndex.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CompactIndex.

Overrides:

toString in class IndexSlicesSpecific

check

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

Checks this CompactIndex.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexSlicesSpecific

Throws:

com.exalead.util.TypedException