com.tensegrity.composite.coordinate.range
Interface CategoryRange

All Known Implementing Classes:

DefaultCategoryRange

public interface CategoryRange

A CategoryRange represents an interval within a CategoryScale. To get more informations on a CategoryScale please have a look at the documentation of the CategoryScale interface.

Since a CategoryRange is defined over an interval it needs a starting value and a ending value that defines the interval the CategoryRange represents. To handle these values the CategoryRange provides the methods listed below:

• getFrom() / setFrom(int)
• getTo() / setTo(int)

At the actual state of development a CategoryRange defines only the width for one step within the interval it represents. In order to work with the defined width the CategoryRange provides the following methods:

• getWidth() / setWidth(int)

Version:

$Id: CategoryRange.java,v 1.6 2005/04/01 15:45:16 MichaelKegel Exp $

Author:

MichaelRaue

Method Summary

CategoryRange	deepCopy() Deep copies the CategoryRange object.
int	getFrom() Returns the from.
int	getTo() Returns the to.
int	getWidth() Returns the width for each category of this range.
int	getWidthOverall() Return the overall-width of the categories of this range.
void	setFrom(int from) Sets the from.
void	setTo(int to) Sets the to.
void	setWidth(int width) Sets the width.

Method Detail

getFrom

public int getFrom()

Returns the from.

Returns:

int

setFrom

public void setFrom(int from)

Sets the from.

Parameters:

from - The from to set

getTo

public int getTo()

Returns the to.

Returns:

int

setTo

public void setTo(int to)

Sets the to.

Parameters:

to - The to to set

getWidth

public int getWidth()

Returns the width for each category of this range.

Returns:

int

getWidthOverall

public int getWidthOverall()

Return the overall-width of the categories of this range.

Returns:

the overall-width of the categories of this range.

setWidth

public void setWidth(int width)

Sets the width.

Parameters:

width - The width to set

deepCopy

public CategoryRange deepCopy()

Deep copies the CategoryRange object.

Returns:

a deep copied version of this CategoryRange-instance