|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.pivot.impl.AbstractPivotModel
org.zkoss.pivot.impl.TabularPivotModel
public class TabularPivotModel
An implementation of PivotModel, which takes raw data in the form of a two dimensional list.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.zkoss.pivot.PivotModelExt |
---|
PivotModelExt.SortCtrl |
Field Summary | |
---|---|
protected static java.util.Comparator<PivotHeaderNode> |
NODE_COMPARATOR
|
Constructor Summary | |
---|---|
TabularPivotModel(java.lang.Iterable<? extends java.util.List<?>> data,
java.util.List<java.lang.String> columns)
Constructor |
Method Summary | |
---|---|
protected void |
addRawValues(PivotHeaderNode rowNode,
PivotHeaderNode colNode,
java.util.List<?> row,
TabularPivotField[] fields)
|
void |
clearAllFields(boolean complete)
Remove all pivot fields from column, row, and data. |
protected PivotHeaderTree[] |
createHeaderTrees()
Create column and row header trees. |
TabularPivotField[] |
getColumnFields()
|
PivotHeaderTree |
getColumnHeaderTree()
Return the header tree of columns. |
TabularPivotField[] |
getDataFields()
|
TabularPivotField |
getField(java.lang.String fieldName)
Returns the pivot field from the specified field name, if any. |
TabularPivotField[] |
getFields()
Return a list of all fields in the model. |
TabularPivotField[] |
getFields(PivotField.Type type)
Return a list of pivot fields of the given type. |
java.lang.Iterable<? extends java.util.List<?>> |
getRawData()
Return the raw data collection. |
java.util.List<java.lang.Object> |
getRawValues(PivotHeaderNode rowNode,
PivotHeaderNode colNode,
PivotField dataField)
Return raw values intersected by column and row nodes, even if they are not leaves |
TabularPivotField[] |
getRowFields()
|
PivotHeaderTree |
getRowHeaderTree()
Return the header tree of rows. |
int |
getSourceDataIndex(PivotField field)
Return the index of raw data columns the field corresponds to. |
java.lang.Number |
getValue(PivotHeaderNode rowNode,
int rowCalIndex,
PivotHeaderNode colNode,
int colCalIndex,
int dataIndex)
Get the calculated data summary at specific cell position. |
protected static java.util.List<java.lang.Object> |
getValues(TabularPivotField[] fields,
java.util.List<?> row)
|
void |
removeField(PivotField field)
Remove the field from column, row, or data. |
void |
removeField(java.lang.String fieldName)
Remove first field with given name from column, row, or data. |
void |
setFieldKeyComparator(PivotField field,
java.util.Comparator<java.lang.Object> comparator)
Set a comparator on a pivot field for node ordering |
void |
setFieldKeyComparator(java.lang.String fieldName,
java.util.Comparator<java.lang.Object> comparator)
Set a comparator on a pivot field for node ordering. |
void |
setFieldKeyOrder(PivotField field,
boolean ascending)
Set the node ordering of the field. |
void |
setFieldKeyOrder(java.lang.String fieldName,
boolean ascending)
Set the ordering of keys on a field. |
void |
setFieldType(PivotField field,
PivotField.Type type)
Change the type of a pivot field. |
void |
setFieldType(PivotField field,
PivotField.Type type,
int index)
Change the type of a pivot field and insert it at the given level (in case of COLUMN or ROW) or display position (in case of DATA). |
void |
setFieldType(java.lang.String fieldName,
PivotField.Type type)
Change the type of a pivot field. |
Methods inherited from class org.zkoss.pivot.impl.AbstractPivotModel |
---|
addPivotDataListener, fireEvent, removePivotDataListener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.zkoss.pivot.PivotModel |
---|
addPivotDataListener, removePivotDataListener |
Field Detail |
---|
protected static final java.util.Comparator<PivotHeaderNode> NODE_COMPARATOR
Constructor Detail |
---|
public TabularPivotModel(java.lang.Iterable<? extends java.util.List<?>> data, java.util.List<java.lang.String> columns)
data
- a matrix data <row<column<cell>>>columns
- a list of column fields according to the matrix data in order.Method Detail |
---|
public java.lang.Iterable<? extends java.util.List<?>> getRawData()
public void setFieldType(java.lang.String fieldName, PivotField.Type type)
fieldName
- name of the fieldPivotField.Type
public void setFieldType(PivotField field, PivotField.Type type, int index)
PivotModelExt
setFieldType
in interface PivotModelExt
index
- the tree level or display positionPivotField.Type
public void setFieldType(PivotField field, PivotField.Type type)
PivotModelExt
setFieldType
in interface PivotModelExt
PivotField.Type
public int getSourceDataIndex(PivotField field)
public final TabularPivotField[] getRowFields()
public final TabularPivotField[] getColumnFields()
public final TabularPivotField[] getDataFields()
public TabularPivotField[] getFields(PivotField.Type type)
PivotModel
getFields
in interface PivotModel
PivotField
,
PivotField.Type
public TabularPivotField[] getFields()
PivotModel
getFields
in interface PivotModel
public TabularPivotField getField(java.lang.String fieldName)
Note: it only returns the first one matching with the field name.
public void removeField(java.lang.String fieldName)
PivotField.Type
public void removeField(PivotField field)
PivotField.Type
public void clearAllFields(boolean complete)
complete
- true to additionally remove custom summary, subtotals
and group handlersPivotField.Type
public void setFieldKeyOrder(java.lang.String fieldName, boolean ascending)
public void setFieldKeyOrder(PivotField field, boolean ascending)
PivotModelExt.SortCtrl
setFieldKeyOrder
in interface PivotModelExt.SortCtrl
public void setFieldKeyComparator(java.lang.String fieldName, java.util.Comparator<java.lang.Object> comparator)
fieldName
- the field on which the comparator appliescomparator
- a comparator to sort field keyspublic void setFieldKeyComparator(PivotField field, java.util.Comparator<java.lang.Object> comparator)
PivotModelExt.SortCtrl
setFieldKeyComparator
in interface PivotModelExt.SortCtrl
comparator
- a comparator to sort field keysprotected PivotHeaderTree[] createHeaderTrees()
public java.lang.Number getValue(PivotHeaderNode rowNode, int rowCalIndex, PivotHeaderNode colNode, int colCalIndex, int dataIndex)
PivotModel
getValue
in interface PivotModel
rowNode
- row node, root node means grand totalrowCalIndex
- row subtotal calculator index, -1 if not subtotalcolNode
- column node, root node means grand totalcolCalIndex
- column subtotal calculator index, -1 if not subtotaldataIndex
- index of data fieldspublic java.util.List<java.lang.Object> getRawValues(PivotHeaderNode rowNode, PivotHeaderNode colNode, PivotField dataField)
public PivotHeaderTree getColumnHeaderTree()
PivotModel
getColumnHeaderTree
in interface PivotModel
PivotHeaderTree
public PivotHeaderTree getRowHeaderTree()
PivotModel
getRowHeaderTree
in interface PivotModel
PivotHeaderTree
protected final void addRawValues(PivotHeaderNode rowNode, PivotHeaderNode colNode, java.util.List<?> row, TabularPivotField[] fields)
protected static final java.util.List<java.lang.Object> getValues(TabularPivotField[] fields, java.util.List<?> row)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |