org.openlowcode.server.data.helpers

Class ReportTree<E extends DataObject<E>>

java.lang.Object

org.openlowcode.server.data.helpers.ReportTree<E>

Type Parameters:

E - class of the report object

public class ReportTree<E extends DataObject<E>>
extends java.lang.Object

This class manages report trees,especially:

• ensures that intermediate versions of the tree sum-up the leaves
• create missing leaves if needed

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReportTree.Consolidator<E extends DataObject<E>> function to consolidate data from the child to the parent of the report node
static interface	ReportTree.Enricher<E extends DataObject<E>>
static interface	ReportTree.Initiator<E extends DataObject<E>> feature to initiate a new report object
static interface	ReportTree.Namesetter<E extends DataObject<E>> function to set the name on the report object
static interface	ReportTree.ValueExtractor<E extends DataObject<E>,F> Extracts a value from the report object
static interface	ReportTree.ValueSetter<E extends DataObject<E>,F> a function to set a value to the report object

Constructor Summary

Constructors

Constructor and Description
ReportTree(DataObjectDefinition<E> objectdefinition, ReportTree.Namesetter<E> namesetter, ReportTree.ValueExtractor<E,java.lang.String> nameextractor, ReportTree.Consolidator<E>[] consolidators, ReportTree.Initiator<E> initiator, java.lang.String rootname) creates a new report tree
ReportTree(DataObjectDefinition<E> objectdefinition, ReportTree.Namesetter<E> namesetter, ReportTree.ValueExtractor<E,java.lang.String> nameextractor, ReportTree.Consolidator<E>[] consolidators, java.lang.String rootname) creates a new report tree
ReportTree(DataObjectDefinition<E> objectdefinition, ReportTree.Namesetter<E> namesetter, ReportTree.ValueExtractor<E,java.lang.String> nameextractor, ReportTree.Consolidator<E> uniqueconsolidator, ReportTree.Initiator<E> initiator, java.lang.String rootname) creates a new report tree
ReportTree(DataObjectDefinition<E> objectdefinition, ReportTree.Namesetter<E> namesetter, ReportTree.ValueExtractor<E,java.lang.String> nameextractor, ReportTree.Consolidator<E> uniqueconsolidator, java.lang.String rootname) creates a new report tree

Method Summary

Modifier and Type	Method and Description
void	addNode(java.lang.String[] parentlabels, E node) This method will add the given object as a node if it has a label.
static java.math.BigDecimal	divideIfNotNull(java.math.BigDecimal first, java.math.BigDecimal second) a robust division utility (manages null the way it is expected in a spreadsheet)
NodeTree<E>	generateNodeTree(DataObjectDefinition<E> objectdefinition)
static java.math.BigDecimal	multiplyIfNotNull(java.math.BigDecimal first, java.math.BigDecimal second) a robust product utility (manages null the way it is expected in a spreadsheet)
static java.lang.String	printBigDecimal(java.math.BigDecimal decimal) default print of a big decimal
static java.lang.String	printBigDecimal(java.math.BigDecimal decimal, int scale) prints the big decimal wih the given scale
static java.lang.String	printBigDecimal(java.math.BigDecimal decimal, int scale, java.lang.String displayifnull) prints a big decimal with the given scale (rounding half-down)
static java.lang.String	printBigDecimal(java.math.BigDecimal decimal, java.lang.String displayifnull) prints a big decimal
static java.math.BigDecimal	sumIfNotNull(java.math.BigDecimal first, java.math.BigDecimal second) a robust sum utility (manages null the way it is expected in a spreadsheet)
static <E extends DataObject<E>> void	sumInparent(E parent, java.math.BigDecimal childvalue, ReportTree.ValueExtractor<E,java.math.BigDecimal> extractor, ReportTree.ValueSetter<E,java.math.BigDecimal> setter) sums a hard coded value into the parent
static <E extends DataObject<E>> void	sumInparent(E parent, E child, ReportTree.ValueExtractor<E,java.math.BigDecimal> extractor, ReportTree.ValueSetter<E,java.math.BigDecimal> setter) Sums a valuein parent

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportTree

public ReportTree(DataObjectDefinition<E> objectdefinition,
                  ReportTree.Namesetter<E> namesetter,
                  ReportTree.ValueExtractor<E,java.lang.String> nameextractor,
                  ReportTree.Consolidator<E>[] consolidators,
                  ReportTree.Initiator<E> initiator,
                  java.lang.String rootname)

creates a new report tree

Parameters:

objectdefinition - definition of the object in the report tree

namesetter - utility to set name on object

nameextractor - utility to get name on object

consolidator - list of data consolidators

initiator - initiator to set the root node

rootname - root node name

ReportTree

public ReportTree(DataObjectDefinition<E> objectdefinition,
                  ReportTree.Namesetter<E> namesetter,
                  ReportTree.ValueExtractor<E,java.lang.String> nameextractor,
                  ReportTree.Consolidator<E>[] consolidators,
                  java.lang.String rootname)

