com.actuate.activeportal.beans
Class SummaryBean

java.lang.Object
  extended by com.actuate.activeportal.beans.SummaryBean
All Implemented Interfaces:
java.io.Serializable

public class SummaryBean
extends java.lang.Object
implements java.io.Serializable

This bean represents each summary item that is displayed in the summary tab of the information objects module.

Author:
Actuate Corporation
See Also:
Serialized Form

Constructor Summary
SummaryBean()
           
 
Method Summary
 java.lang.String getColumnName()
          Returns the column name
 java.lang.String getDataType()
          Returns the data type of this column.
 java.lang.String getDisplayName()
          Returns the display name if available or the column name
 java.lang.String getFunction()
          Returns the current summary function that has been set for this column The following are the different functions currently available Sum Avg Min Max
 int getState()
          This is used internally while updating the bean.
 boolean isActive()
          This method returns a boolean indicating whether this is currently active or not It is set to false when the corresponding column is added as a group and vice versa.
 void setActive(boolean b)
          Sets whether this column is active currently
 void setColumnName(java.lang.String string)
          Sets the column name
 void setDataType(java.lang.String string)
          Set the data type of this column.
 void setDisplayName(java.lang.String string)
          Sets the display name
 void setFunction(java.lang.String string)
          Sets the function i.e.
 void setState(int i)
          This is used internally while updating the bean.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SummaryBean

public SummaryBean()
Method Detail

isActive

public boolean isActive()
This method returns a boolean indicating whether this is currently active or not It is set to false when the corresponding column is added as a group and vice versa. This is used to indicate whether this column can be used as a summary

Returns:
A boolean indicating the state

getColumnName

public java.lang.String getColumnName()
Returns the column name

Returns:
The column name

getDisplayName

public java.lang.String getDisplayName()
Returns the display name if available or the column name

Returns:
The display name

getFunction

public java.lang.String getFunction()
Returns the current summary function that has been set for this column The following are the different functions currently available

Returns:
The current summary function

setActive

public void setActive(boolean b)
Sets whether this column is active currently

Parameters:
b - A boolean indicating whether this column is active
See Also:
isActive()

setColumnName

public void setColumnName(java.lang.String string)
Sets the column name

Parameters:
string - The column name

setDisplayName

public void setDisplayName(java.lang.String string)
Sets the display name

Parameters:
string - The display name

setFunction

public void setFunction(java.lang.String string)
Sets the function i.e. Sum, Ave etc...

Parameters:
string - The function
See Also:
getFunction()

getState

public int getState()
This is used internally while updating the bean. This value should not be manipulated externally.

Returns:
the current state

setState

public void setState(int i)
This is used internally while updating the bean. This value should not be manipulated externally.

Parameters:
i -

getDataType

public java.lang.String getDataType()
Returns the data type of this column. The data type is a string representation of one of the values present in DataType

Returns:
A string representation of the datatype.

setDataType

public void setDataType(java.lang.String string)
Set the data type of this column.

Parameters:
string - The data type name of this column
See Also:
getDataType()