com.exalead.mercury.mami.indexunits.v10

Class Clear

java.lang.Object

com.exalead.mercury.mami.indexunits.v10.IUSpecific

com.exalead.mercury.mami.indexunits.v10.Clear

All Implemented Interfaces:

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

public class Clear
extends IUSpecific
implements com.exalead.util.Checkable, java.io.Serializable

Clears the whole Index Unit, deletes all data.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_KEEP_INDEX_INSTANCES
static boolean	DEFAULT_KEEP_REPLICATED_INDEX_INSTANCES
boolean	keepIndexInstances
boolean	keepReplicatedIndexInstances

Fields inherited from class com.exalead.mercury.mami.indexunits.v10.IUSpecific

indexUnit

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Clear.
static Clear	fromString(java.lang.String s) String representation of this Clear.
boolean	isKeepIndexInstances()
boolean	isKeepReplicatedIndexInstances()
Clear	makeCopy() Creates and returns a deep copy of this Clear.
static Clear	readFrom(java.io.InputStream is) Read this Clear from an XML fragment.
void	setKeepIndexInstances(boolean keepIndexInstances)
void	setKeepReplicatedIndexInstances(boolean keepReplicatedIndexInstances)
java.lang.String	toString() String representation of this Clear.
Clear	withIndexUnit(java.lang.String indexUnit)
Clear	withKeepIndexInstances(boolean keepIndexInstances)
Clear	withKeepIndexInstances(java.lang.Boolean keepIndexInstances)
Clear	withKeepReplicatedIndexInstances(boolean keepReplicatedIndexInstances)
Clear	withKeepReplicatedIndexInstances(java.lang.Boolean keepReplicatedIndexInstances)
void	writeTo(java.io.OutputStream os) Write this Clear as an XML fragment

Methods inherited from class com.exalead.mercury.mami.indexunits.v10.IUSpecific

getIndexUnit, setIndexUnit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

keepIndexInstances

public boolean keepIndexInstances

DEFAULT_KEEP_INDEX_INSTANCES

public static final boolean DEFAULT_KEEP_INDEX_INSTANCES

See Also:

Constant Field Values

keepReplicatedIndexInstances

public boolean keepReplicatedIndexInstances

DEFAULT_KEEP_REPLICATED_INDEX_INSTANCES

public static final boolean DEFAULT_KEEP_REPLICATED_INDEX_INSTANCES

See Also:

Constant Field Values

Constructor Detail

Clear

public Clear()

Clear

public Clear(Clear o)

Copy constructor

Method Detail

withIndexUnit

public Clear withIndexUnit(java.lang.String indexUnit)

Overrides:

withIndexUnit in class IUSpecific

setKeepIndexInstances

public void setKeepIndexInstances(boolean keepIndexInstances)

isKeepIndexInstances

public boolean isKeepIndexInstances()

withKeepIndexInstances

public Clear withKeepIndexInstances(boolean keepIndexInstances)

withKeepIndexInstances

public Clear withKeepIndexInstances(java.lang.Boolean keepIndexInstances)

setKeepReplicatedIndexInstances

public void setKeepReplicatedIndexInstances(boolean keepReplicatedIndexInstances)

isKeepReplicatedIndexInstances

public boolean isKeepReplicatedIndexInstances()

withKeepReplicatedIndexInstances

public Clear withKeepReplicatedIndexInstances(boolean keepReplicatedIndexInstances)

withKeepReplicatedIndexInstances

public Clear withKeepReplicatedIndexInstances(java.lang.Boolean keepReplicatedIndexInstances)

makeCopy

public Clear makeCopy()

Creates and returns a deep copy of this Clear.

Overrides:

makeCopy in class IUSpecific

readFrom

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

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

Overrides:

writeTo in class IUSpecific

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Clear.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Clear.

Overrides:

toString in class IUSpecific

check

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

Checks this Clear.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IUSpecific

Throws:

com.exalead.util.TypedException