edu.stanford.nlp.ling
Class BasicDatum<LabelType,FeatureType>

java.lang.Object
  edu.stanford.nlp.ling.BasicDatum<LabelType,FeatureType>

Type Parameters:

LabelType - The type of the labels in the Dataset

FeatureType - The type of the features in the Dataset

All Implemented Interfaces:

Datum<LabelType,FeatureType>, Featurizable<FeatureType>, Labeled<LabelType>, java.io.Serializable

public class BasicDatum<LabelType,FeatureType>
extends java.lang.Object
implements Datum<LabelType,FeatureType>

Basic implementation of Datum interface that can be constructed with a Collection of features and one more more labels. The features must be specified at construction, but the labels can be set and/or changed later.

Author:

Joseph Smarr (jsmarr@stanford.edu), Sarah Spikes (sdspikes@cs.stanford.edu) (Templatization)

See Also:

Serialized Form

Constructor Summary

BasicDatum()
Constructs a new BasicDatum with no features or labels.

BasicDatum(java.util.Collection<FeatureType> features)
Constructs a new BasicDatum with the given features and no labels.

BasicDatum(java.util.Collection<FeatureType> features, java.util.Collection<LabelType> labels)
Constructs a new BasicDatum with the given features and labels.

BasicDatum(java.util.Collection<FeatureType> features, LabelType label)
Constructs a new BasicDatum with the given features and label.

Method Summary

void	addLabel(LabelType label) Adds the given Label to the List of labels for this Datum if it is not null.
java.util.Collection<FeatureType>	asFeatures() Returns the collection that this BasicDatum was constructed with.
boolean	equals(java.lang.Object o) Returns whether the given Datum contains the same features as this Datum.
int	hashCode()
LabelType	label() Returns the first label for this Datum, or null if none have been set.
java.util.Collection<LabelType>	labels() Returns the complete List of labels for this Datum, which may be empty.
void	setLabel(LabelType label) Removes all currently assigned Labels for this Datum then adds the given Label.
void	setLabels(java.util.Collection<LabelType> labels) Removes all currently assigned labels for this Datum then adds all of the given Labels.
java.lang.String	toString() Returns a String representation of this BasicDatum (lists features and labels).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicDatum

public BasicDatum(java.util.Collection<FeatureType> features,
                  java.util.Collection<LabelType> labels)

Constructs a new BasicDatum with the given features and labels.

BasicDatum

public BasicDatum(java.util.Collection<FeatureType> features,
                  LabelType label)

Constructs a new BasicDatum with the given features and label.

BasicDatum

public BasicDatum(java.util.Collection<FeatureType> features)

Constructs a new BasicDatum with the given features and no labels.

BasicDatum

public BasicDatum()

Constructs a new BasicDatum with no features or labels.

Method Detail

asFeatures

public java.util.Collection<FeatureType> asFeatures()

Returns the collection that this BasicDatum was constructed with.

Specified by:

asFeatures in interface Featurizable<FeatureType>

label

public LabelType label()

Returns the first label for this Datum, or null if none have been set.

Specified by:

label in interface Labeled<LabelType>

labels

public java.util.Collection<LabelType> labels()

Returns the complete List of labels for this Datum, which may be empty.

Specified by:

labels in interface Labeled<LabelType>

setLabel

public void setLabel(LabelType label)

Removes all currently assigned Labels for this Datum then adds the given Label. Calling setLabel(null) effectively clears all labels.

setLabels

public void setLabels(java.util.Collection<LabelType> labels)

Removes all currently assigned labels for this Datum then adds all of the given Labels.

addLabel

public void addLabel(LabelType label)

Adds the given Label to the List of labels for this Datum if it is not null.

toString

public java.lang.String toString()

Returns a String representation of this BasicDatum (lists features and labels).

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Returns whether the given Datum contains the same features as this Datum. Doesn't check the labels, should we change this?

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object