Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.pjsofts.eurobudget.report
Class ReportGroup  view ReportGroup download ReportGroup.java

java.lang.Object
  extended bycom.pjsofts.eurobudget.report.ReportGroup

public class ReportGroup
extends java.lang.Object

A group in report. Sort of tree of ReportGroup (node) or ReportItem (leaf) It is a label and a sum (total) plus a list of ReportItems. Gives also an hint on how to get a graphical representation of it. A Group of depth 1 is a simple list of value. A Group of depth 2 could be seen as an array[series][categories]; Groups with higher depths are not yet managed.


Field Summary
private  int depth
          Depth = depth of the tree of report, maximum number of report group under this group depth = 0; means only report items in this group depth = 1; means it contains at least one group of depth 0; depth = n+1; means it contains at least one group of depth n;
private static java.util.ResourceBundle i8n
           
private  int kind
          high purpose of this report, may define how to use report data and how to display it
private  java.lang.String label
          label
private  java.util.List list
          All items included in this group, ReportItems or ReportGroups instances
private  int maxChildrenSize
          maximum number of items in groups included in this one if the group is seen as a two dimension array [] [] , meaning items of included groups are all the same set of labels (name of series) rows will be group-items of this group (categories) and columns will be items of those included groups (series)
private  java.lang.Number pct
          Pourcentage for this group sum, if it is included in another group Number between 0 and 1
private  int shapeHint
          hint on how to make a graphical representation of this group of data a ReportGroup can't be displayed by all kind of graphics, instead each report group has only a limited set of possible displayed, that could be known only by the creator of the report group.
private  java.lang.Double sum
          totals of all items values included in this group
 
Constructor Summary
ReportGroup(java.lang.String label, java.util.List list, java.lang.Number value)
          convenient constructor, defaut shape and kind to not defined
ReportGroup(java.lang.String label, java.util.List list, java.lang.Number value, int shape, int kind)
          Creates a new instance of ReportGroup
 
Method Summary
 int computeDepth()
           
 int computeMaxLength()
           
 int getDepth()
           
 int getKind()
          Getter for property kind.
 java.lang.String getLabel()
           
 java.util.List getList()
          of ReportItem or ReportGroup
 int getMaxChildrenSize()
           
 java.lang.Number getPct()
          Getter for property pct.
 int getShapeHint()
          Getter for property shapeHint.
 java.lang.Number getSum()
           
 void setKind(int kind)
          Setter for property kind.
 void setLabel(java.lang.String label)
          Setter for property label.
 void setPct(java.lang.Number pct)
           
 void setShapeHint(int shapeHint)
          Setter for property shapeHint.
 java.lang.String toXMLString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

i8n

private static final java.util.ResourceBundle i8n

depth

private int depth
Depth = depth of the tree of report, maximum number of report group under this group depth = 0; means only report items in this group depth = 1; means it contains at least one group of depth 0; depth = n+1; means it contains at least one group of depth n;


maxChildrenSize

private int maxChildrenSize
maximum number of items in groups included in this one if the group is seen as a two dimension array [] [] , meaning items of included groups are all the same set of labels (name of series) rows will be group-items of this group (categories) and columns will be items of those included groups (series)


label

private java.lang.String label
label


pct

private java.lang.Number pct
Pourcentage for this group sum, if it is included in another group Number between 0 and 1


list

private java.util.List list
All items included in this group, ReportItems or ReportGroups instances


sum

private java.lang.Double sum
totals of all items values included in this group


shapeHint

private int shapeHint
hint on how to make a graphical representation of this group of data a ReportGroup can't be displayed by all kind of graphics, instead each report group has only a limited set of possible displayed, that could be known only by the creator of the report group. (even if we could have an auto shape from data, it couldn't guess all choice, like between a pie and a bar chart).


kind

private int kind
high purpose of this report, may define how to use report data and how to display it

Constructor Detail

ReportGroup

public ReportGroup(java.lang.String label,
                   java.util.List list,
                   java.lang.Number value,
                   int shape,
                   int kind)
Creates a new instance of ReportGroup


ReportGroup

public ReportGroup(java.lang.String label,
                   java.util.List list,
                   java.lang.Number value)
convenient constructor, defaut shape and kind to not defined

Method Detail

getLabel

public java.lang.String getLabel()

getList

public java.util.List getList()
of ReportItem or ReportGroup


getSum

public java.lang.Number getSum()

getDepth

public int getDepth()

getMaxChildrenSize

public int getMaxChildrenSize()

setPct

public void setPct(java.lang.Number pct)

getPct

public java.lang.Number getPct()
Getter for property pct.


toXMLString

public java.lang.String toXMLString()

computeDepth

public int computeDepth()

computeMaxLength

public int computeMaxLength()

setLabel

public void setLabel(java.lang.String label)
Setter for property label.


getShapeHint

public int getShapeHint()
Getter for property shapeHint.


setShapeHint

public void setShapeHint(int shapeHint)
Setter for property shapeHint.


getKind

public int getKind()
Getter for property kind.


setKind

public void setKind(int kind)
Setter for property kind.