public Explanation() 
{

}

 public Explanation(float value,
    String description) 
{
    this.value = value;
    this.description = description;
}

 public  void addDetail(Explanation detail) 
{
    if (details == null)
      details = new ArrayList();
    details.add(detail);
}

Adds a sub-node to this explanation node.

 public String getDescription() 
{
 return description;
}

A description of this explanation node.

 public Explanation[] getDetails() 
{
    if (details == null)
      return null;
    return (Explanation[])details.toArray(new Explanation[0]);
}

The sub-nodes of this explanation node.

 protected String getSummary() 
{
    return getValue() + " = " + getDescription();
}

A short one line summary which should contain all high level information about this Explanation, without the "Details"

 public float getValue() 
{
 return value;
}

The value assigned to this explanation node.

 public boolean isMatch() 
{
    return (0.0f <  getValue());
}

Indicates whether or not this Explanation models a good match.

By default, an Explanation represents a "match" if the value is positive.

 public  void setDescription(String description) 
{
    this.description = description;
}

Sets the description of this explanation node.

 public  void setValue(float value) 
{
 this.value = value;
}

Sets the value assigned to this explanation node.

 public String toHtml() 
{
    StringBuffer buffer = new StringBuffer();
    buffer.append("< ul >\n");
    buffer.append("< li >");
    buffer.append(getSummary());
    buffer.append("< br / >\n");
    Explanation[] details = getDetails();
    if (details != null) {
      for (int i = 0 ; i <  details.length; i++) {
        buffer.append(details[i].toHtml());
      }
    }
    buffer.append("< /li >\n");
    buffer.append("< /ul >\n");
    return buffer.toString();
}

Render an explanation as HTML.

 public String toString() 
{
    return toString(0);
}

Render an explanation as text.

 protected String toString(int depth) 
{
    StringBuffer buffer = new StringBuffer();
    for (int i = 0; i <  depth; i++) {
      buffer.append("  ");
    }
    buffer.append(getSummary());
    buffer.append("\n");
    Explanation[] details = getDetails();
    if (details != null) {
      for (int i = 0 ; i <  details.length; i++) {
        buffer.append(details[i].toString(depth+1));
      }
    }
    return buffer.toString();
}