com.exalead.mercury.mami.indexing.v10

Class CompactIndexField

java.lang.Object

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

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

com.exalead.mercury.mami.indexing.v10.CompactIndexField

All Implemented Interfaces:

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

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

Performs a compact on an index field.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	firstSlot
int	lastSlot
java.lang.String	name

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
CompactIndexField()
CompactIndexField(CompactIndexField o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this CompactIndexField.
static CompactIndexField	fromString(java.lang.String s) String representation of this CompactIndexField.
int	getFirstSlot() The first slot to compact.
int	getLastSlot() The last slot to compact.
java.lang.String	getName() The name of the index field to compact
CompactIndexField	makeCopy() Creates and returns a deep copy of this CompactIndexField.
static CompactIndexField	readFrom(java.io.InputStream is) Read this CompactIndexField from an XML fragment.
void	setFirstSlot(int firstSlot) The first slot to compact.
void	setLastSlot(int lastSlot) The last slot to compact.
void	setName(java.lang.String name) The name of the index field to compact
java.lang.String	toString() String representation of this CompactIndexField.
CompactIndexField	withBuildGroup(java.lang.String buildGroup)
CompactIndexField	withFirstSlot(int firstSlot)
CompactIndexField	withFirstSlot(java.lang.Integer firstSlot)
CompactIndexField	withIndexSlices(java.lang.String indexSlices)
CompactIndexField	withLastSlot(int lastSlot)
CompactIndexField	withLastSlot(java.lang.Integer lastSlot)
CompactIndexField	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this CompactIndexField 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

firstSlot

public int firstSlot

lastSlot

public int lastSlot

Constructor Detail

CompactIndexField

public CompactIndexField()

CompactIndexField

public CompactIndexField(CompactIndexField o)

Copy constructor

Method Detail

withIndexSlices

public CompactIndexField withIndexSlices(java.lang.String indexSlices)

Overrides:

withIndexSlices in class IndexSlicesSpecific

withBuildGroup

public CompactIndexField 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 CompactIndexField withName(java.lang.String name)

setFirstSlot

public void setFirstSlot(int firstSlot)

The first slot to compact.

getFirstSlot

public int getFirstSlot()

The first slot to compact.

withFirstSlot

public CompactIndexField withFirstSlot(int firstSlot)

withFirstSlot

public CompactIndexField withFirstSlot(java.lang.Integer firstSlot)

setLastSlot

public void setLastSlot(int lastSlot)

The last slot to compact.

getLastSlot

public int getLastSlot()

The last slot to compact.

withLastSlot

public CompactIndexField withLastSlot(int lastSlot)

withLastSlot

public CompactIndexField withLastSlot(java.lang.Integer lastSlot)

makeCopy

public CompactIndexField makeCopy()

Creates and returns a deep copy of this CompactIndexField.

Overrides:

makeCopy in class IndexSlicesSpecific

readFrom

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

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

Overrides:

writeTo in class IndexSlicesSpecific

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CompactIndexField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CompactIndexField.

Overrides:

toString in class IndexSlicesSpecific

check

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

Checks this CompactIndexField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexSlicesSpecific

Throws:

com.exalead.util.TypedException