XRadar File Structure

The XRadar defines the following base file structure: 


/                                         : Project root. Location of all basic ant files for running the framework.

/etc                                      : All standard or default configuration files for the XRadar.
      /config                             : Default configuration files.
      /data                               : Data such as metric descriptions and other data that is
                                            shown in the xradar.

/lib                                      : All library dependencies that are packaged in the XRadar

/src                                      : All executable source code for the XRadar
      /main
      	    /resources
                      /img                : All images shown on the XRadar. This package is probably a
                                            little misplaced. Should be under /etc instead.
      	    /java                         : All XRadar specific java source files. Is build into the
                                            xradar.jar found under lib.
            /stylesheets                  : All XRadar xslt stylesheets. See below for more on the content.

      /test
            /project
                     /testproject         : The XRadar testproject used to test the XRadar configuration
                                            as well as for regression testing the framework.

The XRadar structure under stylesheet are as follows: 

/radar                                    : The XRadar source. This is where the basic system resides.
      /api                                : api-generating templates. Used among others to generate the ide-api.
      /dynamics                           : Specific XRadar dynamics-report stylesheets.
            /process                      : Dynamics specific processing and merging stylesheets.
            /report                       : Dynamics report stylesheets.
      /graph                              : Common XRadar graph stylesheets.
      /process                            : Common XRadar process stylesheets.
      /statics                            : Specific XRadar statics-report stylesheets.
            /graph                        : Statics specific processing and merging stylesheets.
            /process                      : Statics specific processing and merging stylesheets.
            /report                       : Statics specific report stylesheets.

/system                                   : System specific configuration codeholdes in cases where one has
                                            extended the XRadar with specific reports for the system.
                                            The name of the sub-packages speaks for themselves.

/util                                     : Generic utility libraries
See Statics Design and Dynamics Design for more info on stylesheet design of the two XRadar viewpoints.

How does XRadar works ?

When you run Statics, you initiate an XSL pipeline where each metric source is integrated by a specific merge style sheet. Relevant data from each merge is added to the total xml report. In a way you produce an extendable xml metric database of the system. The final XML report is post processed and then sent to the relevant report framework. For the XRadar Statics report, that report framework is to a set of XSL style sheets that produces the final HTML/SVG report. See the figure below for a rough figure of framework running XRadar Statics.

Statics pipeline architecture

Once the merging is done, XRadar extract from the aggregated data the metrics is required to do its own calculation and graphics generation.