net.sf.regulus
Class RegResult

java.lang.Object
  net.sf.regulus.RegResult

public class RegResult

extends java.lang.Object

This object encapsulates information about recognition.

Field Summary

static int	ACTION_ABORTED The request has been aborted
static int	ACTION_ERROR An error occured while executing the request
static int	ACTION_SUCCEEDED The action that returned this object has been succesfull

Constructor Summary

RegResult(int status)

RegResult(int confidence, java.lang.String recognition)

RegResult(int confidence, java.lang.String recognition, java.lang.String interpretation)

RegResult(java.lang.String speechServerReply)

Method Summary

int	getConfidence()
java.lang.String	getInterpretation()
java.lang.Object	getInterpretationObject()
java.lang.String	getRecognition()
int	getStatus()
boolean	isActionSuccesfull() Convenience function to check if the result contains usefull infrmation
void	setConfidence(int conf)
void	setInterpretation(java.lang.String interpretation)
void	setRecognition(java.lang.String recognition)
void	setStatus(int status)
java.lang.String	toRegulusString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACTION_SUCCEEDED

public static final int ACTION_SUCCEEDED

The action that returned this object has been succesfull

See Also:

Constant Field Values

ACTION_ABORTED

public static final int ACTION_ABORTED

The request has been aborted

See Also:

Constant Field Values

ACTION_ERROR

public static final int ACTION_ERROR

An error occured while executing the request

See Also:

Constant Field Values

Constructor Detail

RegResult

public RegResult(java.lang.String speechServerReply)

RegResult

public RegResult(int status)

Parameters:

status -

RegResult

public RegResult(int confidence,
                 java.lang.String recognition,
                 java.lang.String interpretation)

Parameters:

confidence -

recognition -

interpretation -

RegResult

public RegResult(int confidence,
                 java.lang.String recognition)

Parameters:

confidence -

recognition -

Method Detail

getConfidence

public int getConfidence()

Returns:

Confidence of the recognition result.
Note that this field might not be set, e.g. when the object contains only an interpretation result.

getInterpretation

public java.lang.String getInterpretation()

Returns:

The Natural Language (NL) interpretation of the grammar.

getRecognition

public java.lang.String getRecognition()

Returns:

The recognition result.

setConfidence

public void setConfidence(int conf)

Parameters:

conf - - The confidence of the recognition result.

setInterpretation

public void setInterpretation(java.lang.String interpretation)

Parameters:

interpretation -

setRecognition

public void setRecognition(java.lang.String recognition)

Parameters:

recognition -

getStatus

public int getStatus()

Returns:

Contains the status of the result.
Can be one of ACTION_SUCCEEDED, ACTION_ABORTED, ACTION_ERROR

setStatus

public void setStatus(int status)

Parameters:

status - - Status is of ACTION_SUCCEEDED, ACTION_ABORTED, ACTION_ERROR

isActionSuccesfull

public boolean isActionSuccesfull()

Convenience function to check if the result contains usefull infrmation

Returns:

true if requested recognition/interpretation action was succesfull

getInterpretationObject

public java.lang.Object getInterpretationObject()

toRegulusString

public java.lang.String toRegulusString()

Returns:

A Regulus representation of the revognition result.