weka.core
Class SingleIndex

java.lang.Object
  weka.core.SingleIndex

All Implemented Interfaces:

Serializable, CustomDisplayStringProvider, RevisionHandler

public class SingleIndex
extends Object
implements Serializable, RevisionHandler, CustomDisplayStringProvider

Class representing a single cardinal number. The number is set by a string representation such as:

first last 1 3

The number is internally converted from 1-based to 0-based (so methods that set or get numbers not in string format should use 0-based numbers).

Version:

$Revision: 8034 $

Author:

Eibe Frank (eibe@cs.waikato.ac.nz)

See Also:

Serialized Form

Constructor Summary

SingleIndex()
Default constructor.

SingleIndex(String index)
Constructor to set initial index.

Method Summary

int	getIndex() Gets the selected index.
String	getRevision() Returns the revision string.
String	getSingleIndex() Gets the string representing the selected range of values.
static String	indexToString(int index) Creates a string representation of the given index.
static void	main(String[] argv) Main method for testing this class.
void	setSingleIndex(String index) Sets the index from a string representation.
void	setUpper(int newUpper) Sets the value of "last".
String	toDisplay() Returns the custom display string.
String	toString() Constructs a representation of the current range.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleIndex

public SingleIndex()

Default constructor.

SingleIndex

public SingleIndex(String index)

Constructor to set initial index.

Parameters:

index - the initial index

Throws:

IllegalArgumentException - if the index is invalid

Method Detail

setUpper

public void setUpper(int newUpper)

Sets the value of "last".

Parameters:

newUpper - the value of "last"

getSingleIndex

public String getSingleIndex()

Gets the string representing the selected range of values.

Returns:

the range selection string

setSingleIndex

public void setSingleIndex(String index)

Sets the index from a string representation. Note that setUpper() must be called for the value to be actually set

Parameters:

index - the index set

Throws:

IllegalArgumentException - if the index was not well formed

toString

public String toString()

Constructs a representation of the current range. Being a string representation, the numbers are based from 1.

Overrides:

toString in class Object

Returns:

the string representation of the current range

getIndex

public int getIndex()

Gets the selected index.

Returns:

the selected index

Throws:

RuntimeException - if the upper limit of the index hasn't been defined

indexToString

public static String indexToString(int index)

Creates a string representation of the given index.

Parameters:

index - the index to turn into a string. Since the index will typically come from a program, indices are assumed from 0, and thus will have 1 added in the String representation.

Returns:

the string representation

getRevision

public String getRevision()

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Returns:

the revision

toDisplay

public String toDisplay()

Returns the custom display string.

Specified by:

toDisplay in interface CustomDisplayStringProvider

Returns:

the string

main

public static void main(String[] argv)

Main method for testing this class.

Parameters:

argv - one parameter: a test index specification