org.opennms.web.category
Class CategoryUtil

java.lang.Object
  org.opennms.web.category.CategoryUtil

public class CategoryUtil
extends Object

Provides look and feel utilities for the JSPs presenting category (real time console) information.

Version:

$Id: $

Author:

Lawrence Karnowski , OpenNMS , Lawrence Karnowski , OpenNMS

Field Summary

static DecimalFormat

valueFormat Specifies how the category values should look.

Method Summary

static String	formatValue(double value) Format an RTC value the way we want it.
static String	getCategoryClass(Category category) Determine the CSS class to use for a given category value and thresholds.
static String	getCategoryClass(Category category, double value) Determine the CSS color to use for a given value and the given category's thresholds.
static String	getCategoryClass(double normal, double warning, double value) Determine the CSS class to use for a given value and thresholds.
static String	getCategoryColor(Category category) Determine the color to use for a given category value and thresholds.
static String	getCategoryColor(Category category, double value) Determine the color to use for a given value and the given category's thresholds.
static String	getCategoryColor(double normal, double warning, double value) Determine the color to use for a given value and thresholds.

Methods inherited from class java.lang.Object

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

Field Detail

valueFormat

public static final DecimalFormat valueFormat

Specifies how the category values should look.

Note this value is currently public, but consider this temporary. To hide the implementation (so we can change it later), please call formatValueinstead.

Method Detail

formatValue

public static String formatValue(double value)

Format an RTC value the way we want it.

Parameters:

value - a double.

Returns:

a String object.

getCategoryColor

public static String getCategoryColor(Category category)
                               throws IOException,
                                      org.exolab.castor.xml.MarshalException,
                                      org.exolab.castor.xml.ValidationException

Determine the color to use for a given category value and thresholds.

Parameters:

category - a Category object.

Returns:

a String object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getCategoryClass

public static String getCategoryClass(Category category)
                               throws IOException,
                                      org.exolab.castor.xml.MarshalException,
                                      org.exolab.castor.xml.ValidationException

Determine the CSS class to use for a given category value and thresholds.

Parameters:

category - a Category object.

Returns:

a String object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getCategoryColor

public static String getCategoryColor(Category category,
                                      double value)
                               throws IOException,
                                      org.exolab.castor.xml.MarshalException,
                                      org.exolab.castor.xml.ValidationException

Determine the color to use for a given value and the given category's thresholds.

Parameters:

category - a Category object.

value - a double.

Returns:

a String object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getCategoryClass

public static String getCategoryClass(Category category,
                                      double value)
                               throws IOException,
                                      org.exolab.castor.xml.MarshalException,
                                      org.exolab.castor.xml.ValidationException

Determine the CSS color to use for a given value and the given category's thresholds.

Parameters:

category - a Category object.

value - a double.

Returns:

a String object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getCategoryColor

public static String getCategoryColor(double normal,
                                      double warning,
                                      double value)
                               throws IOException,
                                      org.exolab.castor.xml.MarshalException,
                                      org.exolab.castor.xml.ValidationException

Determine the color to use for a given value and thresholds.

Parameters:

normal - a double.

warning - a double.

value - a double.

Returns:

a String object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getCategoryClass

public static String getCategoryClass(double normal,
                                      double warning,
                                      double value)

Determine the CSS class to use for a given value and thresholds.

Parameters:

normal - a double.

warning - a double.

value - a double.

Returns:

a String object.