Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class ncsa.horizon.coordinates.formatters.
FreqAxisPosFormatter

java.lang.Object
  |
  +--ncsa.horizon.coordinates.formatters.GenericAxisPosFormatter
        |
        +--ncsa.horizon.coordinates.formatters.MetricAxisPosFormatter
              |
              +--ncsa.horizon.coordinates.formatters.FreqAxisPosFormatter

public class FreqAxisPosFormatter

extends MetricAxisPosFormatter

support for printing out frequencies (double values) as floating point numbers appended by a metric frequency unit.

See Also:

Serialized Form

Inner classes inherited from class ncsa.horizon.coordinates.formatters.GenericAxisPosFormatter

GenericAxisPosFormatter.Modes

Field Summary

static java.lang.String	freqAbbrev
static java.lang.String	freqUnit
static java.lang.String	myname

Fields inherited from class ncsa.horizon.coordinates.formatters.MetricAxisPosFormatter

abbmap, abbreviate, abbreviations, abbrevList, fixed, ipower, minpow, myname, opower, powerList, prefixes, prefixList, prefmap, unit

Fields inherited from class ncsa.horizon.coordinates.formatters.GenericAxisPosFormatter

fmt, myname

Constructor Summary

FreqAxisPosFormatter()
format frequency values with "Hz" as the unit assuming that the native unit of the values is Hertz.

FreqAxisPosFormatter(boolean useAbbreviation)
format frequency values assuming that the native unit of the values is Hertz.

FreqAxisPosFormatter(int inPower, boolean useAbbreviation)
format frequency values assuming that the native unit of the values is Hertz.

FreqAxisPosFormatter(int inPower, boolean useAbbreviation, int outPower)
format frequencies using the prefix for the specified power

Method Summary

void	initialize() loads the prefix and abbreviation lists
void	setAbbreviated(boolean useAbbreviation) set whether abbreviations are used

Methods inherited from class ncsa.horizon.coordinates.formatters.MetricAxisPosFormatter

AbbrevFor, clone, fixPrefix, fixPrefix, freePrefix, getDefPrefixPower, initialize, isAbbreviated, isFixed, main, maxPower, prefixFor, revmap, scaleValue, setAbbreviated, setMinPower, setUnit, setUnitPower, toString, toString, useAbbrev, usePrefix, valueOf

Methods inherited from class ncsa.horizon.coordinates.formatters.GenericAxisPosFormatter

clone, getFormat, getPrecision, main, setMode, setPrecision, toString, toString, toString, valueOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Field Detail

freqUnit

protected static java.lang.String freqUnit

freqAbbrev

protected static java.lang.String freqAbbrev

myname

protected static final java.lang.String myname

Constructor Detail

FreqAxisPosFormatter

public FreqAxisPosFormatter()

format frequency values with "Hz" as the unit assuming that the native unit of the values is Hertz.

FreqAxisPosFormatter

public FreqAxisPosFormatter(boolean useAbbreviation)

format frequency values assuming that the native unit of the values is Hertz.

Parameters:

useAbbreviation - if true, an abbreviation should be used.

FreqAxisPosFormatter

public FreqAxisPosFormatter(int inPower,
                            boolean useAbbreviation)

format frequency values assuming that the native unit of the values is Hertz.

Parameters:

inPower - assume that values input to toString(double) will be in units of 10^inPower, relative to unit

useAbbreviation - if true, an abbreviation should be used.

FreqAxisPosFormatter

public FreqAxisPosFormatter(int inPower,
                            boolean useAbbreviation,
                            int outPower)

format frequencies using the prefix for the specified power

Parameters:

inPower - assume that values input to toString(double) will be in units of 10^inPower, relative to unit

useAbbreviation - if true, the prefix abbreviation should be used.

outPower - the power for the prefix to be used; if a prefix for this power is not known, the highest valued prefix that is less than request will be used.

Method Detail

initialize

protected void initialize()

loads the prefix and abbreviation lists

Overrides:

initialize in class MetricAxisPosFormatter

setAbbreviated

public void setAbbreviated(boolean useAbbreviation)

set whether abbreviations are used

Overrides:

setAbbreviated in class MetricAxisPosFormatter