jdbreport.design.model
Interface CellObject

All Superinterfaces:
Cell, Cloneable, Serializable
All Known Implementing Classes:
NullCellObject, TemplateReportCell

public interface CellObject
extends Cell

Interface for cell in TemplateReport

Version:
2.0 30.01.2012
Author:
Andrey Kholmanskih

Nested Class Summary
 
Nested classes/interfaces inherited from interface jdbreport.model.Cell
Cell.Type
 
Field Summary
static int AF_AVG
          Total function Avg
static int AF_MAX
          Total function Max
static int AF_MIN
          Total function Min
static int AF_NONE
          No total function
static int AF_SUM
          Total function Sum
static String[] AGR_FUNC_NAME
          Text representation total functions
static int TYPE_FIELD
           
static int TYPE_NONE
           
static int TYPE_VAR
           
 
Fields inherited from interface jdbreport.model.Cell
EMPTY_STRING, serialVersionUID, TEXT_HTML, TEXT_PLAIN
 
Method Summary
 Object clone()
           
 Cell createCellItem()
          Creates the Cell object and copies its properties there
 String getDataSetId()
           
 String[] getDataSetIds()
          A list of DataSet aliases contained in the cell
 Expression[] getExpressions()
          A list of expressions contained in cells
 String getFieldName()
           
 String[] getFieldNames(String dsId)
          A list of field items contained in the cell for DataSet named dsId
 String getFunctionName()
          Name of the CellFunction object
 int getTotalFunction()
           
 int getType()
           
 boolean isNotRepeate()
           
 boolean isOldEquals(Object value)
          Compares the meaning of the new generated cell with saved meaning
 boolean isReplacement()
           
 void setDataSetId(String dataSetId)
           
 void setExpressions(Expression[] expr)
           
 void setFieldName(String name)
           
 void setFunctionName(String functionName)
          Sets the name of the CellFunction object
 void setNotRepeate(boolean notRepeate)
           
 void setOldValue(Object oldValue)
          Remembers the current meaning of the generated cell
 void setReplacement(boolean b)
          Sets the sign of the replacement value of the cell
 void setTotalFunction(int func)
           
 void setType(int type)
           
 
Methods inherited from interface jdbreport.model.Cell
clear, getColSpan, getContentType, getExtFlags, getIcon, getImageFormat, getOwner, getPicture, getRowSpan, getStyleId, getText, getValue, getValueType, isChild, isEditable, isNotPrint, isNull, isScaleIcon, isSpan, setColSpan, setEditable, setExtFlags, setIcon, setImage, setImageFormat, setNotPrint, setOwner, setPicture, setRowSpan, setScaleIcon, setStyleId, setValue, setValueType
 

Field Detail

TYPE_NONE

static final int TYPE_NONE
See Also:
Constant Field Values

TYPE_VAR

static final int TYPE_VAR
See Also:
Constant Field Values

TYPE_FIELD

static final int TYPE_FIELD
See Also:
Constant Field Values

AF_NONE

static final int AF_NONE
No total function

See Also:
Constant Field Values

AF_SUM

static final int AF_SUM
Total function Sum

See Also:
Constant Field Values

AF_MAX

static final int AF_MAX
Total function Max

See Also:
Constant Field Values

AF_MIN

static final int AF_MIN
Total function Min

See Also:
Constant Field Values

AF_AVG

static final int AF_AVG
Total function Avg

See Also:
Constant Field Values

AGR_FUNC_NAME

static final String[] AGR_FUNC_NAME
Text representation total functions

Method Detail

getFieldName

String getFieldName()
Returns:
the field's name

setFieldName

void setFieldName(String name)
Parameters:
name - the field's name

getDataSetId

String getDataSetId()
Returns:
the DataSet's alias

setDataSetId

void setDataSetId(String dataSetId)
Parameters:
dataSetId - the DataSet's alias

getType

int getType()
Returns:
Data type (TYPE_VAR, TYPE_FIELD or TYPE_NONE)

setType

void setType(int type)
Parameters:
type - Data type (TYPE_VAR, TYPE_FIELD or TYPE_NONE)

isNotRepeate

boolean isNotRepeate()
Returns:
Not repeated value for column

setNotRepeate

void setNotRepeate(boolean notRepeate)
Parameters:
notRepeate - not repeated value for column

clone

Object clone()
Specified by:
clone in interface Cell

createCellItem

Cell createCellItem()
Creates the Cell object and copies its properties there

Returns:
the Cell object

getFunctionName

String getFunctionName()
Name of the CellFunction object

Returns:
name of the CellFunction object

setFunctionName

void setFunctionName(String functionName)
Sets the name of the CellFunction object

Parameters:
functionName - name of the CellFunction object

getTotalFunction

int getTotalFunction()
Returns:
the total function: Sum, Max, Min or Avg

setTotalFunction

void setTotalFunction(int func)
Parameters:
func - the total function: Sum, Max, Min or Avg

setOldValue

void setOldValue(Object oldValue)
Remembers the current meaning of the generated cell

Parameters:
oldValue - the current meaning

isOldEquals

boolean isOldEquals(Object value)
Compares the meaning of the new generated cell with saved meaning

Parameters:
value - the new meaning
Returns:
true if equal

getExpressions

Expression[] getExpressions()
A list of expressions contained in cells

Returns:
a list of expressions contained in cells

setExpressions

void setExpressions(Expression[] expr)
Parameters:
expr - a list of expressions

getDataSetIds

String[] getDataSetIds()
A list of DataSet aliases contained in the cell

Returns:
the aliases of DataSet

getFieldNames

String[] getFieldNames(String dsId)
A list of field items contained in the cell for DataSet named dsId

Parameters:
dsId - the dataset's alias
Returns:
a list of field items

isReplacement

boolean isReplacement()
Returns:
true if the cell is set to change
Since:
2.0

setReplacement

void setReplacement(boolean b)
Sets the sign of the replacement value of the cell

Parameters:
b - sign of the replacement
Since:
2.0