Instance (ClearTK 2.0.0 API)

java.lang.Object
- org.cleartk.ml.Instance<OUTCOME_TYPE>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InstanceStream.Terminator, QidInstance
```
public class Instance<OUTCOME_TYPE>
extends Object
implements Serializable
```
Copyright (c) 2007-2008, Regents of the University of Colorado
All rights reserved.

Author:

Steven Bethard

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Instance()` Create a new ClassifierInstance with an empty set of features and a null label.
`Instance(Collection<Feature> features)`
`Instance(OUTCOME_TYPE outcome)`
`Instance(OUTCOME_TYPE outcome, Collection<Feature> features)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(Feature feature)` Add a feature to the instance.
`void`	`addAll(Collection<Feature> feats)` Add a collection of features to the instance.
`boolean`	`equals(Object object)`
`List<Feature>`	`getFeatures()` Get the list of features for this instance.
`OUTCOME_TYPE`	`getOutcome()` Get the current label for the instance.
`int`	`hashCode()`
`void`	`setOutcome(OUTCOME_TYPE outcome)` Set the current label for the instance.
`String`	`toString()`

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

- Constructor Detail
  - Instance
```
public Instance()
```
    Create a new ClassifierInstance with an empty set of features and a null label.
  - Instance
```
public Instance(Collection<Feature> features)
```
  - Instance
```
public Instance(OUTCOME_TYPE outcome)
```
  - Instance
```
public Instance(OUTCOME_TYPE outcome,
        Collection<Feature> features)
```
- Method Detail
  - add
```
public void add(Feature feature)
```
    Add a feature to the instance.
    
    Parameters:
    feature - The feature to add.
  - addAll
```
public void addAll(Collection<Feature> feats)
```
    Add a collection of features to the instance.
    
    Parameters:
    feats - The features to add.
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - getFeatures
```
public List<Feature> getFeatures()
```
    Get the list of features for this instance.
    
    Returns:
    The list of features
  - getOutcome
```
public OUTCOME_TYPE getOutcome()
```
    Get the current label for the instance.
    
    Returns:
    The current label value.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - setOutcome
```
public void setOutcome(OUTCOME_TYPE outcome)
```
    Set the current label for the instance.
    
    Parameters:
    outcome - The new label value.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Instance<OUTCOME_TYPE>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Instance

Instance

Instance

Instance

Method Detail

add

addAll

equals

getFeatures

getOutcome

hashCode

setOutcome

toString