com.exalead.mercury.mami.indexunits.v10

Class IndexUnitStatus

java.lang.Object

com.exalead.mercury.mami.indexunits.v10.IndexUnitStatus

All Implemented Interfaces:

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

public class IndexUnitStatus
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Status of an Index Unit

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
PushAPIStatus	pushAPIStatus
long	startTimeInMs
int	totalIndexedDocuments

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this IndexUnitStatus.
static IndexUnitStatus	fromString(java.lang.String s) String representation of this IndexUnitStatus.
PushAPIStatus	getPushAPIStatus()
long	getStartTimeInMs() Start time (in milliseconds) of this Index Unit
int	getTotalIndexedDocuments() Total indexed documents of this Index Unit
IndexUnitStatus	makeCopy() Creates and returns a deep copy of this IndexUnitStatus.
static IndexUnitStatus	readFrom(java.io.InputStream is) Read this IndexUnitStatus from an XML fragment.
void	setPushAPIStatus(PushAPIStatus pushAPIStatus)
void	setStartTimeInMs(long startTimeInMs) Start time (in milliseconds) of this Index Unit
void	setTotalIndexedDocuments(int totalIndexedDocuments) Total indexed documents of this Index Unit
java.lang.String	toString() String representation of this IndexUnitStatus.
IndexUnitStatus	withPushAPIStatus(PushAPIStatus pushAPIStatus)
IndexUnitStatus	withStartTimeInMs(long startTimeInMs)
IndexUnitStatus	withStartTimeInMs(java.lang.Long startTimeInMs)
IndexUnitStatus	withTotalIndexedDocuments(int totalIndexedDocuments)
IndexUnitStatus	withTotalIndexedDocuments(java.lang.Integer totalIndexedDocuments)
void	writeTo(java.io.OutputStream os) Write this IndexUnitStatus as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

startTimeInMs

public long startTimeInMs

totalIndexedDocuments

public int totalIndexedDocuments

pushAPIStatus

public PushAPIStatus pushAPIStatus

Constructor Detail

IndexUnitStatus

public IndexUnitStatus()

IndexUnitStatus

public IndexUnitStatus(IndexUnitStatus o)

Copy constructor

Method Detail

setStartTimeInMs

public void setStartTimeInMs(long startTimeInMs)

Start time (in milliseconds) of this Index Unit

getStartTimeInMs

public long getStartTimeInMs()

Start time (in milliseconds) of this Index Unit

withStartTimeInMs

public IndexUnitStatus withStartTimeInMs(long startTimeInMs)

withStartTimeInMs

public IndexUnitStatus withStartTimeInMs(java.lang.Long startTimeInMs)

setTotalIndexedDocuments

public void setTotalIndexedDocuments(int totalIndexedDocuments)

Total indexed documents of this Index Unit

getTotalIndexedDocuments

public int getTotalIndexedDocuments()

Total indexed documents of this Index Unit

withTotalIndexedDocuments

public IndexUnitStatus withTotalIndexedDocuments(int totalIndexedDocuments)

withTotalIndexedDocuments

public IndexUnitStatus withTotalIndexedDocuments(java.lang.Integer totalIndexedDocuments)

setPushAPIStatus

public void setPushAPIStatus(PushAPIStatus pushAPIStatus)

getPushAPIStatus

public PushAPIStatus getPushAPIStatus()

withPushAPIStatus

public IndexUnitStatus withPushAPIStatus(PushAPIStatus pushAPIStatus)

makeCopy

public IndexUnitStatus makeCopy()

Creates and returns a deep copy of this IndexUnitStatus.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this IndexUnitStatus.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IndexUnitStatus.

Overrides:

toString in class java.lang.Object

check

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

Checks this IndexUnitStatus.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException