retrieval
Class SimilaritySearchResult

java.lang.Object
  retrieval.SimilaritySearchResult

All Implemented Interfaces:

java.lang.Comparable<SimilaritySearchResult>

public class SimilaritySearchResult
extends java.lang.Object
implements java.lang.Comparable<SimilaritySearchResult>

Data structure to hold meta data about the matching result between a query skeleton object and a target object. The most important data to retrace the results are stored. The query object is assumed as known, so only the target object is saved.

SimilaritySearchResult implements Comparable, in the following way: A similarity search result instance is "smaller" than another one, if its matching costs are smaller. They are equal if their costs are equal, and a search result instance is "bigger" than another one if its costs are higher.

Field Summary

private java.lang.String	category the category of the target skeleton object
private MatchList	cl the found correspondences in the two skeleton objects
private double	costs the total costs to match the two objects
private java.lang.String	shapefilename the path to the shape image of the target skeleton object
private java.lang.String	skeletonfilename the path to the skeleton image of the target skeleton object
private SkeletonObject	so the target object

Constructor Summary

SimilaritySearchResult()

Method Summary

int	compareTo(SimilaritySearchResult o) Implementation of Comparable's compareTo.
java.lang.String	getCategory() get the category of the target skeleton object.
MatchList	getCl() get the found correspondences in the two skeleton objects, i.e.
double	getCosts() Get the total costs to match the two skeleton objects.
java.lang.String	getShapefilename() get the path to the shape image of the target skeleton object
java.lang.String	getSkeletonfilename() get the path to the skeleton image of the target skeleton object
SkeletonObject	getSo() Get the target skeleton object.
void	setCategory(java.lang.String category) set the category of the target skeleton object.
void	setCl(MatchList cl) set the found correspondences in the two skeleton objects, i.e.
void	setCosts(double costs) set the total costs to match the two skeleton objects
void	setShapefilename(java.lang.String shapefilename) set the path to the shape image of the target skeleton object
void	setSkeletonfilename(java.lang.String objectfilename) set the path to the skeleton image of the target skeleton object
void	setSo(SkeletonObject so) Set the target skeleton object

Methods inherited from class java.lang.Object

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

Field Detail

so

private SkeletonObject so

the target object

costs

private double costs

the total costs to match the two objects

shapefilename

private java.lang.String shapefilename

the path to the shape image of the target skeleton object

skeletonfilename

private java.lang.String skeletonfilename

the path to the skeleton image of the target skeleton object

category

private java.lang.String category

the category of the target skeleton object

cl

private MatchList cl

the found correspondences in the two skeleton objects

Constructor Detail

SimilaritySearchResult

public SimilaritySearchResult()

Method Detail

getCl

public MatchList getCl()

get the found correspondences in the two skeleton objects, i.e. the matching between the skeleton nodes of the one skeleton to the other.

Returns:

a list of all correspondences

setCl

public void setCl(MatchList cl)

set the found correspondences in the two skeleton objects, i.e. the matching between the skeleton nodes of the one skeleton to the other.

Parameters:

cl - - a list of all correspondences

getSo

public SkeletonObject getSo()

Get the target skeleton object.

Returns:

the target skeleton object

setSo

public void setSo(SkeletonObject so)

Set the target skeleton object

Parameters:

so - - the target skeleton object

getCosts

public double getCosts()

Get the total costs to match the two skeleton objects.

Returns:

the total costs for the matching between the query and the target skeleton

setCosts

public void setCosts(double costs)

set the total costs to match the two skeleton objects

Parameters:

costs - - the total costs for the matching between the query and the target skeleton

getShapefilename

public java.lang.String getShapefilename()

get the path to the shape image of the target skeleton object

Returns:

the path to the shape image

setShapefilename

public void setShapefilename(java.lang.String shapefilename)

set the path to the shape image of the target skeleton object

Parameters:

shapefilename - - the path to the shape image

getSkeletonfilename

public java.lang.String getSkeletonfilename()

get the path to the skeleton image of the target skeleton object

Returns:

the path to the skeleton image

setSkeletonfilename

public void setSkeletonfilename(java.lang.String objectfilename)

set the path to the skeleton image of the target skeleton object

Parameters:

objectfilename - - the path to the skeleton image

getCategory

public java.lang.String getCategory()

get the category of the target skeleton object.

Returns:

the target skeleton object's category

setCategory

public void setCategory(java.lang.String category)

set the category of the target skeleton object.

Parameters:

category - - the target skeleton object's category

compareTo

public int compareTo(SimilaritySearchResult o)

Implementation of Comparable's compareTo. A SimilaritySearchResult is smaller than another one, if its matching costs are smaller. It is bigger, if its matching costs are bigger, and they are equal, if their costs are equal.

Specified by:

compareTo in interface java.lang.Comparable<SimilaritySearchResult>