BaseEntry (magpie API)

java.lang.Object
- magpie.data.BaseEntry

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.util.Comparator

Direct Known Subclasses:

MultiPropertyEntry
```
public class BaseEntry
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable, java.util.Comparator, java.lang.Comparable
```
This class is designed to store all information related to an entry in a Dataset

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

BaseEntry()
Create a blank entry

BaseEntry(java.lang.String input)
Generate an entry by parsing a text string

Constructors
Constructor and Description
`BaseEntry()` Create a blank entry
`BaseEntry(java.lang.String input)` Generate an entry by parsing a text string

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(double attribute)` Adds attribute value to the end of the list of current attributes
`void`	`addAttributes(double[] attributes)` Adds several attributes to the end of the attribute list.
`void`	`clearAttributes()` Clear all currently-set attributes.
`BaseEntry`	`clone()` Generates a clone of an entry.
`int`	`compare(java.lang.Object A_obj, java.lang.Object B_obj)`
`int`	`compareTo(java.lang.Object B)`
`void`	`deleteMeasuredClass()` Delete measured class variable.
`void`	`deletePredictedClass()` Delete predicted class variable.
`boolean`	`equals(java.lang.Object other)`
`double`	`getAttribute(int index)` Retrieve a certain attribute for this entry
`double[]`	`getAttributes()` Retrieve attributes for this entry
`double[]`	`getClassProbilities()` Get the probability of an entry existing in each class.
`double`	`getMeasuredClass()` Get the measured class variable
`double`	`getPredictedClass()` Get the predicted class variable
`boolean`	`hasClassProbabilities()` Whether this entry has predicted probabilities
`int`	`hashCode()`
`boolean`	`hasMeasurement()`
`boolean`	`hasPrediction()`
`int`	`NAttributes()` Get number of attributes currently set
`void`	`reduceMemoryFootprint()` Delete any cached information stored within this entry.
`void`	`setAttribute(int index, double value)` Set a certain attribute for this entry
`void`	`setAttributes(double[] attributes)` Sets attributes for this entry
`void`	`setClassProbabilities(double[] probabilites)` Set the predicted probability of a entry existing in each class
`void`	`setMeasuredClass(double x)` Set the measured class variable
`void`	`setPredictedClass(double x)` Set the predicted class variable
`java.lang.String`	`toHTMLString()` Print entry in a HTML-friendly format.
`org.json.JSONObject`	`toJSON()` Print entry as a JSON object
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

- Constructor Detail
  - BaseEntry
```
public BaseEntry()
```
    Create a blank entry
  - BaseEntry
```
public BaseEntry(java.lang.String input)
          throws java.lang.Exception
```
    Generate an entry by parsing a text string
    
    Parameters:
    
    input - String representing entry
    
    Throws:
    
    java.lang.Exception - If parse fails
- Method Detail
  - reduceMemoryFootprint
```
public void reduceMemoryFootprint()
```
    Delete any cached information stored within this entry.
  - NAttributes
```
public int NAttributes()
```
    Get number of attributes currently set
    
    Returns:
    
    Number of attributes
  - clearAttributes
```
public void clearAttributes()
```
    Clear all currently-set attributes.
  - getAttributes
```
public double[] getAttributes()
```
    Retrieve attributes for this entry
    
    Returns:
    
    List of attributes (same order as Dataset.AttributeName)
  - setAttributes
```
public void setAttributes(double[] attributes)
```
    Sets attributes for this entry
    
    Parameters:
    
    attributes - List of attributes (same order as Dataset.AttributeName)
  - getAttribute
```
public double getAttribute(int index)
```
    Retrieve a certain attribute for this entry
    
    Parameters:
    
    index - Index of attribute to retrieve
    
    Returns:
    
    Value of specified attribute
  - setAttribute
```
public void setAttribute(int index,
                         double value)
```
    Set a certain attribute for this entry
    
    Parameters:
    
    index - Index of attribute to set
    
    value - Desired value of specified attribute
  - addAttribute
```
public void addAttribute(double attribute)
```
    Adds attribute value to the end of the list of current attributes
    
    Parameters:
    
    attribute - Value of attribute to add
  - addAttributes
```
public void addAttributes(double[] attributes)
```
    Adds several attributes to the end of the attribute list.
    Dev Note: This is faster than adding the individually.
    
    Parameters:
    
    attributes - List of attribute values to be added
  - clone
```
public BaseEntry clone()
```
    Generates a clone of an entry. It creates a new list to store the attributes. So, the attribute data is preserved, but you can change the list as desired.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    Clone
  - compare
```
public int compare(java.lang.Object A_obj,
                   java.lang.Object B_obj)
```
    Specified by:
    
    compare in interface java.util.Comparator
  - compareTo
```
public final int compareTo(java.lang.Object B)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Specified by:
    
    equals in interface java.util.Comparator
    
    Overrides:
    
    equals in class java.lang.Object
  - hasMeasurement
```
public boolean hasMeasurement()
```
    Returns:
    
    Whether a measured class has been set for this entry
  - hasPrediction
```
public boolean hasPrediction()
```
    Returns:
    
    Whether a predicted class has been set for this entry
  - hasClassProbabilities
```
public boolean hasClassProbabilities()
```
    Whether this entry has predicted probabilities
    
    Returns:
    
    Whether it has probabilities
  - deleteMeasuredClass
```
public void deleteMeasuredClass()
```
    Delete measured class variable.
  - deletePredictedClass
```
public void deletePredictedClass()
```
    Delete predicted class variable.
  - getMeasuredClass
```
public double getMeasuredClass()
```
    Get the measured class variable
    
    Returns:
    
    Measured class, if known. NaN otherwise
  - setMeasuredClass
```
public void setMeasuredClass(double x)
```
    Set the measured class variable
    
    Parameters:
    
    x - Measured class
  - getPredictedClass
```
public double getPredictedClass()
```
    Get the predicted class variable
    
    Returns:
    
    Predicted class, if known. NaN otherwise
  - setPredictedClass
```
public void setPredictedClass(double x)
```
    Set the predicted class variable
    
    Parameters:
    
    x - Predicted class
  - setClassProbabilities
```
public void setClassProbabilities(double[] probabilites)
```
    Set the predicted probability of a entry existing in each class
    
    Parameters:
    
    probabilites - Probability of entry being in each class
  - getClassProbilities
```
public double[] getClassProbilities()
```
    Get the probability of an entry existing in each class. Returns null if no class probabilities have been stored
    
    Returns:
    
    Class probabilities
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toHTMLString
```
public java.lang.String toHTMLString()
```
    Print entry in a HTML-friendly format.
    
    Returns:
    
    Entry as a string
  - toJSON
```
public org.json.JSONObject toJSON()
```
    Print entry as a JSON object
    
    Returns:
    
    JSON object

Class BaseEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Comparator

Constructor Detail

BaseEntry

BaseEntry

Method Detail

reduceMemoryFootprint

NAttributes

clearAttributes

getAttributes

setAttributes

getAttribute

setAttribute

addAttribute

addAttributes

clone

compare

compareTo

hashCode

equals

hasMeasurement

hasPrediction

hasClassProbabilities

deleteMeasuredClass

deletePredictedClass

getMeasuredClass

setMeasuredClass

getPredictedClass

setPredictedClass

setClassProbabilities

getClassProbilities

toString

toHTMLString

toJSON