gov.nasa.gsfc.spdf.ssc
Class GraphLabelOptions

java.lang.Object
  gov.nasa.gsfc.spdf.ssc.GraphLabelOptions

public class GraphLabelOptions
extends java.lang.Object

This class represents custom label options for an SSC graph request.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

GraphLabelOptions()
Constructs a GraphLabelOption object with a default value.

GraphLabelOptions(int dayOfYearLabelFrequency, boolean monthDayOfMonthLabel, int hourLabelFrequency, int hourTickMarkFrequency, int minuteLabelFrequency, int minuteTickMarkFrequency)
Constructs a GraphLabelOption object with the given attribute values.

Method Summary

int	getDayOfYearLabelFrequency() Gets the day-of-year label frequency value.
int	getHourLabelFrequency() Gets the hour label frequency value.
int	getHourTickMarkFrequency() Gets the hour tick mark frequency value.
int	getMinuteLabelFrequency() Gets the minute label frequency value.
int	getMinuteTickMarkFrequency() Gets the minute tick mark frequency value.
boolean	isMonthDayOfMonthLabel() Gets the month/day-of-month label value.
void	list(java.io.PrintStream out) Prints this object's value to the specified output stream.
void	setDayOfYearLabelFrequency(int value) Sets the day-of-year label frequency value.
void	setHourLabelFrequency(int value) Sets the hour label frequency value.
void	setHourTickMarkFrequency(int value) Sets the hour tick mark frequency value.
void	setMinuteLabelFrequency(int value) Sets the minute label frequency value.
void	setMinuteTickMarkFrequency(int value) Sets the minute tick mark frequecy value.
void	setMonthDayOfMonthLabel(boolean value) Sets the month/day-of-month label value.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphLabelOptions

public GraphLabelOptions()

Constructs a GraphLabelOption object with a default value. This default specifies the following:

• label day of year tick marks every 1 day
• label day of year tick marks as day-of-year
• label hour tick marks every 12 hours
• hour tick marks every 6 hours
• do not label minute tick marks
• do not display minute tick marks

.

GraphLabelOptions

public GraphLabelOptions(int dayOfYearLabelFrequency,
                         boolean monthDayOfMonthLabel,
                         int hourLabelFrequency,
                         int hourTickMarkFrequency,
                         int minuteLabelFrequency,
                         int minuteTickMarkFrequency)

Constructs a GraphLabelOption object with the given attribute values.

Parameters:

dayOfYearLabelFrequency - frequency of day-of-year labels

monthDayOfMonthLabel - specifies format of day-of-year labels

hourLabelFrequency - frequency of hour labels

hourTickMarkFrequency - frequency of hour tick marks

minuteLabelFrequency - frequency of minute labels

minuteTickMarkFrequency - frequency of minute tick marks

Method Detail

getDayOfYearLabelFrequency

public int getDayOfYearLabelFrequency()

Gets the day-of-year label frequency value.

Returns:

day-of-year label frequency value

See Also:

setDayOfYearLabelFrequency(int)

setDayOfYearLabelFrequency

public void setDayOfYearLabelFrequency(int value)

Sets the day-of-year label frequency value.

Parameters:

value - new day-of-year label frequency value. A zero value specifies that the day-of-year label should not be displayed.

See Also:

getDayOfYearLabelFrequency()

isMonthDayOfMonthLabel

public boolean isMonthDayOfMonthLabel()

Gets the month/day-of-month label value.

Returns:

month/day-of-month label value

See Also:

setMonthDayOfMonthLabel(boolean)

setMonthDayOfMonthLabel

public void setMonthDayOfMonthLabel(boolean value)

Sets the month/day-of-month label value.

Parameters:

value - new month/day-of-month label value. A false value specifies that the label is to have a day-of-year value.

See Also:

isMonthDayOfMonthLabel()

getHourLabelFrequency

public int getHourLabelFrequency()

Gets the hour label frequency value.

Returns:

hour label frequency value

See Also:

setHourLabelFrequency(int)

setHourLabelFrequency

public void setHourLabelFrequency(int value)

Sets the hour label frequency value.

Parameters:

value - new hour label frequency value. A null or zero value specifies that the hour labels should not be displayed.

See Also:

getHourLabelFrequency()

getHourTickMarkFrequency

public int getHourTickMarkFrequency()

Gets the hour tick mark frequency value.

Returns:

hour tick mark frequency value

See Also:

setHourTickMarkFrequency(int)

setHourTickMarkFrequency

public void setHourTickMarkFrequency(int value)

Sets the hour tick mark frequency value.

Parameters:

value - new hour tick mark frequency value. A null or zero value specifies that the hour tick marks should not be displayed.

See Also:

getHourTickMarkFrequency()

getMinuteLabelFrequency

public int getMinuteLabelFrequency()

Gets the minute label frequency value.

Returns:

minute label frequency value

See Also:

setMinuteLabelFrequency(int)

setMinuteLabelFrequency

public void setMinuteLabelFrequency(int value)

Sets the minute label frequency value.

Parameters:

value - new minute label frequency value. A null or zero value specifies that the minute label should not be displayed.

See Also:

getMinuteLabelFrequency()

getMinuteTickMarkFrequency

public int getMinuteTickMarkFrequency()

Gets the minute tick mark frequency value.

Returns:

minute tick mark frequency value

See Also:

setMinuteTickMarkFrequency(int)

setMinuteTickMarkFrequency

public void setMinuteTickMarkFrequency(int value)

Sets the minute tick mark frequecy value.

Parameters:

value - new minute tick mark frequency value. A null or zero value specifies that minute tick marks should not be displayed.

See Also:

getMinuteTickMarkFrequency()

list

public void list(java.io.PrintStream out)

Prints this object's value to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream