de.uplanet.lucy.server.auxiliaries
Class ChartHelper

java.lang.Object
  extended by de.uplanet.lucy.server.auxiliaries.ChartHelper

@VelocityCallable(value="instance")
public final class ChartHelper
extends java.lang.Object

Create charts from datasets.

Version:
$Revision: 70152 $
To Do:
Improve documentation.

Field Summary
static int DEFAULT_HEIGHT
           
static int DEFAULT_WIDTH
           
 
Constructor Summary
ChartHelper()
          Constructor for ChartHelper.
 
Method Summary
 java.lang.String getChart(java.lang.String p_strSessionId, java.lang.String p_strType, java.lang.String p_strDatasetId)
           
 java.lang.String getMapGuid()
           
 void reset()
           
 void setCategoryTitle(java.lang.String p_strCategoryTitle)
          Sets the category title.
 void setChartTitle(java.lang.String p_strChartTitle)
          Sets the chart title.
 void setColorKey(java.lang.String p_strColorKey)
           
 void setColorMap(java.util.Map<java.lang.Comparable<?>,java.lang.String> p_colorMap)
           
 void setCumulation(boolean p_bCommulate)
           
 void setData(IValueHolder<?> p_vhValue, IValueHolder<?> p_vhRow, IValueHolder<?> p_vhColumn)
           
 void setData(IValueHolder<?> p_vhValue, IValueHolder<?> p_vhRow, IValueHolder<?> p_vhColumn, IValueHolder<?> p_vhColor)
           
 void setLanguage(java.lang.String p_strLang)
           
 void setLegend(boolean p_bLegend)
           
 void setOneRow(boolean p_bOneRow)
           
 void setPieData(IValueHolder<?> p_vhValue, IValueHolder<?> p_vhRow)
           
 void setPieData(IValueHolder<?> p_vhValue, IValueHolder<?> p_vhRow, IValueHolder<?> p_vhColor)
           
 void setSortBy(java.lang.String p_strSortBy)
           
 void setSortOrder(java.lang.String p_strSortOrder)
           
 void setTickUnitColumn(java.lang.String p_strTickUnitColumn)
           
 void setTickUnitRow(java.lang.String p_strTickUnitRow)
           
 void setValueTitle(java.lang.String p_strValueTitle)
          Sets the value title.
 void setX(int p_iXDim)
           
 void setY(int p_iYDim)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH
See Also:
Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT
See Also:
Constant Field Values
Constructor Detail

ChartHelper

public ChartHelper()
Constructor for ChartHelper.

Method Detail

setCumulation

public void setCumulation(boolean p_bCommulate)

setOneRow

public void setOneRow(boolean p_bOneRow)

setData

public void setData(IValueHolder<?> p_vhValue,
                    IValueHolder<?> p_vhRow,
                    IValueHolder<?> p_vhColumn)

setData

public void setData(IValueHolder<?> p_vhValue,
                    IValueHolder<?> p_vhRow,
                    IValueHolder<?> p_vhColumn,
                    IValueHolder<?> p_vhColor)

setPieData

public void setPieData(IValueHolder<?> p_vhValue,
                       IValueHolder<?> p_vhRow)

setPieData

public void setPieData(IValueHolder<?> p_vhValue,
                       IValueHolder<?> p_vhRow,
                       IValueHolder<?> p_vhColor)

reset

public void reset()

getChart

public java.lang.String getChart(java.lang.String p_strSessionId,
                                 java.lang.String p_strType,
                                 java.lang.String p_strDatasetId)

setLegend

public void setLegend(boolean p_bLegend)
Parameters:
p_bLegend -

setTickUnitRow

public void setTickUnitRow(java.lang.String p_strTickUnitRow)
Parameters:
p_strTickUnitRow -

setTickUnitColumn

public void setTickUnitColumn(java.lang.String p_strTickUnitColumn)
Parameters:
p_strTickUnitColumn -

setLanguage

public void setLanguage(java.lang.String p_strLang)
Parameters:
p_strLang -

setSortBy

public void setSortBy(java.lang.String p_strSortBy)
Parameters:
p_strSortBy -

setSortOrder

public void setSortOrder(java.lang.String p_strSortOrder)
Parameters:
p_strSortOrder -

setCategoryTitle

public void setCategoryTitle(java.lang.String p_strCategoryTitle)
Sets the category title.

Parameters:
p_strCategoryTitle - The m_strCategoryTitle to set

setChartTitle

public void setChartTitle(java.lang.String p_strChartTitle)
Sets the chart title.

Parameters:
p_strChartTitle - The chart title.

setValueTitle

public void setValueTitle(java.lang.String p_strValueTitle)
Sets the value title.

Parameters:
p_strValueTitle - The value title.

setX

public void setX(int p_iXDim)

setY

public void setY(int p_iYDim)

getMapGuid

public java.lang.String getMapGuid()

setColorKey

public void setColorKey(java.lang.String p_strColorKey)
Parameters:
p_strColorKey - One of APP_XML_VALUE.COLOR_KEY_NONE, APP_XML_VALUE.COLOR_KEY_ROWINDEX, APP_XML_VALUE.COLOR_KEY_ROWKEY.

setColorMap

public void setColorMap(java.util.Map<java.lang.Comparable<?>,java.lang.String> p_colorMap)
Parameters:
p_colorMap - The row colors.


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.