org.licas.ai_solver.model.result

Class Result

java.lang.Object

org.licas.ai_solver.model.result.Result

Direct Known Subclasses:

ClusterResult, ErrorResult, MatchResult

public class Result
extends java.lang.Object

This is a base class for storing the result of applying a problem solver on the problem set. This can return references to clusters or matching solutions.

Field Summary

Fields

Modifier and Type	Field and Description
protected EvalBounds	evaluation Result evaluation bounds if used.
protected java.lang.String	name The solution result name

Constructor Summary

Constructors

Constructor and Description
Result() Create a new instance of Result.
Result(java.lang.String thisName) Create a new instance of Result.

Method Summary

Modifier and Type	Method and Description
EvalBounds	getEvaluation() Get an evaluation that the process has produced.
java.lang.String	getName() Get the solution name.
boolean	isClusterType() Return true if this result is the cluster references type, false otherwise.
boolean	isErrorType() Return true if this result is the error type, false otherwise.
boolean	isMatchType() Return true if this result is the matching solutions type, false otherwise.
boolean	isValueType() Return true if this result is a base type storing an EvalBounds value only, false otherwise.
void	setEvaluation(EvalBounds theEvaluation) Set the evaluation value for the result.
void	setName(java.lang.String thisName) Set the solution name.
java.lang.String	toString() Get a string-based description of this grid solution.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

The solution result name

evaluation

protected EvalBounds evaluation

Result evaluation bounds if used.

Constructor Detail

Result

public Result()

Create a new instance of Result.

Result

public Result(java.lang.String thisName)

Create a new instance of Result.

Parameters:

thisName - the unique result ID.

Method Detail

isValueType

public boolean isValueType()

Return true if this result is a base type storing an EvalBounds value only, false otherwise.

Returns:

true if a Result, false otherwise.

isMatchType

public boolean isMatchType()

Return true if this result is the matching solutions type, false otherwise.

Returns:

true if a MatchResult, false otherwise.

isClusterType

public boolean isClusterType()

Return true if this result is the cluster references type, false otherwise.

Returns:

true if a ClusterResult, false otherwise.

isErrorType

public boolean isErrorType()

Return true if this result is the error type, false otherwise.

Returns:

true if a ErrorResult, false otherwise.

setName

public void setName(java.lang.String thisName)

Set the solution name.

Parameters:

thisName - the solution name.

getName

public java.lang.String getName()

Get the solution name.

Returns:

the value of name.

setEvaluation

public void setEvaluation(EvalBounds theEvaluation)

Set the evaluation value for the result.

Parameters:

theEvaluation - the evaluation value.

getEvaluation

public EvalBounds getEvaluation()

Get an evaluation that the process has produced.

Returns:

the value of evaluation.

toString

public java.lang.String toString()

Get a string-based description of this grid solution.

Overrides:

toString in class java.lang.Object

Returns:

string-based description of this object.