creates a new report tree

Parameters:

objectdefinition - definition of the object in the report tree

namesetter - utility to set name on object

consolidator - data consolidators

rootname - root node name

ReportTree

public ReportTree(DataObjectDefinition<E> objectdefinition,
                  ReportTree.Namesetter<E> namesetter,
                  ReportTree.ValueExtractor<E,java.lang.String> nameextractor,
                  ReportTree.Consolidator<E> uniqueconsolidator,
                  ReportTree.Initiator<E> initiator,
                  java.lang.String rootname)

creates a new report tree

Parameters:

objectdefinition - definition of the object in the report tree

namesetter - utility to set name on object

nameextractor - utility to get name on object

uniqueconsolidator - unique consolidator

initiator - initiator to set the root node

rootname - root node name

ReportTree

public ReportTree(DataObjectDefinition<E> objectdefinition,
                  ReportTree.Namesetter<E> namesetter,
                  ReportTree.ValueExtractor<E,java.lang.String> nameextractor,
                  ReportTree.Consolidator<E> uniqueconsolidator,
                  java.lang.String rootname)

creates a new report tree

Parameters:

objectdefinition - definition of the object in the report tree

namesetter - utility to set name on object

consolidator - data consolidators

rootname - root node name

Method Detail

sumIfNotNull

public static java.math.BigDecimal sumIfNotNull(java.math.BigDecimal first,
                                                java.math.BigDecimal second)

a robust sum utility (manages null the way it is expected in a spreadsheet)

Parameters:

first - first element

second - second element

Returns:

• the non null element if only one element is not null
• null if both elements are null
• the sum if both elements are not null

multiplyIfNotNull

public static java.math.BigDecimal multiplyIfNotNull(java.math.BigDecimal first,
                                                     java.math.BigDecimal second)

a robust product utility (manages null the way it is expected in a spreadsheet)

Parameters:

first - first element

second - second element

Returns:

• null if one element is null
• the product if both elements are not null

divideIfNotNull

public static java.math.BigDecimal divideIfNotNull(java.math.BigDecimal first,
                                                   java.math.BigDecimal second)

a robust division utility (manages null the way it is expected in a spreadsheet)

Parameters:

first - first element

second - second element

Returns:

• null if one element is null
• the division with rounding half_down if both elements are not null

printBigDecimal

public static java.lang.String printBigDecimal(java.math.BigDecimal decimal,
                                               java.lang.String displayifnull)

prints a big decimal

Parameters:

decimal - big decimal

displayifnull - what to show if Big Decimal is null

Returns:

a string with the representation of the big decimal

printBigDecimal

public static java.lang.String printBigDecimal(java.math.BigDecimal decimal)

default print of a big decimal

Parameters:

decimal - decimal

Returns:

print of a big decimal

printBigDecimal

public static java.lang.String printBigDecimal(java.math.BigDecimal decimal,
                                               int scale,
                                               java.lang.String displayifnull)

prints a big decimal with the given scale (rounding half-down)

Parameters:

decimal - big decimal

scale - scale

displayifnull - display for null

Returns:

string display of the big decimal

printBigDecimal

public static java.lang.String printBigDecimal(java.math.BigDecimal decimal,
                                               int scale)

prints the big decimal wih the given scale

Parameters:

decimal - decimal

scale - scale

Returns:

string representation

sumInparent

public static <E extends DataObject<E>> void sumInparent(E parent,
                                                         E child,
                                                         ReportTree.ValueExtractor<E,java.math.BigDecimal> extractor,
                                                         ReportTree.ValueSetter<E,java.math.BigDecimal> setter)

Sums a valuein parent

Parameters:

parent - parent element of the report tree

child - child element of the report tree

extractor - extractor of the value on the object

setter - setter of the value on the object

sumInparent

public static <E extends DataObject<E>> void sumInparent(E parent,
                                                         java.math.BigDecimal childvalue,
                                                         ReportTree.ValueExtractor<E,java.math.BigDecimal> extractor,
                                                         ReportTree.ValueSetter<E,java.math.BigDecimal> setter)

sums a hard coded value into the parent

Parameters:

parent - parent element

childvalue - child value to sum

extractor - extractor of the value on the object

setter - setter of the value on the object

addNode

public void addNode(java.lang.String[] parentlabels,
                    E node)

This method will add the given object as a node if it has a label. If it does not have a label, the value will be rolled-up into the parent of the last element of parent labels. This simplifies the algorithm for the smart reports

Parameters:

parentlabels - the parents, excluding root node

node - the node to add as child to the last parent in the parent labels array

generateNodeTree

public NodeTree<E> generateNodeTree(DataObjectDefinition<E> objectdefinition)

Parameters:

objectdefinition -

Returns: