edu.stanford.nlp.dbm
Class BasicDatum

java.lang.Object
  |
  +--edu.stanford.nlp.dbm.BasicDatum

All Implemented Interfaces:

Datum, Featurizable, Labeled, Serializable

public class BasicDatum

extends Object

implements Datum

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.

See Also:

Serialized Form

Constructor Summary

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

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

BasicDatum(Collection features, Collection labels)
Constructs a new BasicDatum with the given features and labels.

BasicDatum(Collection features, Label label)
Constructs a new BasicDatum with the given features and label.

Method Summary

void	addLabel(Label label) Adds the given Label to the List of labels for this Datum if it is not null.
Collection	asFeatures() Returns the collection that this BasicDatum was constructed with.
Label	label() Returns the first label for this Datum, or null if none have been set.
Collection	labels() Returns the complete List of labels for this Datum, which may be empty.
void	setLabel(Label label) Removes all currently assigned Labels for this Datum then adds the given Label.
void	setLabels(Collection labels) Removes all currently assigned labels for this Datum then adds all of the given Labels.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicDatum

public BasicDatum(Collection features,
                  Collection labels)

Constructs a new BasicDatum with the given features and labels.

BasicDatum

public BasicDatum(Collection features,
                  Label label)

Constructs a new BasicDatum with the given features and label.

BasicDatum

public BasicDatum(Collection 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 Collection asFeatures()

Returns the collection that this BasicDatum was constructed with.

Specified by:

asFeatures in interface Featurizable

label

public Label label()

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

Specified by:

label in interface Labeled

Returns:

One of the labels of the object (if there are multiple labels, preferably the primary label, if it exists). Returns null if there is no label.

labels

public Collection labels()

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

Specified by:

labels in interface Labeled

Returns:

A Collection of the Object's labels. Returns an empty Collection if there are no labels.

setLabel

public void setLabel(Label label)

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

Specified by:

setLabel in interface Labeled

setLabels

public void setLabels(Collection labels)

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

Specified by:

setLabels in interface Labeled

addLabel

public void addLabel(Label label)

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