weka.core
Class SelectedTag

java.lang.Object
  |
  +--weka.core.SelectedTag

public class SelectedTag
extends Object

Represents a selected value from a finite set of values, where each value is a Tag (i.e. has some string associated with it). Primarily used in schemes to select between alternative behaviours, associating names with the alternative behaviours.

Author:
Len Trigg

Field Summary
protected  int m_Selected
          The index of the selected tag
protected  Tag[] m_Tags
          The set of tags to choose from
 
Constructor Summary
SelectedTag(int tagID, Tag[] tags)
          Creates a new SelectedTag instance.
 
Method Summary
 boolean equals(Object o)
          Returns true if this SelectedTag equals another object
 Tag getSelectedTag()
          Gets the selected Tag.
 Tag[] getTags()
          Gets the set of all valid Tags.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_Selected

protected int m_Selected
The index of the selected tag


m_Tags

protected Tag[] m_Tags
The set of tags to choose from

Constructor Detail

SelectedTag

public SelectedTag(int tagID,
                   Tag[] tags)
Creates a new SelectedTag instance.

Parameters:
tagID - the id of the selected tag.
tags - an array containing the possible valid Tags.
Throws:
IllegalArgumentException - if the selected tag isn't in the array of valid values.
Method Detail

equals

public boolean equals(Object o)
Returns true if this SelectedTag equals another object

Overrides:
equals in class Object

getSelectedTag

public Tag getSelectedTag()
Gets the selected Tag.

Returns:
the selected Tag.

getTags

public Tag[] getTags()
Gets the set of all valid Tags.

Returns:
an array containing the valid Tags.