A model is a collection of several Bundle.xml files where your entire model is described. A model folder normally contains the following bundles:

More information about each type of bundle is available in this manual. Note that a Bundle.xml file normally includes external files located elsewhere in the standard Squore configuration. This allows reusing modules between models.

The following is an (incomplete) example of a Bundle.xml file that includes other files from the Squore configuration. Note that the xmlns:xi declaration in the Bundle element is mandatory if you want to include external files.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Bundle xmlns:xi="http://www.w3.org/2001/XInclude" >
    <!-- Aliases -->
    <ArtefactType id="CODE" heirs="PACKAGES;FILES;CLASSES;MODULES" />
    <ArtefactType id="PACKAGES" heirs="APPLICATION;SOURCE_CODE;FOLDER" />
    <ArtefactType id="FILES" heirs="FILE" />
	<ArtefactType id="CLASSES" heirs="CLASS" />

	<xi:include href="../../Shared/Analysis/SQuORE_BasicScales.xml" />	   
	
		<!-- SQuORE Base Measures -->
	<xi:include 
	  href="../../Shared/Analysis/product_quality/code/line_counting/line_counting.xml" />
	<xi:include 
	  href="../../Shared/Analysis/Code/ObjectOrientation/squore_java_oo_basemeasures.xml" />
	<xi:include 
	  href="../../Shared/Analysis/Code/ObjectOrientation/SQuORE_Inheritance.xml" />

		<!-- Rule Checking -->
	<xi:include 
	  href="../../Shared/Analysis/Code/RuleSet/SQuORE_Java_RuleSet.xml" />

		<!-- SQALE Analysis Model -->
	<xi:include 
	  href="../../Shared/Analysis/Code/SQALE/SQALE_Characteristics.xml" />
	<xi:include href="SQALE_Requirement.xml" />

	<RootIndicator indicatorId="SQALE_INDEX_DENSITY" artefactTypes="APPLICATION;FOLDER;SOURCE_CODE" />
	<RootIndicator indicatorId="SQALE_INDEX" artefactTypes="FUNCTION;CLASS;FILE" />
	<Measure measureId="COST" targetArtefactTypes="APPLICATION" defaultValue="0" />
</Bundle>

For the easy customisation of labels displayed in the Squore interface, all strings have been externalised to localisable properties files . For each XML file containing definitions (e.g. for scales, indicators, measures, etc.) there is a file with the same name and a .properties extension for each target language (_en and _fr by default). As an example, the English properties files for the Checkstyle_RuleSet.xml file is located in the same directory and called Checkstyle_RuleSet_en.properties.

Squore will select the appropriate language to use according to the language options defined in the description bundle:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Bundle available="fr,en" default="en">
	<Properties src="Checkstyle_RuleSet" />
</Bundle>

In the example above, it is assumed that two files exist with the names Checkstyle_RuleSet_en.properties and Checkstyle_RuleSet_fr.properties, since you declared both languages in the available attribute. Users are free to switch between the English and French languages using the flag icons in Squore's web interface. By default, Squore will display the descriptions from Checkstyle_RuleSet_en.properties, since you set the default language to "en" using the default attribute.

Properties files are simple text files containing key-value pairs of internal unique identifier (often referred to as the ID) and language-dependent mnemonics, names, descriptions, help URL and justifications. The convention used for their syntax is the following:

<TYPE> and <ARTEFACT-TYPE> are optional, but they can help you specify exceptions when viewing a measure for a certain type of artefact. Squore will resolve properties from the more specific to the more abstract, as shown below:

The following is an example of the declaration of SLOC:

M.SLOC.MNEMO=SLOC
  M.SLOC.NAME=Source Lines Of Code
  M.SLOC.DESCR=Number of lines of source code in the /application.
  M.SLOC.JUSTIF=MAINTAINABILITY

Note that in the example above, / is used to indicate a new line in the description, and SLOC is of type measure, as indicated by the prefix M.

The other available prefixes are:

Types are defined in the <INSTALLDIR>/Configuration/models/Shared/Analysis/Code/Types/types_en.properties properties file. Other languages are defined in the same directory with a different ending (e.g. types_fr.properties for French). Types are then used in all declarations that provide artefact-level information, like e.g. in measures:

<Measure measureId="DIT"  
    targetArtefactTypes="CLASS" 
    defaultValue="1" />

Rights are described and translated in the <INSTALLDIR>/Configuration/models/Shared/Description/rights_en.properties properties file. Create your own language file by changing the language ending of this file, e.g. rights_ru.properties for Russian.

Roles are described and translated in the <INSTALLDIR>/Configuration/models/Shared/Description/roles_en.properties file. There is one file per language, create your own language file by changing the language ending of this file, e.g. roles_ru.properties for Russian.

Statuses are described and translated in the <INSTALLDIR>/Configuration/models/Shared/Description/status_en.properties file. There is one file per language, create your own language file by changing the language ending of this file, e.g. status_ru.properties for Russian.