Package weka.core

Class Tag

java.lang.Object
weka.core.Tag
All Implemented Interfaces:
Serializable, RevisionHandler
public class Tag extends Object implements Serializable, RevisionHandler
A Tag simply associates a numeric ID with a String description.
Version:
$Revision: 8034 $
Author:
Len Trigg
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Tag()
    Creates a new default Tag
    Tag(int ident, String readable)
    Creates a new Tag instance.
    Tag(int ident, String identStr, String readable)
    Creates a new Tag instance.
    Tag(int ident, String identStr, String readable, boolean upperCase)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getID()
    Gets the numeric ID of the Tag.
    String
    getIDStr()
    Gets the string ID of the Tag.
    String
    getReadable()
    Gets the string description of the Tag.
    String
    getRevision()
    Returns the revision string.
    void
    setID(int id)
    Sets the numeric ID of the Tag.
    void
    setIDStr(String str)
    Sets the string ID of the Tag.
    void
    setReadable(String r)
    Sets the string description of the Tag.
    static 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 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
    String
    toString()
    returns the IDStr

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Tag

      public Tag()
      Creates a new default Tag

    • Tag

      public Tag(int ident, 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, String identStr, 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.

    • Tag

      public Tag(int ident, String identStr, String readable, boolean upperCase)

  • Method Details

    • getID

      public int getID()
      Gets the numeric ID of the Tag.
      Returns:
      the ID of the Tag.

    • setID

      public void setID(int id)
      Sets the numeric ID of the Tag.
      Parameters:
      id - the ID of the Tag.

    • getIDStr

      public String getIDStr()
      Gets the string ID of the Tag.
      Returns:
      the string ID of the Tag.

    • setIDStr

      public void setIDStr(String str)
      Sets the string ID of the Tag.
      Parameters:
      str - the string ID of the Tag.

    • getReadable

      public String getReadable()
      Gets the string description of the Tag.
      Returns:
      the description of the Tag.

    • setReadable

      public void setReadable(String r)
      Sets the string description of the Tag.
      Parameters:
      r - the description of the Tag.

    • toString

      public String toString()
      returns the IDStr
      Overrides:
      toString in class Object
      Returns:
      the IDStr

    • toOptionList

      public static 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 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

    • getRevision

      public String getRevision()
      Returns the revision string.
      Specified by:
      getRevision in interface RevisionHandler
      Returns:
      the revision