weka.core
Class Tag

java.lang.Object
  weka.core.Tag

public class Tag
extends java.lang.Object

A Tag simply associates a numeric ID with a String description.

Version:

$Revision: 1.9 $

Author:

Len Trigg

Constructor Summary

Tag(int ident, java.lang.String readable)
Creates a new Tag instance.

Tag(int ident, java.lang.String identStr, java.lang.String readable)
Creates a new Tag instance.

Method Summary

int	getID() Gets the numeric ID of the Tag.
java.lang.String	getIDStr() Gets the string ID of the Tag.
java.lang.String	getReadable() Gets the string description of the Tag.
static java.lang.String	toOptionList(Tag[] tags) returns a list that can be used in the listOption methods to list all the available ID strings, e.g.: <0|1|2> or <what|ever>
static java.lang.String	toOptionSynopsis(Tag[] tags) returns a string that can be used in the listOption methods to list all the available options, i.e., "\t\tID = Text\n" for each option
java.lang.String	toString() returns the IDStr

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Tag

public Tag(int ident,
           java.lang.String readable)

Creates a new Tag instance.

Parameters:

ident - the ID for the new Tag.

readable - the description for the new Tag.

Tag

public Tag(int ident,
           java.lang.String identStr,
           java.lang.String readable)

Creates a new Tag instance.

Parameters:

ident - the ID for the new Tag.

identStr - the ID string for the new Tag (case-insensitive).

readable - the description for the new Tag.

Method Detail

getID

public int getID()

Gets the numeric ID of the Tag.

Returns:

the ID of the Tag.

getIDStr

public java.lang.String getIDStr()

Gets the string ID of the Tag.

Returns:

the string ID of the Tag.

getReadable

public java.lang.String getReadable()

Gets the string description of the Tag.

Returns:

the description of the Tag.

toString

public java.lang.String toString()

returns the IDStr

Overrides:

toString in class java.lang.Object

Returns:

the IDStr

toOptionList

public static java.lang.String toOptionList(Tag[] tags)

returns a list that can be used in the listOption methods to list all the available ID strings, e.g.: <0|1|2> or <what|ever>

Parameters:

tags - the tags to create the list for

Returns:

a list of all ID strings

toOptionSynopsis

public static java.lang.String toOptionSynopsis(Tag[] tags)

returns a string that can be used in the listOption methods to list all the available options, i.e., "\t\tID = Text\n" for each option

Parameters:

tags - the tags to create the string for

Returns:

a string explaining the tags