org.licas.ai_solver.model.result

Class ClusterResult

java.lang.Object

org.licas.ai_solver.model.result.Result

org.licas.ai_solver.model.result.ClusterResult

public class ClusterResult
extends Result

This class stores a list of clusters of type Cluster, that represent a reference set.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.lang.String,Cluster>	clusters List of clusters representing a complete solution.

Fields inherited from class org.licas.ai_solver.model.result.Result

evaluation, name

Constructor Summary

Constructors

Constructor and Description
ClusterResult() Create a new instance of ClusterResult.

Method Summary

Modifier and Type	Method and Description
boolean	addCluster(Cluster cluster) Add a new cluster to the result.
boolean	containsCluster(java.util.ArrayList<?> list) Return true if this result object contains a cluster with the indicated set of elements.
boolean	containsKey(java.lang.String key) Return true if this result object contains a cluster with the indicated key name.
java.lang.String	toString() Get a string-based description of this cluster result.

Methods inherited from class org.licas.ai_solver.model.result.Result

getEvaluation, getName, isClusterType, isErrorType, isMatchType, isValueType, setEvaluation, setName

Methods inherited from class java.lang.Object

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

Field Detail

clusters

public java.util.HashMap<java.lang.String,Cluster> clusters

List of clusters representing a complete solution. Key is a unique cluster ID and value is of type Cluster.

Constructor Detail

ClusterResult

public ClusterResult()

Create a new instance of ClusterResult.

Method Detail

containsKey

public boolean containsKey(java.lang.String key)
                    throws java.lang.Exception

Return true if this result object contains a cluster with the indicated key name.

Parameters:

key - name of a cluster to check for.

Returns:

true if this result object has a cluster with the indicated name.

Throws:

java.lang.Exception - any error.

containsCluster

public boolean containsCluster(java.util.ArrayList<?> list)
                        throws java.lang.Exception

Return true if this result object contains a cluster with the indicated set of elements.

Parameters:

list - the cluster elements to compare with. This uses ObjectHandler.equals to check if the elements are the same.

Returns:

true if this result object has a cluster that matches with the element list exactly.

Throws:

java.lang.Exception - any error.

addCluster

public boolean addCluster(Cluster cluster)

Add a new cluster to the result. It should be named with a unique ID.

Parameters:

cluster - the cluster to add.

Returns:

true if added, false if the name is missing or already exists.

toString

public java.lang.String toString()

Get a string-based description of this cluster result.

Overrides:

toString in class Result

Returns:

string-based description of this object.