org.compiere.report.core
Class RModel

java.lang.Object
  org.compiere.report.core.RModel

All Implemented Interfaces:

Serializable

public class RModel
extends Object
implements Serializable

Report Model. Data is maintained in RModelData

Version:

$Id: RModel.java,v 1.2 2006/07/30 00:51:06 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

static String	FUNCTION_COUNT Function: Count
static String	FUNCTION_SUM Function: Sum
static String	TABLE_ALIAS Table Alias for SQL

Constructor Summary

RModel(String TableName)
Constructor.

Method Summary

void	addColumn(RColumn rc) Add Column
void	addColumn(RColumn rc, int index) Add Column at Index
void	addRow() Add Row
void	addRow(ArrayList<Object> l) Add Row
void	addRow(ArrayList<Object> l, int index) Add Row at Index
void	addRow(int index) Add Row at Index
Class<?>	getColumnClass(int col) Get Column Class
int	getColumnCount() Get total number of columns
int	getColumnIndex(String columnName) Find index for ColumnName
String	getColumnName(int col) Get Column Display Name
RColumn	getRColumn(int col) Get Column Display Name
int	getRowCount() Return Total mumber of rows
String	getTableName()
Object	getValueAt(int row, int col) Get Value At
boolean	isCellEditable(int rowIndex, int columnIndex) Is Cell Editable
boolean	isGroupRow(int row) Is Row a Group Row
void	moveRow(int from, int to) Move Row
void	query(Ctx ctx, String whereClause, String orderClause) Query
void	setFunction(int col, String function) Set Group Function - for the column, set a function like FUNCTION_SUM, FUNCTION_COUNT, ...
void	setFunction(String columnName, String function) Set Group Function
void	setGroup(int col) Set a group column - if the group value changes, a new row in inserted performing the calculations set in setGroupFunction().
void	setGroup(String columnName) Set a group column
void	setValueAt(Object aValue, int row, int col) Set Value At
void	sort(boolean asc, int sortCol)

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_ALIAS

public static final String TABLE_ALIAS

Table Alias for SQL

See Also:

Constant Field Values

FUNCTION_COUNT

public static final String FUNCTION_COUNT

Function: Count

See Also:

Constant Field Values

FUNCTION_SUM

public static final String FUNCTION_SUM

Function: Sum

See Also:

Constant Field Values

Constructor Detail

RModel

public RModel(String TableName)

Constructor. Creates RModelData

Parameters:

TableName -

Method Detail

getRColumn

public RColumn getRColumn(int col)

Get Column Display Name

Parameters:

col -

Returns:

RColumn

addColumn

public void addColumn(RColumn rc)

Add Column

Parameters:

rc -

addColumn

public void addColumn(RColumn rc,
                      int index)

Add Column at Index

Parameters:

rc -

index -

addRow

public void addRow()

Add Row

addRow

public void addRow(int index)

Add Row at Index

Parameters:

index -

addRow

public void addRow(ArrayList<Object> l)

Add Row

Parameters:

l -

addRow

public void addRow(ArrayList<Object> l,
                   int index)

Add Row at Index

Parameters:

l -

index -

getColumnIndex

public int getColumnIndex(String columnName)

Find index for ColumnName

Parameters:

columnName -

Returns:

index or -1 if not found

query

public void query(Ctx ctx,
                  String whereClause,
                  String orderClause)

Query

Parameters:

ctx -

whereClause -

orderClause -

setGroup

public void setGroup(String columnName)

Set a group column

Parameters:

columnName -

setGroup

public void setGroup(int col)

Set a group column - if the group value changes, a new row in inserted performing the calculations set in setGroupFunction(). If you set multiple groups, start with the highest level (e.g. Country, Region, City) The data is assumed to be sorted to result in meaningful groups.

  A AA 1
  A AB 2
  B BA 3
  B BB 4
  after setGroup (0)
  A AA 1
  A AB 2
  A
  B BA 3
  B BB 4
  B
  

Parameters:

col - The Group BY Column

isGroupRow

public boolean isGroupRow(int row)

Is Row a Group Row

Parameters:

row - index

Returns:

true if row is a group row

setFunction

public void setFunction(String columnName,
                        String function)

Set Group Function

Parameters:

columnName -

function -

setFunction

public void setFunction(int col,
                        String function)

Set Group Function - for the column, set a function like FUNCTION_SUM, FUNCTION_COUNT, ...

Parameters:

col - The column on which the function is performed

function - The function

getRowCount

public int getRowCount()

Return Total mumber of rows

Returns:

row count

getColumnCount

public int getColumnCount()

Get total number of columns

Returns:

column count

getColumnName

public String getColumnName(int col)

Get Column Display Name

Parameters:

col - index

Returns:

ColumnName

getColumnClass

public Class<?> getColumnClass(int col)

Get Column Class

Parameters:

col - index

Returns:

Column Class

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Is Cell Editable

Parameters:

rowIndex -

columnIndex -

Returns:

true, if editable

getValueAt

public Object getValueAt(int row,
                         int col)

Get Value At

Parameters:

row -

col -

Returns:

value

sort

public void sort(boolean asc,
                 int sortCol)

setValueAt

public void setValueAt(Object aValue,
                       int row,
                       int col)

Set Value At

Parameters:

aValue -

row -

col -

Throws:

IllegalArgumentException - if row/column is invalid or cell is read only

moveRow

public void moveRow(int from,
                    int to)

Move Row

Parameters:

from - index

to - index

getTableName

public String getTableName()