10.2. Workflow-Konfiguration

Um die Statistik-Komponente zu nutzen, muss lediglich eine Workflow Komponente hinzugefügt werden:

<component id="statistics" class="de.genesez.platforms.common.workflow.Statistics"> 
    ...
</component>

Die Statistik Workflow Komponente ist von der Generator Workflow Komponente abgeleitet und kann dadurch mit den selben Parametern konfiguriert werden. Die wichtigsten geerbten Parameter sind folgende:

outputDir, mandatory, single-value

spezifiziert das Ausgabeverzeichnis für die Statistik-Datei, siehe hier

template, mandatory, single-value, Standard: de::genesez::platforms::common::statistic::Root::Root

spezifiziert das Template welches die Statistik-Datei generiert. Soll das Aussehen der Statistik-Datei geändert werden, kann hier ein anderes Template spezifiziert werden oder der Parameter aspectTemplate genutzt werden.

slot, mandatory, single-value, Standard: statisticModel

die Statistik-Komponente ändert den Standartwert des Slot-Parameters zur Ablage des Statistik-Modells

Die Workflow Komponente selbst bietet folgende Paramete:

name, optional, single-value, Standard: Statistic

der Name des Software-Projekts für die Zusammenfassung sowie die Statistik-Datei

withDate, optional, single-value, Standard: false

boolscher Wert der angibt ob der Name der Statistik-Datei um einen Zeitstempel ergänzt werden soll

generatedDir, optional, multi-value

ein Quellcodeverzeichnis mit generierten Quellcode, d.h. die Quellcodedateien wurden vom Generator erzeugt und innerhalb Protected Regions wurde manuel implementiert

generatedDirs, optional, multi-value

gleiche Bedeutung wie generatedDir , jedoch kann als Wert eine mit Komma oder Semikolon getrennte Liste mit Quellcodeverzeichnissen angegeben werden

manualDir, optional, multi-value

ein Quellcodeverzeichnis das ausschließlich manuellen Quellcode enthält, d.h. die Quellcodedateien wurden manuell erzeugt und enthalten keinerlei generierten Quellcode

manualDirs, optional, multi-value

gleiche Bedeutung wie manualDir , jedoch kann als Wert eine mit Komma oder Semikolon getrennte Liste mit Quellcodeverzeichnissen angegeben werden

excludes, optional, single-value, Standard: .svn, .cvs

spezifiziert die Namen für den Dateifilter der Dateien und Verzeichnisse mit diesen Namen von der Statistik ausschließt

comments, optional, single-value

spezifiziert die Kommentarzeichen um die Quellcodezeilen auszuwerten. Die Kommentarzeichen werden mit einer Objektdefinition angegeben. Folgend die Standardwerte:

<comments class="de.genesez.platforms.common.statistic.CommentSign">
    <singleLineComment value="//" />
    <multiLineCommentStart value="/\\*" />
    <multiLineCommentEnd value="\\*/" />
    <multiLineCommentLine value="\\*" />
    <multiLineDocCommentStart value="/\\*\\*" />
</comments>

Standardmäßig beginnen Einzeilenkommentare mit //, Mehrzeilenkommentare mit /*, Dokumentationskommentare mit /**. Mehrzeilen- und Dokumentationskommentare enden mit */. Kommentarzeilen innerhalb Mehrzeilen- und Dokumentationskommentaren beginnen mit *.