Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

marf.Storage
Class Result  view Result download Result.java

java.lang.Object
  extended bymarf.Storage.Result
All Implemented Interfaces:
java.io.Serializable

public class Result
extends java.lang.Object
implements java.io.Serializable

Represents a single classification result - ID and some value indicating either certain distance from the sample being recognized or a probability.

$Id: Result.java,v 1.20 2005/08/13 16:28:49 mokhov Exp $

Since:
0.0.1
Version:
$Revision: 1.20 $

Field Summary
protected  double dOutcome
          Distance/probability.
protected  int iID
          Identified subject's ID.
private static long serialVersionUID
          For serialization versioning.
protected  java.lang.String strDescription
          Textual result description.
 
Constructor Summary
Result()
          Default Constructor.
Result(double pdOutcome, java.lang.String pstrDescription)
          Outcome/description Constructor.
Result(int piID)
          ID Constructor.
Result(int piID, double pdOutcome)
          ID/outcome Constructor.
Result(int piID, double pdOutcome, java.lang.String pstrDescription)
          General ID/outcome/description Constructor.
Result(int piID, java.lang.String pstrDescription)
          ID/description Constructor.
 
Method Summary
 java.lang.String getDescription()
          Retrieves textual description of the result.
 int getID()
          Returns result's ID.
static java.lang.String getMARFSourceCodeRevision()
          Returns source code revision information.
 double getOutcome()
          Retrieves the outcome value.
 void setDescription(java.lang.String pstrDescription)
          Sets description of the result.
 void setID(int piID)
          Sets ID, should only be called by a Classification module.
 void setOutcome(double pdOutcome)
          Sets outcome value.
 java.lang.String toString()
          Retrieves the result values in a form of string, which is of the following form: [ID:outcome:description].
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

iID

protected int iID
Identified subject's ID.


strDescription

protected java.lang.String strDescription
Textual result description.

Since:
0.3.0

dOutcome

protected double dOutcome
Distance/probability.

Since:
0.3.0

serialVersionUID

private static final long serialVersionUID
For serialization versioning. When adding new members or make other structural changes regenerate this number with the serialver tool that comes with JDK.

Since:
0.3.0.4
See Also:
Constant Field Values
Constructor Detail

Result

public Result()
Default Constructor. Equivalent to Result(0)


Result

public Result(int piID)
ID Constructor. Equivalent to Result(piID, 0, "").


Result

public Result(int piID,
              double pdOutcome)
ID/outcome Constructor. Equivalent to Result(piID, pdOutcome, "").

Since:
0.3.0

Result

public Result(int piID,
              java.lang.String pstrDescription)
ID/description Constructor. Equivalent to Result(piID, 0, pstrDescription).

Since:
0.3.0

Result

public Result(double pdOutcome,
              java.lang.String pstrDescription)
Outcome/description Constructor. Equivalent to Result(0, pdOutcome, pstrDescription).

Since:
0.3.0

Result

public Result(int piID,
              double pdOutcome,
              java.lang.String pstrDescription)
General ID/outcome/description Constructor.

Since:
0.3.0
Method Detail

getID

public final int getID()
Returns result's ID.


getOutcome

public final double getOutcome()
Retrieves the outcome value.

Since:
0.3.0

getDescription

public final java.lang.String getDescription()
Retrieves textual description of the result.

Since:
0.3.0

toString

public java.lang.String toString()
Retrieves the result values in a form of string, which is of the following form: [ID:outcome:description].

Since:
0.3.0

setID

public final void setID(int piID)
Sets ID, should only be called by a Classification module.


setOutcome

public final void setOutcome(double pdOutcome)
Sets outcome value.

Since:
0.3.0.2

setDescription

public final void setDescription(java.lang.String pstrDescription)
Sets description of the result.

Since:
0.3.0.2

getMARFSourceCodeRevision

public static java.lang.String getMARFSourceCodeRevision()
Returns source code revision information.

Since:
0.3.0.2