com.exalead.mercury.mami.search.v20

Class SuggestStatus

java.lang.Object

com.exalead.mercury.mami.search.v20.SuggestStatus

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SuggestStatus.Status

Field Summary

Fields

Modifier and Type	Field and Description
long	currentJobElapsed
static long	DEFAULT_CURRENT_JOB_ELAPSED
static long	DEFAULT_START_TIME
static java.lang.String	DEFAULT_STATUS
java.lang.String	message
long	startTime
java.lang.String	status
SuggestBuildStatus	suggestBuildStatus
java.lang.String	suggestName

Constructor Summary

Constructors

Constructor and Description
SuggestStatus()
SuggestStatus(java.lang.String suggestName)
SuggestStatus(SuggestStatus o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SuggestStatus.
static SuggestStatus	fromString(java.lang.String s) String representation of this SuggestStatus.
long	getCurrentJobElapsed() Number of milliseconds elapsed since starTime
java.lang.String	getMessage() Error message in case of errors.
long	getStartTime() Build start time stamp
java.lang.String	getStatus() Suggest status Idle: A build has finished and the suggest builder is idle, or has never been built Pending: A suggest build has been triggered, but it's not yet building Exporting: Suggest entries are being exported Sorting: Suggest entries are being sorted Computing: Computing suggest permutations Building: The suggest lookup structure is being built Syncing: Build is successful, the resource is now being published Error: An error occurred during the build process
SuggestStatus.Status	getStatusAsEnum() Suggest status Idle: A build has finished and the suggest builder is idle, or has never been built Pending: A suggest build has been triggered, but it's not yet building Exporting: Suggest entries are being exported Sorting: Suggest entries are being sorted Computing: Computing suggest permutations Building: The suggest lookup structure is being built Syncing: Build is successful, the resource is now being published Error: An error occurred during the build process
SuggestBuildStatus	getSuggestBuildStatus() Build Status after a successful build
java.lang.String	getSuggestName() The service name
static boolean	isA(java.lang.String str, SuggestStatus.Status item)
boolean	isBuilding()
static boolean	isOneOf(java.lang.String str, SuggestStatus.Status... items)
boolean	isScheduled()
SuggestStatus	makeCopy() Creates and returns a deep copy of this SuggestStatus.
static SuggestStatus	readFrom(java.io.InputStream is) Read this SuggestStatus from an XML fragment.
void	setCurrentJobElapsed(long currentJobElapsed) Number of milliseconds elapsed since starTime
void	setMessage(java.lang.String message) Error message in case of errors.
void	setStartTime(long startTime) Build start time stamp
void	setStatus(java.lang.String status) Suggest status Idle: A build has finished and the suggest builder is idle, or has never been built Pending: A suggest build has been triggered, but it's not yet building Exporting: Suggest entries are being exported Sorting: Suggest entries are being sorted Computing: Computing suggest permutations Building: The suggest lookup structure is being built Syncing: Build is successful, the resource is now being published Error: An error occurred during the build process
void	setStatus(SuggestStatus.Status item) Suggest status Idle: A build has finished and the suggest builder is idle, or has never been built Pending: A suggest build has been triggered, but it's not yet building Exporting: Suggest entries are being exported Sorting: Suggest entries are being sorted Computing: Computing suggest permutations Building: The suggest lookup structure is being built Syncing: Build is successful, the resource is now being published Error: An error occurred during the build process
void	setSuggestBuildStatus(SuggestBuildStatus suggestBuildStatus) Build Status after a successful build
void	setSuggestName(java.lang.String suggestName) The service name
java.lang.String	toString() String representation of this SuggestStatus.
SuggestStatus	withCurrentJobElapsed(long currentJobElapsed)
SuggestStatus	withCurrentJobElapsed(java.lang.Long currentJobElapsed)
SuggestStatus	withMessage(java.lang.String message)
SuggestStatus	withStartTime(long startTime)
SuggestStatus	withStartTime(java.lang.Long startTime)
SuggestStatus	withStatus(java.lang.String status)
SuggestStatus	withSuggestBuildStatus(SuggestBuildStatus suggestBuildStatus)
SuggestStatus	withSuggestName(java.lang.String suggestName)
void	writeTo(java.io.OutputStream os) Write this SuggestStatus as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

status

public java.lang.String status

DEFAULT_STATUS

public static final java.lang.String DEFAULT_STATUS

See Also:

Constant Field Values

suggestName

public java.lang.String suggestName

message

public java.lang.String message

startTime

public long startTime

DEFAULT_START_TIME

public static final long DEFAULT_START_TIME

See Also:

Constant Field Values

currentJobElapsed

public long currentJobElapsed

DEFAULT_CURRENT_JOB_ELAPSED

public static final long DEFAULT_CURRENT_JOB_ELAPSED

See Also:

Constant Field Values

suggestBuildStatus

public SuggestBuildStatus suggestBuildStatus

Constructor Detail

SuggestStatus

public SuggestStatus()

SuggestStatus

public SuggestStatus(java.lang.String suggestName)

SuggestStatus

public SuggestStatus(SuggestStatus o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          SuggestStatus.Status item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              SuggestStatus.Status... items)

setStatus

public void setStatus(SuggestStatus.Status item)

Suggest status

• Idle: A build has finished and the suggest builder is idle, or has never been built
• Pending: A suggest build has been triggered, but it's not yet building
• Exporting: Suggest entries are being exported
• Sorting: Suggest entries are being sorted
• Computing: Computing suggest permutations
• Building: The suggest lookup structure is being built
• Syncing: Build is successful, the resource is now being published
• Error: An error occurred during the build process

getStatusAsEnum

public SuggestStatus.Status getStatusAsEnum()

Suggest status

• Idle: A build has finished and the suggest builder is idle, or has never been built
• Pending: A suggest build has been triggered, but it's not yet building
• Exporting: Suggest entries are being exported
• Sorting: Suggest entries are being sorted
• Computing: Computing suggest permutations
• Building: The suggest lookup structure is being built
• Syncing: Build is successful, the resource is now being published
• Error: An error occurred during the build process

setStatus

public void setStatus(java.lang.String status)

Suggest status

• Idle: A build has finished and the suggest builder is idle, or has never been built
• Pending: A suggest build has been triggered, but it's not yet building
• Exporting: Suggest entries are being exported
• Sorting: Suggest entries are being sorted
• Computing: Computing suggest permutations
• Building: The suggest lookup structure is being built
• Syncing: Build is successful, the resource is now being published
• Error: An error occurred during the build process

getStatus

public java.lang.String getStatus()

Suggest status

• Idle: A build has finished and the suggest builder is idle, or has never been built
• Pending: A suggest build has been triggered, but it's not yet building
• Exporting: Suggest entries are being exported
• Sorting: Suggest entries are being sorted
• Computing: Computing suggest permutations
• Building: The suggest lookup structure is being built
• Syncing: Build is successful, the resource is now being published
• Error: An error occurred during the build process

withStatus

public SuggestStatus withStatus(java.lang.String status)

setSuggestName

public void setSuggestName(java.lang.String suggestName)

The service name

getSuggestName

public java.lang.String getSuggestName()

The service name

withSuggestName

public SuggestStatus withSuggestName(java.lang.String suggestName)

setMessage

public void setMessage(java.lang.String message)

Error message in case of errors.

getMessage

public java.lang.String getMessage()

Error message in case of errors.

withMessage

public SuggestStatus withMessage(java.lang.String message)

setStartTime

public void setStartTime(long startTime)

Build start time stamp

getStartTime

public long getStartTime()

Build start time stamp

withStartTime

public SuggestStatus withStartTime(long startTime)

withStartTime

public SuggestStatus withStartTime(java.lang.Long startTime)

setCurrentJobElapsed

public void setCurrentJobElapsed(long currentJobElapsed)

Number of milliseconds elapsed since starTime

getCurrentJobElapsed

public long getCurrentJobElapsed()

Number of milliseconds elapsed since starTime

withCurrentJobElapsed

public SuggestStatus withCurrentJobElapsed(long currentJobElapsed)

withCurrentJobElapsed

public SuggestStatus withCurrentJobElapsed(java.lang.Long currentJobElapsed)

setSuggestBuildStatus

public void setSuggestBuildStatus(SuggestBuildStatus suggestBuildStatus)

Build Status after a successful build

getSuggestBuildStatus

public SuggestBuildStatus getSuggestBuildStatus()

Build Status after a successful build

withSuggestBuildStatus

public SuggestStatus withSuggestBuildStatus(SuggestBuildStatus suggestBuildStatus)

makeCopy

public SuggestStatus makeCopy()

Creates and returns a deep copy of this SuggestStatus.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SuggestStatus.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SuggestStatus.

Overrides:

toString in class java.lang.Object

check

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

Checks this SuggestStatus.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

isScheduled

public boolean isScheduled()

isBuilding

public boolean isBuilding()