jQA logo

Your Software. Your Structures. Your Rules.

This document describes the concepts of jQAssistant and usage information.

Overview

jQAssistant is a QA tool which allows the definition and validation of project specific rules on a structural level. It is built upon the graph database Neo4j and can easily be plugged into the build process to automate detection of constraint violations and generate reports about user defined concepts and metrics.

Example use cases:

  • Enforce naming conventions, e.g. EJBs, JPA entities, test classes, packages, maven modules etc.

  • Validate dependencies between modules of your project

  • Separate API and implementation packages

  • Detect common problems like cyclic dependencies or tests without assertions

The rules are expressed in Cypher - the easy-to-learn query language of Neo4j:

MATCH
  (t:Test:Method)
WHERE NOT
  (t)-[:INVOKES]->(:Assert:Method)
RETURN
  t AS TestWithoutAssertion

License

jQAssistant is contributed under GNU General Public License, v3.

Requirements

  • Java Runtime Environment 7 (64 bit recommended) or later (it is still possible to analyze applications which have been compiled with older Java versions)

  • at least 1GB of RAM

Note
Adjusting memory settings can be achieved by setting the environment variables JQASSISTANT_OPTS (command line) or MAVEN_OPTS (Maven), e.g.
Windows
set JQASSISTANT_OPTS=-Xmx1024M -XX:MaxPermSize=512M
set MAVEN_OPTS=-Xmx1024M -XX:MaxPermSize=512M
Linux
export JQASSISTANT_OPTS=-Xmx1024M -XX:MaxPermSize=512M
export MAVEN_OPTS=-Xmx1024M -XX:MaxPermSize=512M
Note
If Java 7 is used to execute jQAssistant the PermGen size of the JVM must be set to 512MB (-XX:MaxPermSize=512M).

Quickstart

Command Line

Requirements

  • Java Development Kit 7 or later

  • the environment variable JQASSISTANT_OPTS should be set to adjust memory settings

Windows
set JQASSISTANT_OPTS=-Xmx1024M -XX:MaxPermSize=512m
Linux
export JQASSISTANT_OPTS=-Xmx1024M -XX:MaxPermSize=512m
Note
-XX:MaxPermSize=512M is only required for Java 7

Installation

  • Download and unpack the distribution, a directory "jqassistant.distribution-1.1.4" will be created.

Scan

Windows
bin\jqassistant.cmd scan -f lib
Linux
bin/jqassistant.sh scan -f lib
  • The JAR files contained in the lib/ folder will be scanned.

Explore

Windows
bin\jqassistant.cmd server
Linux
bin/jqassistant.sh server
  • Open a browser and navigate to http://localhost:7474

  • Enter the following query in the top level area and hit Ctrl-Enter:

MATCH
  (a:Artifact)-[:CONTAINS]->(t:Type)-[:DECLARES]->(m:Method)
RETURN
  a.fileName as Artifact, t.fqn AS Type, count(t) AS DeclaredMethods
ORDER BY
  DeclaredMethods DESC
LIMIT 20

Maven

Requirements

  • Maven 3.2 or later

  • Java Development Kit 7 or later

  • the environment variable MAVEN_OPTS must be set to adjust memory settings

Windows
set MAVEN_OPTS=-Xmx1024M -XX:MaxPermSize=512m
Linux
export MAVEN_OPTS=-Xmx1024M -XX:MaxPermSize=512m
Note
-XX:MaxPermSize=512M is only required for Java 7

Add the plugin

Add the following lines to the parent pom.xml file of your project:

<build>
    <plugins>
        <plugin>
            <groupId>com.buschmais.jqassistant.scm</groupId>
            <artifactId>jqassistant-maven-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>scan</goal>
                        <goal>analyze</goal>
                    </goals>
                    <configuration>
                        <failOnViolations>true</failOnViolations>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

<reporting>
    <plugins>
        <plugin>
            <groupId>com.buschmais.jqassistant.scm</groupId>
            <artifactId>jqassistant-maven-plugin</artifactId>
            <reportSets>
                <reportSet>
                    <reports>
                        <report>report</report>
                    </reports>
                </reportSet>
            </reportSets>
        </plugin>
    </plugins>
</reporting>

Add a rule

Within your parent module create a directory "jqassistant" and a rules file "my-rules.xml" in it:

jqassistant/my-rules.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <constraint id="my-rules:TestClassName">
        <requiresConcept refId="junit4:TestClass" />
        <description>All JUnit test classes must have a name with suffix "Test".</description>
        <cypher><![CDATA[
            MATCH
                (t:Junit4:Test:Class)
            WHERE NOT
                t.name =~ ".*Test"
            RETURN
                t AS InvalidTestClass
        ]]></cypher>
    </constraint>

    <group id="default">
        <includeConstraint refId="my-rules:TestClassName" />
    </group>

</jqa:jqassistant-rules>

Run the build

Execute the following command from your parent module:

mvn install

The build will fail with the message specified by your rule if it is violated. If everything is fine you can also create a report as part of your Maven site:

mvn site

Explore your application

jQAssistant comes with an integrated Neo4j server, you can run it using

mvn jqassistant:server
  • Open a browser and navigate to http://localhost:7474

  • Enter the follwoing query in the top level area and hit Ctrl-Enter:

MATCH
  (t:Type)-[:DECLARES]->(m:Method)
RETURN
  t.fqn AS Type, count(t) AS DeclaredMethods
ORDER BY
  DeclaredMethods DESC
LIMIT 20

Introduction

This chapter provides an introduction to the concepts of jQAssistant.

How it works

The basic idea behind jQAssistant is to integrate the following steps into the build process of a software system:

  1. Scan the generated artifacts and store structural information about them into a database

  2. Analyze the structures using rules which are represented by queries

  3. Report violations

jQAssistant itself is a plugin based framework. It comes with a pre-defined set of plugins containing scanners, rules and reports but can be easily extended by custom rules or implementations.

As database an embedded instance of Neo4j Community Edition is managed and used by jQAssistant. This means that no setup or configuration of a dedicated server is required. Neo4j has been chosen because:

  • it is a mature open source graph database

  • it allows easy modelling of structural elements of a software and their relations

  • it comes with a very expressive and easy to learn query language (Cypher)

Scanner

Scanners are used to import software structures into the database. They are provided by plugins and may support several types of artifacts, e.g. Java classes, XML files or database structures. The jQAssistant framework (including the command line or Maven plugin) only provides the infrastructure to run a scan operation on a set of items, e.g. files, directories or URLs. Every active plugin decides itself if it accepts and imports a given item by checking several conditions, e.g. file name extensions or a provided scope. The latter is an extra information which provides specific context information like "java:classpath" for a directory containing Java classes or "maven:repository" for a URL.

Rules

Rules are expressed as Cypher queries and are specified either in XML or AsciiDoc files:

XML example

my-rules.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.1">

    <group id="default">
        <includeConstraint refId="my-rules:MyConstraint"/>
    </group>

    <concept id="my-rules:MyConcept">
        <description>A human readable description of the concept.</description>
        <cypher><![CDATA[
            MATCH
              ...
            WHERE
              ...
            SET
              ...
            CREATE
              ...
            RETURN
              ...
        ]]></cypher>
    </concept>

    <constraint id="my-rules:MyConstraint" severity="blocker">
        <requiresConcept refId="my-rules:MyConcept" />
        <description>A human readable description of the constraint.</description>
        <cypher><![CDATA[
            MATCH
                ...
            WHERE
                ...
            RETURN
                ...
        ]]></cypher>
    </constraint>

</jqa:jqassistant-rules>

AsciiDoc example

my-rules.adoc
[[my-rules:MyConcept]]
.A human readable description of the concept.
[source,cypher,role=concept]
----
MATCH
  ...
WHERE
  ...
SET
  ...
CREATE
  ...
RETURN
  ...
----

[[my-rules:MyConstraint]]
.A human readable description of the constraint.
[source,cypher,role=constraint,requiresConcepts="my-rules:MyConcept",severity=blocker]
----
MATCH
  ...
WHERE
  ...
RETURN
  ...
----

[[my-rules:MyGroup]]
.A human readable description of the group.
[role=group,includesConstraints="my-rules:MyConstraint(minor)"]
== My Group

Each rule comes with an unique id (e.g. "my-rules:MyConstraint") which can be referenced by other rules. jQAssistant will take care about executing the rules in the correct order. Furthermore a human readable description shall help developers to understand the rationale behind them.

Groups

A group is a set of rules that shall be executed together by including them with the option to overwrite their default severity. This allows to adjust analysis depth for different types of builds, e.g. a Continuous Integration build (CI) can be configured to only execute rules with low costs (i.e. execution times) whereas a report build is allowed to run for a longer time with more expensive checks.

Concepts

The information created by the scanner represents the structure of a software project on a raw level. Concept rules allow enriching the database with higher level information to ease the process of writing queries that check for violations (i.e. constraints) . This typically means adding labels, properties or relations.

jQAssistant comes with language and framework plugins which include general technical concepts, e.g.

  • "jpa2:Entity" provided by the JPA2 plugin adds a label "Entity" to a node if it represents a class which is annotated by "@javax.persistence.Entity".

  • "java:MethodOverrides" provided by the Java plugin adds a relation "OVERRIDES" between a method of a sub class to the super class methods it overrides.

It is recommended to use concepts to enrich the database with information which is specific for the concrete project, e.g. labels can be added to

  • package nodes representing modules of the application ("Module")

  • package nodes that represent technical layers ("UI", "EJB")

  • class nodes representing elements with a specific role ("Controller", "Model")

NOTE Even if the primary intention of a concept is to enrich data it still must provide a return clause. If a concept returns an empty result a warning will be generated by jQAssistant. The rationale is that in such case the concept does not match the structure of the application and other rules which depend on it will probably not work as expected. The return clause of the concept shall preferably return a node/relation itself instead of an attribute of it. Similarly, return clauses with only count of matching nodes shall be avoided. With this, XML and HTML reports can provide additional information about the concept.

Constraints

A Constraint is a query which detects violations, e.g.

  • classes with specific roles (e.g. entity, controller, etc.) that are either located in the wrong packages or have names that do not fit defined conventions

  • invocations of methods which are deprecated and/or forbidden (e.g. constructors of java.util.Date)

  • dependencies to other modules which are not allowed

A constraint can depend on one or more concepts and usually is referenced by one or more groups.

NOTE If a constraint returns a result jQAssistant will report an error including the provided description and information about the returned elements. This information shall help the developer to understand and fix the problem.

Severity Of Rules

A rule may optionally define the severity level. jQAssistant allows to break the build if there are violations in the configured severity level (or higher). For example, if the severity is set to critical, and if there are violated constraints with blocker and/or critical severity; the build will break. This feature allows projects to pay down their technical debt in an iterative manner.

Following severity levels are supported:

  • info

  • minor (default for concepts)

  • major (default for constraints)

  • critical

  • blocker

There is no default severity for groups. If a severity is specified then it is applied to all included elements where no further severity is given, e.g.

my-rules.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.1">

    <group id="my-rules:MyGroup" severity="blocker">
        <includeConstraint refId="my-rules:MyConstraint1"/>
        <includeConstraint refId="my-rules:MyConstraint2" severity="minor"/>
    </group>

<jqa:jqassistant-rules/>

or in Asciidoc:

[[my-rules:MyGroup]]
.A human readable description of the group.
[role=group,severity=blocker,requiresConstraints="my-rules:Constraint1,my-rules:Constraint2(minor)"]
== My Group

Thus execution of the group 'my-rules:MyGroup' will report a violation of constraint…​

  • …​'my-rules-Constraint1' with severity 'blocker' (inherited from the group)

  • …​'my-rules-Constraint2' with severity 'minor' (specified within the group)

Result verification

The default strategy verifies a result of a concept or constraint by counting the number returned rows, i.e.

  • a concept is valid if it returns at least one row

  • a constraint is valid if it returns no row

It is also possible to verify aggregated results reported as numeric values in a column, e.g.

<concept id="my-rules:MyConcept">
    <description>A human readable description of the concept.</description>
    <cypher><![CDATA[
        MATCH
          (n)
        WHERE
          ...
        SET
          ...
        RETURN
          n as Element, count(n) as Count
    ]]></cypher>
    <verify>
        <aggregation column="Count"/>
    </verify>
</concept>
[[my-rules:MyConcept]]
.A human readable description of the concept.
[source,cypher,role=concept,verify=aggregation,aggregationColumn="Count"]
----
MATCH
  (n)
WHERE
  ...
SET
  ...
RETURN
  n as Element, count(n) as Count
----

For each returned row the value in column "Count" will be verified following the same principles as described above. The rule will fail if at least one row does not match the expected result.

Script Languages

Instead of cypher scripting languages like JavaScript, Ruby or Groovy may be used for writing concepts or constraints:

my-scripting-rules.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.1">

    <constraint id="my-scripting-rules:MyConcept">
        <description>A JavaScript based concept.</description>
        <script language="JavaScript">
          ...
        </script>
    </constraint>

</jqa:jqassistant-rules>
my-scripting-rules.adoc
[[my-scripting-rules:MyConcept]]
.A JavaScript based concept.
[source,javascript,role=constraint]
----
  ...
----

Refer to the examples section for a detailed explanation.

Report

A rule may select a specific report plugin and pass properties to it:

<concept id="my-rules:MyConcept">
    <description>A human readable description of the concept.</description>
    <cypher><![CDATA[
        MATCH
          (m)-[]->(n)
          ...
        RETURN
          m, n
    ]]></cypher>
    <report reportType="myReport">
        <property name="key">value</property>
    </report>
</concept>
[[my-rules:MyConcept]]
.A human readable description of the concept.
[source,cypher,role=concept,reportType="myReport",reportProperties="key1=value1;key2=value2"]
----
    MATCH
      (m)-[]->(n)
      ...
    RETURN
      m, n
----
Primary Column

If a rule reports more than one column it might be necessary to specify the column which contains the primary element the rule refers to, e.g. the Java class. The information may be evaluated by reporting tools, e.g. for creating issues in SonarQube:

<concept id="my-rules:MyConcept">
    <description>A human readable description of the concept.</description>
    <cypher><![CDATA[
        MATCH
          (m)-[]->(n)
          ...
        RETURN
          m, n
    ]]></cypher>
    <report primaryColumn="n" />
</concept>
[[my-rules:MyConcept]]
.A human readable description of the concept.
[source,cypher,role=concept,primaryReportColumn="n"]
----
    MATCH
      (m)-[]->(n)
      ...
    RETURN
      m, n
----

NOTE The first column will be used automatically if no primary column is explicitly specified.

Command Line

Shell scripts are provided for executing jQAssistant from the command line of Microsoft Windows® or Unix compatible systems. They are located in the bin/ directory of the distribution:

  • jqassistant.cmd

  • jqassistant.sh

The command line accepts tasks and their specific options:

jqassistant.sh <task1> <task2> <task3> -<option1> -<option2>

The following example will scan the content of the directories classes/ and test-classes/:

jqassistant.sh scan -f classes,test-classes

Tasks

scan

Description

Scans files or directories and stores the gathered information in database. Files or URLs are accepted and may be specified further by scopes, e.g.

jqassistant.sh scan -f lib/,plugins/
jqassistant.sh scan -f java:classpath::classes/
jqassistant.sh scan -u http://host/artifact.jar
jqassistant.sh scan -u http://user:secret@host/artifact.jar
jqassistant.sh scan -u maven:repository::http://my.maven.repository
Options
  • -s, --storeDirectory <directory>

  • -f [<scope>::]<file1>,[<scope>::]<file2> or --files [<scope>::]<file1>,[<scope>::]<file2>

    • specifies a list of files or directories to scan

    • a scope may be used as prefix for each file argument

  • -u [<scope>::]<url1>,[<scope>::]<url2> or --urls [<scope>::]<url1>,[<scope>::]<url2>

    • specifies a list of URLs to scan

    • a scope may be used as prefix for each url argument

  • -reset

    • reset the database before scanning

  • -continueOnError

    • continue scanning even if a plugin fails with an unrecoverable error

Note
Using -continueOnError might create inconsistent data. Any reported errors should be reported to the plugin developer.

available-scopes

Description

List all available scopes which may be specified for scanning.

analyze

Description

Executes an analysis.

Options

available-rules

Description

List all available rules.

effective-rules

Description

List the rules which would be executed for an analysis and the given concepts, constraints or groups.

report

Description

Transforms an XML report into HTML.

server

Description

Starts the integrated Neo4j web server. * -serverAddress <address> specifies the binding address for the server (default: localhost) * -serverPort <port> specifies the binding port for the server (default: 7474)

Common options

-s, --storeDirectory <directory>
  • specifies the location of the database to use

  • default: './jqassistant/store'

-concepts <concept1>,<concept2>
  • specifies the ids of the concepts to be applied

-constraints <constraint1>,<constraint2>
  • specifies the ids of the constraints to be validated

-groups <group1>,<group2>
  • specifies the ids of the groups to be executed

  • default: 'default'

-r, --ruleDirectory <directory>
  • specifies the directory where rule files are located

  • default: './jqassistant/rules'

-rulesUrl <url>
  • specifies the URL of a file containing rules

  • this option is exclusive, i.e. it will disable loading rules from plugins or rule directories

-reportDirectory
  • specifies the directory where reports (XML, HTML) will be stored

  • default: './jqassistant/report'

Maven Plugin

jQAssistant provides a plugin for Apache Maven which can be used to provide either fully automated scanning and analysis during the build process or manual execution from a command line.

Setup

Project Scope

Software projects often consist of several modules which are assembled to executable or deployable artifacts. In a Maven project these modules are usually organized hierarchically with a common parent module which is referenced directly or indirectly by all sub-modules. For each project jQAssistant uses a separate database with its own set of rules. Thus if a goal is executed within a Maven structure jQAssistant first determines the project scope, i.e. the root module, by searching within the tree starting from the current module following the parent relation until either a module is found where a directory "jqassistant/" exists or no parent is defined. The determined root module defines the location of

  • the set of rules to apply (from the directory "jqassistant/")

  • the database, default "{project.build.directory}/jqassistant/store"

  • the generated native report, default: "{project.build.directory}/jqassistant/jqassistant-report.xml")

  • and the generated HTML report, default "{project.build.directory}/site/jqassistant.html")

The following examples demonstrate different scenarios, the root modules as detected by jQAssistant are marked using asterisks.

Single project consisting of two modules
root*
   |-pom.xml
   |
   |-jqassistant
   |           |-rules.xml
   |
   |-module1
   |       |-pom.xml
   |
   |-module2
           |-pom.xml
Multiple projects, each consisting of two modules
root
   |-pom.xml
   |
   |-project1*
   |        |-jqassistant
   |        |           |-rules1.xml
   |        |
   |        |-pom.xml
   |        |-module1
   |        |       |-pom.xml
   |        |
   |        |-module2
   |                |-pom.xml
   |
   |-project2*
            |-jqassistant
            |           |-rules2.xml
            |-pom.xml
            |-module1
            |       |-pom.xml
            |
            |-module2
                    |-pom.xml
Note
The described mechanism is designed to work for Maven module structures which are organized in hierarchies with consistent parent relations. For other setups it is possible to enforce using the module where the mvn goal is invoked as root module by setting the configuration option useExecutionRootAsProjectRoot (-Djqassistant.useExecutionRootAsProjectRoot).

Plugin Configuration

The jQAssistant Maven plugin must be configured in the pom.xml of the root module, it should not be overwritten by sub-modules.

Setup of the jQAssistant Maven plugin
<project ...>
    ...
    <build>
        <plugins>
            <plugin>
                <groupId>com.buschmais.jqassistant.scm</groupId>
                <artifactId>jqassistant-maven-plugin</artifactId>
                <version>1.1.4</version>
                <executions>
                    <execution>
                        <id>scan</id>
                        <goals>
                            <goal>scan</goal>
                        </goals>
                        <!--
                        <configuration>
                            <scanIncludes>
                                <scanInclude>
                                    <path>config</path>
                                </scanInclude>
                                <scanInclude>
                                    <path>target/extra-classes</path>
                                    <scope>java:classpath</scope>
                                </scanInclude>
                            </scanIncludes>
                            <scanProperties>
                                <customScanner.property>value</customScanner.property>
                            </scanProperties>
                            <continueOnError>false</continueOnError>
                        </configuration>
                        -->
                    </execution>
                    <execution>
                        <id>analyze</id>
                        <goals>
                            <goal>analyze</goal>
                        </goals>
                        <!--
                        <configuration>
                            <failOnViolations>true</failOnViolations>
                            <severity>critical</severity>
                            <concepts>
                                <concept>junit4:TestClass</concept>
                            </concepts>
                            <constraints>
                                <constraint>junit4:TestMethodWithoutAssertion</constraints>
                            </constraints>
                            <groups>
                                <group>default</group>
                            </groups>
                            <reportProperties>
                                <customReport.fileName>target/customReport.txt</customReport.fileName>
                            </reportProperties>
                        </configuration>
                         -->
                    </execution>
                </executions>
                <!--
                <configuration>
                    <skip>false</skip>
                    <useExecutionRootAsProjectRoot>false</useExecutionRootAsProjectRoot>
                    <storeLifecycle>REACTOR</storeLifecycle>
                    <rulesDirectory>jqassistant</rulesDirectory>
                    <rulesDirectories>
                        <rulesDirectory>target/generated-rules</rulesDirectory>
                    </rulesDirectories>
                    <xmlReportFile>target/jqassistant/jqassistant-report.xml</xmlReportFile>
                    <serverAddress>localhost</serverAddress>
                    <serverPort>7474</serverPort>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>com.buschmais.jqassistant.plugin</groupId>
                        <artifactId>jqassistant.plugin.jpa2</artifactId>
                        <version>1.1.4</version>
                    </dependency>
                </dependencies>
                -->
            </plugin>
        </plugins>
    </build>

    <reporting>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-project-info-reports-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>com.buschmais.jqassistant.scm</groupId>
                <artifactId>jqassistant-maven-plugin</artifactId>
                <version>1.1.4</version>
                <reportSets>
                    <reportSet>
                        <reports>
                            <report>report</report>
                        </reports>
                    </reportSet>
                </reportSets>
            </plugin>
        </plugins>
    </reporting>
    ...
</project>

Command Line

Goals may also be executed from the command line:

mvn com.buschmais.jqassistant.scm:jqassistant-maven-plugin:available-rules

Adding the following lines to the file settings.xml (usually located in the $HOME/.m2) eases execution of jQAssistant goals from the command line:

<pluginGroups>
    <pluginGroup>com.buschmais.jqassistant.scm</pluginGroup>
</pluginGroups>

The same goal can now be executed using the following command line statement:

mvn jqassistant:available-rules

Goals

jqassistant:scan

Description

Scans the project directories according to the given configuration (e.g. compiled classes and test classes) and stores the gathered information in database.

Configuration
Note
Using 'continueOnError' might create inconsistent data. Any reported errors should be reported to the plugin developer.

jqassistant:available-scopes

Description

List all available scopes which may be specified for scanInclude properties.

jqassistant:server

Description

Starts the integrated Neo4j web server (default address: http://localhost:7474).

Configuration

jqassistant:analyze

Description

Executes an analysis.

Configuration

jqassistant:report

Description

Transforms the XML report into HTML (i.e. for generating a Maven site).

Common Configuration Properties

Execution

skip (-Djqassistant.skip)
  • skip execution of the plugin

  • default: 'false'

useExecutionRootAsProjectRoot (-Djqassistant.useExecutionRootAsProjectRoot)
  • force the module where 'mvn' is being executed to be used as root module

  • default: 'false'

Store

storeDirectory (-Djqassistant.store.directory)
  • specifies the location of the database, either a relative path to the root module directory or an absolute path

  • default: '{rootModule}/target/jqassistant/store'

storeLifecycle (-Djqassistant.store.lifecycle)
  • specifies the lifecycle of the data store

    • 'REACTOR': cache the store for the execution time of the reactor for fast execution

    • 'MODULE': open and close the store for each module, slower but required for maven reactors containing extensions

  • default: 'REACTOR'

Analysis And Report

concepts (-Djqassistant.concepts)
  • specifies the ids of the concepts to be applied

constraints (-Djqassistant.constraints)
  • specifies the ids of the constraints to be validated

groups (-Djqassistant.groups)
  • specifies the ids of the groups to be executed

  • default: 'default'

rulesDirectory (-Djqassistant.rules.directory)
  • specifies the name of the directory which contains rules

  • this directory is also used to identify the root module of a project, see Project Scope

  • default: 'jqassistant'

rulesDirectories (-Djqassistant.rules.directories)
  • specifies a list of directory names relative to the root module containing additional rules

rulesUrl <url> (-Djqassistant.rules.url)
  • specifies the URL of a file containing rules

  • this option is exclusive, i.e. it will disable loading rules from plugins or rule directories

xmlReportFile (-Djqassistant.report.xml)
  • specifes the target file for writing the XML report

  • default: '{rootModule}/target/jqassistant/jqassistant-report.xml'

Examples

Rules

AsciiDoc

This example demonstrates the definition of rules in AsciiDoc documents and rendering them to an HTML documentation for developers.

Therefore a Maven project is used with the following structure:

Project structure
|-pom.xml
|
|-jqassistant
|           |-index.adoc
|
|-src/main/java
              |-com.buschmais.jqassistant.examples.rules.asciidoc.api
              |-com.buschmais.jqassistant.examples.rules.asciidoc.impl

The pom.xml file includes the setup for the jQAssistant Maven plugin and the Asciidoctor Maven Plugin:

jqassistant/index.adoc
    <build>
        <plugins>
            <plugin>
                <groupId>com.buschmais.jqassistant.scm</groupId>
                <artifactId>jqassistant-maven-plugin</artifactId>
                <version>1.1.4</version>
                <executions>
                    <execution>
                        <id>default</id>
                        <goals>
                            <goal>scan</goal>
                            <goal>analyze</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <failOnViolations>false</failOnViolations>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.asciidoctor</groupId>
                <artifactId>asciidoctor-maven-plugin</artifactId>
                <version>1.5.3</version>
                <executions>
                    <execution>
                        <id>jqassistant-rules</id>
                        <phase>process-resources</phase>
                        <goals>
                            <goal>process-asciidoc</goal>
                        </goals>
                        <configuration>
                            <sourceDirectory>jqassistant</sourceDirectory>
                        </configuration>
                    </execution>
                </executions>
                <configuration>
                    <backend>xhtml5</backend>
                    <sourceHighlighter>coderay</sourceHighlighter>
                    <attributes>
                        <toc>auto</toc>
                        <toclevels>3</toclevels>
                    </attributes>
                </configuration>
            </plugin>
        </plugins>
    </build>

The file "jqassistant/index.adoc" provides the following definitions:

The group "default"

A group can be applied to any block in the document, e.g. a head line, a list, etc by adding a role attribute with value "group". The attributes "includeGroups", "includesConcepts" and "includesConstraints" reference the rules which should be included and are given as comma separated lists of their ids. For concepts and constraints their default severity may be overwritten.

The concepts "module-structure:Api", "module-structure:Impl" and the constraint "module-structure:ApiMustNotDependOnImplementation"

Concepts and constraints are code blocks (i.e. cypher) with a role attribute being either "concept" or "constraint". Further allowed attributes are "severity" and "requiresConcepts".

jqassistant/index.adoc
= Coding Rules

The following constraints apply for modules:

[[default]]
[role=group,includesConstraints="module-structure:ApiMustNotDependOnImplementation(blocker)"]
- <<module-structure:ApiMustNotDependOnImplementation>>

== Packages for API and implementation

Modules can provide their API types (e.g. interfaces and domain objects) in a package "api":

[[module-structure:Api]]
.Marks all "api" packages with "Api".
[source,cypher,role=concept]
----
match
  (p:Package)
where
  p.name="api"
set
  p:Api
return
  p as ApiPackage
----

Implementation types of a module are located in "impl" packages:

[[module-structure:Impl]]
.Marks all "impl" packages with "Impl".
[source,cypher,role=concept,severity=minor]
----
match
  (p:Package)
where
  p.name="impl"
set
  p:Impl
return
  p as ImplPackage
----

[[module-structure:ApiMustNotDependOnImplementation]]
.Types contained within an API package must not have dependencies to types contained in an implementation package.
[source,cypher,role=constraint,requiresConcepts="module-structure:Api,module-structure:Impl",severity=critical]
----
match
  (:Api:Package)-[:CONTAINS*0..]->(t1:Type),
  (:Impl:Package)-[:CONTAINS*0..]->(t2:Type),
  (t1)-[:DEPENDS_ON]->(t2)
return
  t1 as ApiType, t2 as ImplementationType
----

The AsciiDoc document renders to the following output:

Example 1. target/generated-docs/index.html

= Coding Rules

The following constraints apply for modules:

== Packages for API and implementation

Modules can provide their API types (e.g. interfaces and domain objects) in a package "api":

Marks all "api" packages with "Api".
match
  (p:Package)
where
  p.name="api"
set
  p:Api
return
  p as ApiPackage

Implementation types of a module are located in "impl" packages:

Marks all "impl" packages with "Impl".
match
  (p:Package)
where
  p.name="impl"
set
  p:Impl
return
  p as ImplPackage
Types contained within an API package must not have dependencies to types contained in an implementation package.
match
  (:Api:Package)-[:CONTAINS*0..]->(t1:Type),
  (:Impl:Package)-[:CONTAINS*0..]->(t2:Type),
  (t1)-[:DEPENDS_ON]->(t2)
return
  t1 as ApiType, t2 as ImplementationType

Forbidden Method

Demonstrates a constraint to define methods which must not be invoked by the application. The example denies usage of all constructors of java.util.Date.

jqassistant/default.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <constraint id="example:ConstructorOfDateMustNotBeUsed">
        <description>Constructors of java.util.Date must not be used.</description>
        <cypher><![CDATA[
            MATCH
                (dateType:Type)-[:DECLARES]->(forbiddenMethod:Method),
                (type:Type)-[:DECLARES]->(method:Method)-[:INVOKES]->(forbiddenMethod)
            WHERE
                dateType.fqn = 'java.util.Date'
                AND forbiddenMethod:Constructor
            RETURN
                method AS Method
        ]]></cypher>
    </constraint>

    <group id="default">
        <includeConstraint refId="example:ConstructorOfDateMustNotBeUsed"/>
    </group>

</jqa:jqassistant-rules>

Naming

The following rules demonstrate concepts and constraints to enforce names and locations of classes with dedicated roles. These are identified either by an implemented interface or an annotation.

Interface
jqassistant/controller.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <concept id="controller:ControllerClass">
        <description>Labels all classes implementing the Controller interface as "Controller".</description>
        <cypher><![CDATA[
            MATCH
                (controllerClass:Type:Class)-[:IMPLEMENTS*]->(controllerType:Type)
            WHERE
                controllerType.fqn = "com.buschmais.jqassistant.examples.rules.naming.Controller"
            SET
                controllerClass:Controller
            RETURN
                controllerClass
        ]]></cypher>
    </concept>

    <constraint id="controller:ClassNameMustHaveControllerSuffix">
        <requiresConcept refId="controller:ControllerClass"/>
        <description>All controller implementations must have a name suffix "Controller".</description>
        <cypher><![CDATA[
            MATCH
                (controllerClass:Class:Controller)
            WHERE
                NOT controllerClass.name =~ ".*Controller"
            RETURN
                controllerClass AS ControllerClass
        ]]></cypher>
    </constraint>

    <constraint id="controller:ClassesMustBeLocatedInControllerPackage">
        <requiresConcept refId="controller:ControllerClass"/>
        <description>All controller implementations must be located in the package "controller".</description>
        <cypher><![CDATA[
            MATCH
                (package:Package)-[:CONTAINS]->(controllerClass:Class:Controller)
            WHERE
                NOT package.name = "controller"
            RETURN
                controllerClass AS ControllerClass, package AS InvalidPackage
        ]]></cypher>
    </constraint>

</jqa:jqassistant-rules>
Annotation
jqassistant/model.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <concept id="model:ModelClass">
        <description>Labels all classes annotated with @Model as "Model".</description>
        <cypher><![CDATA[
            MATCH
                (modelClass:Type:Class)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(modelAnnotationType:Type)
            WHERE
                modelAnnotationType.fqn = "com.buschmais.jqassistant.examples.rules.naming.Model"
            SET
                modelClass:Model
            RETURN
                modelClass AS ModelClass
        ]]></cypher>
    </concept>

    <constraint id="model:ClassNameMustHaveModelSuffix">
        <requiresConcept refId="model:ModelClass"/>
        <description>All model classes must have a name suffix "Model".</description>
        <cypher><![CDATA[
            MATCH
                (modelClass:Class:Model)
            WHERE
                NOT modelClass.name =~ ".*Model"
            RETURN
                modelClass AS ModelClass
        ]]></cypher>
    </constraint>

    <constraint id="model:ClassesMustBeLocatedInModelPackage">
        <requiresConcept refId="model:ModelClass"/>
        <description>All model classes must be located in the package "model".</description>
        <cypher><![CDATA[
            MATCH
                (package:Package)-[:CONTAINS]->(modelClass:Class:Model)
            WHERE
                NOT package.name = "model"
            RETURN
                modelClass AS ModelClass, package AS InvalidPackage
        ]]></cypher>
    </constraint>

</jqa:jqassistant-rules>

Scripting

Demonstrates a constraint implemented using JavaScript.

jqassistant/default.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <group id="default">
        <includeConstraint refId="xmlExample:JavaScriptConstraint"/>
        <includeConstraint refId="asciiDocExample:JavaScriptConstraint"/>
    </group>

    <constraint id="xmlExample:JavaScriptConstraint">
        <description>JavaScript example constraint: returns a result containing the number
            of declared methods for each class.</description>
        <script language="JavaScript">
            // Define the columns returned by the constraint
            var columnNames = java.util.Arrays.asList("Type", "MethodsOfType");
            // Define the list of rows returned by the constraint
            var rows = new java.util.ArrayList();
            // Execute a query using the store
            var typeIterator = store.executeQuery("match (t:Type:Class) return t").iterator();
            while(typeIterator.hasNext()) {
                // Get the next row from the query result
                var typeRow = typeIterator.next();
                // Get the column "t" from the row, it represents a type
                // descriptor as defined by the Java plugin
                var type = typeRow.get("t",
                    com.buschmais.jqassistant.plugin.java.api.model.TypeDescriptor.class);
                // Get the declared methods of the type and count them
                var methodIterator = type.getDeclaredMethods().iterator();
                var methodsOfType = 0;
                while( methodIterator.hasNext()) {
                    methodIterator.next();
                    methodsOfType++;
                }
                // Define the row for the result and put the value for each defined column
                var resultRow = new java.util.HashMap();
                resultRow.put("Class", type);
                resultRow.put("MethodsOfType", methodsOfType);
                rows.add(resultRow);
            }
            // Return the result
            var status = com.buschmais.jqassistant.core.analysis.api.Result.Status.SUCCESS;
            new com.buschmais.jqassistant.core.analysis.api.Result(rule, status, severity, columnNames, rows);
        </script>
    </constraint>

</jqa:jqassistant-rules>

Other scripting languages may be used as well if they integrate with the Java Scripting API (JSR-223), e.g. Groovy or JRuby. The corresponding libraries must be available on the classpath of jQAssistant, e.g. by adding a dependency to the Maven plugin:

pom.xml
<build>
    <plugins>
        <plugin>
            <groupId>com.buschmais.jqassistant.scm</groupId>
            <artifactId>jqassistant-maven-plugin</artifactId>
            <version>1.1.4</version>
            <dependencies>
                <dependency>
                    <groupId>org.codehaus.groovy</groupId>
                    <artifactId>groovy-jsr223</artifactId>
                    <version>2.4.0</version>
                </dependency>
                <dependency>
                    <groupId>org.jruby</groupId>
                    <artifactId>jruby-core</artifactId>
                    <version>9.0.5.0</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

The following global variables are provided to the script:

store

The store instance of type com.buschmais.jqassistant.core.store.api.Store which provides access to the graph database.

rule

The rule to be executed, i.e. a an instance of com.buschmais.jqassistant.core.analysis.api.rule.ExecutableRule.

severity

The effective severity.

The script must return a result which is structured like a database result consisting of rows each represented by a map of named columns and their values. Therefore an instance of com.buschmais.jqassistant.core.analysis.api.Result must be created which takes the following constructor arguments:

rule

The rule as provided to the script.

severity

The severity to report, a value of the enum type com.buschmais.jqassistant.core.analysis.api.rule.Severity.

columnNames

A java.util.List containing strings representing the column names.

rows

A java.util.List containing instances of java.util.Map where each map represents a single row consisting of the column name as key and a corresponding value.

Tip
The rule can also be specified in an AsciiDoc document:
jqassistant/default.adoc
= Using script languages as rules

[[asciiDocExample:JavaScriptConstraint]]
.JavaScript example constraint: returns a result containing the number of declared methods for each class.
[source,javascript,role=constraint]
----
// Define the columns returned by the constraint
var columnNames = java.util.Arrays.asList("Type", "MethodsOfType");
// Define the list of rows returned by the constraint
var rows = new java.util.ArrayList();
// Execute a query using the store
var typeIterator = store.executeQuery("match (t:Type:Class) return t").iterator();
while(typeIterator.hasNext()) {
    // Get the next row from the query result
    var typeRow = typeIterator.next();
    // Get the column "t" from the row, it represents a type
    // descriptor as defined by the Java plugin
    var type = typeRow.get("t",
        com.buschmais.jqassistant.plugin.java.api.model.TypeDescriptor.class);
    // Get the declared methods of the type and count them
    var methodIterator = type.getDeclaredMethods().iterator();
    var methodsOfType = 0;
    while( methodIterator.hasNext()) {
        methodIterator.next();
        methodsOfType++;
    }
    // Define the row for the result and put the value for each defined column
    var resultRow = new java.util.HashMap();
    resultRow.put("Class", type);
    resultRow.put("MethodsOfType", methodsOfType);
    rows.add(resultRow);
}
// Return the result
var status = com.buschmais.jqassistant.core.analysis.api.Result.Status.SUCCESS;
new com.buschmais.jqassistant.core.analysis.api.Result(rule, status, severity, columnNames, rows);
----

Plugins

Custom Scanner Plugin

A custom scanner plugin allows extending the functionality of jQAssistant to read arbitrary structures (e.g. from files) and create the corresponding information in the database. The following example demonstrates this for CSV files.

The plugin is an artifact which contains the scanner implementation, model classes and a plugin descriptor. The project needs to declare the following dependencies:

pom.xml
<dependencies>
    <dependency>
        <groupId>com.buschmais.jqassistant.core</groupId>
        <artifactId>jqassistant.core.scanner</artifactId>
        <version>1.1.4</version>
    </dependency>
    <dependency>
        <groupId>com.buschmais.jqassistant.plugin</groupId>
        <artifactId>jqassistant.plugin.common</artifactId>
        <version>1.1.4</version>
    </dependency>
    <dependency>
        <groupId>au.com.bytecode</groupId>
        <artifactId>opencsv</artifactId>
        <version>2.4</version>
    </dependency>
</dependencies>

The artifact 'jqassistant.core.scanner' provides the scanner plugin API, 'jqassistant.plugin.common' contains common functionality shared by plugins, the library 'opencsv' is used to read CSV files.

The model to be stored in the database is defined using the approach provided by eXtended Objects. It is based on annotated interfaces declaring methods representing properties and relations.

First a label "CSV" is defined which is going to be used for all nodes created by the scanner:

com.buschmais.jqassistant.examples.plugins.scanner.model.CSVDescriptor
/**
 * Defines the label which is shared by all nodes representing CSV structures.
 */
@Label("CSV")
public interface CSVDescriptor extends Descriptor {
}

A CSV file is represented by CSVFileDescriptor which inherits from CSVDescriptor and FileDescriptor (part of the scanner API). Thus a node of this type will carry the labels "CSV" and "File". Furthermore a list of "HAS_ROW" relations is defined by the property "rows".

com.buschmais.jqassistant.examples.plugins.scanner.model.CSVFileDescriptor
/**
 * Represents a CSV file. The labels are inherited from {@link CSVDescriptor}
 * and {@link FileDescriptor}.
 */
public interface CSVFileDescriptor extends CSVDescriptor, FileDescriptor {

    @Relation("HAS_ROW")
    List<CSVRowDescriptor> getRows();

}

A single row is a node defined by the type CSVRowDescriptor which inherits the label "CSV" from CSVDescriptor and provides its own label "Row", a property "lineNumber" and a list of "HAS_COLUMN" relations.

com.buschmais.jqassistant.examples.plugins.scanner.model.CSVRowDescriptor
/**
 * Represents a row of a CSV file.
 */
@Label("Row")
public interface CSVRowDescriptor extends CSVDescriptor {

    int getLineNumber();

    void setLineNumber(int lineNumber);

    @Relation("HAS_COLUMN")
    List<CSVColumnDescriptor> getColumns();

}

CSVColumnDescriptor finally defines a column of a row following the principles explained above:

com.buschmais.jqassistant.examples.plugins.scanner.model.CSVColumnDescriptor
/**
 * Represents a column within a row of a CSV file.
 */
@Label("Column")
public interface CSVColumnDescriptor extends CSVDescriptor {

    String getValue();

    void setValue(String value);

    int getIndex();

    void setIndex(int index);

}

The implementation of the plugin itself inherits from AbstractScannerPlugin which requires generic type parameters for the item type it handles and the descriptor type it creates. In the example FileResource is used which represents a file contained in a directory or archive. This allows plugins to be independent of the source where files or directories are picked up by the scanner.

The method accepts is called by the scanner to determine if the plugin can handle the given item. The example matches the value of the parameter path against the file extension ".csv". The scope parameter may be used to further restrict executions of the plugin, e.g. by checking equality against JavaScope.CLASSPATH.

The scan method actually reads the CSV file and stores the gathered data into the database using the interface Store provided by the scanner context.

com.buschmais.jqassistant.examples.plugins.scanner.CSVFileScannerPlugin
/**
 * A CSV file scanner plugin.
 */
@Requires(FileDescriptor.class) // The file descriptor is created by another
                                // plugin and used by this one
public class CSVFileScannerPlugin extends AbstractScannerPlugin<FileResource, CSVFileDescriptor> {

    @Override
    public boolean accepts(FileResource item, String path, Scope scope) throws IOException {
        return path.toLowerCase().endsWith(".csv");
    }

    @Override
    public CSVFileDescriptor scan(FileResource item, String path, Scope scope, Scanner scanner) throws IOException {
        final ScannerContext context = scanner.getContext();
        final Store store = context.getStore();
        // Open the input stream for reading the file.
        try (InputStream stream = item.createStream()) {
            // Retrieve the scanned file node from the scanner context.
            final FileDescriptor fileDescriptor = context.peek(FileDescriptor.class);
            // Add the CSV label.
            final CSVFileDescriptor csvFileDescriptor = store.addDescriptorType(fileDescriptor, CSVFileDescriptor.class);
            // Parse the stream using OpenCSV.
            CSV csv = CSV.create();
            csv.read(stream, new CSVReadProc() {

                @Override
                public void procRow(int rowIndex, String... values) {
                    // Create the node for a row
                    CSVRowDescriptor rowDescriptor = store.create(CSVRowDescriptor.class);
                    csvFileDescriptor.getRows().add(rowDescriptor);
                    rowDescriptor.setLineNumber(rowIndex);
                    for (int i = 0; i < values.length; i++) {
                        // Create the node for a column
                        CSVColumnDescriptor columnDescriptor = store.create(CSVColumnDescriptor.class);
                        rowDescriptor.getColumns().add(columnDescriptor);
                        columnDescriptor.setIndex(i);
                        columnDescriptor.setValue(values[i]);
                    }
                }

            });
            return csvFileDescriptor;
        }
    }
}

Finally the model and the plugin implementation must be declared in the jQAssistant plugin descriptor:

/META-INF/jqassistant-plugin.xml
<jqa-plugin:jqassistant-plugin
        xmlns:jqa-plugin="http://www.buschmais.com/jqassistant/core/plugin/schema/v1.1" name="CSV Example">
    <description>Provides a scanner for CSV file.</description>
    <model>
        <class>com.buschmais.jqassistant.examples.plugins.scanner.model.CSVFileDescriptor</class>
        <class>com.buschmais.jqassistant.examples.plugins.scanner.model.CSVRowDescriptor</class>
        <class>com.buschmais.jqassistant.examples.plugins.scanner.model.CSVColumnDescriptor</class>
    </model>
    <scanner>
        <class>com.buschmais.jqassistant.examples.plugins.scanner.CSVFileScannerPlugin</class>
    </scanner>
</jqa-plugin:jqassistant-plugin>

The plugin is automatically loaded by the scanner if it can be found on the classpath, e.g. by adding it as dependency to the maven plugin.

Custom Rule Plugin

Rules (i.e. concepts, constraints or groups) can be shared between projects by packaging their rule descriptors in JAR artifacts as a classpath resources under /META-INF/jqassistant-rules/, e.g.

/META-INF/jqassistant-rules/common.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <constraint id="common:TopLevelPackage">
        <description>All types defined in a project must use "com.buschmais" as top level package.</description>
        <cypher><![CDATA[
            MATCH
              (:Artifact)-[:CONTAINS]->(type:Type)
            WHERE
              NOT type.fqn =~ "com\\.buschmais\\..*"
            RETURN
              type AS TypeInWrongPackage
        ]]></cypher>
    </constraint>

</jqa:jqassistant-rules>

Furthermore these resources must be declared in the jQAssistant plugin descriptor /META-INF/jqassistant-plugin.xml:

/META-INF/jqassistant-plugin.xml
<jqa-plugin:jqassistant-plugin xmlns:jqa-plugin="http://www.buschmais.com/jqassistant/core/plugin/schema/v1.1"
                               name="Custom Rules">
    <description>Example plugin defining a set of custom rules.</description>
    <rules>
        <resource>common.xml</resource>
    </rules>
</jqa-plugin:jqassistant-plugin>

The plugin and its rules are automatically loaded by the analyzer if it can be found on the classpath, e.g. by adding it as dependency to the maven plugin.

Custom Report Plugin

A custom report plugin may be implemented to create custom representations of analysis results. Such a plugin must be provided as an artifact which contains a Java class and a plugin descriptor. Therefore a project is required which declares the required dependencies:

pom.xml
<dependencies>
    <dependency>
        <groupId>com.buschmais.jqassistant.core</groupId>
        <artifactId>jqassistant.core.report</artifactId>
        <version>1.1.4</version>
    </dependency>
    <dependency>
        <groupId>com.buschmais.jqassistant.plugin</groupId>
        <artifactId>jqassistant.plugin.java</artifactId>
        <version>1.1.4</version>
    </dependency>
</dependencies>

The artifact 'jqassistant.core.report' provides the report plugin API, 'jqassistant.plugin.java' provides interfaces representing Java types which might be used by the plugin implementation:

com.buschmais.jqassistant.examples.plugins.report.CustomReportPlugin
public class CustomReportPlugin implements ReportPlugin {

    private static final String PROPERTY_FILENAME = "customReport.fileName";

    private String fileName;

    @Override
    public void initialize() throws ReportException {
    }

    @Override
    public void configure(Map<String, Object> properties) throws ReportException {
        // general report properties
        this.fileName = (String) properties.get(PROPERTY_FILENAME);
        if (this.fileName == null) {
            throw new ReportException("Property " + PROPERTY_FILENAME + " is not specified.");
        }
    }

    @Override
    public void begin() throws ReportException {
    }

    @Override
    public void end() throws ReportException {
    }

    @Override
    public void beginConcept(Concept concept) throws ReportException {
    }

    @Override
    public void endConcept() throws ReportException {
    }

    @Override
    public void beginGroup(Group group) throws ReportException {
    }

    @Override
    public void endGroup() throws ReportException {
    }

    @Override
    public void beginConstraint(Constraint constraint) throws ReportException {
    }

    @Override
    public void endConstraint() throws ReportException {
    }

    @Override
    public void setResult(Result<? extends ExecutableRule> result) throws ReportException {
        ExecutableRule rule = result.getRule();
        Properties properties = rule.getReport().getProperties(); // rule specific report properties
        if (rule instanceof Concept && "example:MethodsPerType".equals(rule.getId())) {
            File file = new File(fileName).getAbsoluteFile();
            file.getParentFile().mkdirs();
            try (PrintWriter writer = new PrintWriter(new FileWriter(file))) {
                writer.println("Methods per Type");
                writer.println("================");
                for (Map<String, Object> row : result.getRows()) {
                    TypeDescriptor type = (TypeDescriptor) row.get("Type");
                    Long methodCount = (Long) row.get("MethodCount");
                    writer.println(type.getFullQualifiedName() + ":" + methodCount);
                }
            } catch (IOException e) {
                throw new ReportException("Cannot write custom report.", e);
            }
        }
    }
}

The plugin implementation must be declared in the jQAssistant plugin descriptor:

/META-INF/jqassistant-plugin.xml
<jqa-plugin:jqassistant-plugin xmlns:jqa-plugin="http://www.buschmais.com/jqassistant/core/plugin/schema/v1.1" name="Custom Report">
    <description>Example plugin defining a custom report.</description>
    <report>
        <class id="custom">com.buschmais.jqassistant.examples.plugins.report.CustomReportPlugin</class>
    </report>
</jqa-plugin:jqassistant-plugin>

The plugin is automatically loaded by the analyzer if it can be found on the classpath, e.g. by adding it as dependency to the maven plugin. The report plugin will be used automatically or may be explicitly selected per rule by its id (i.e. "custom").

Using Custom Plugins

Custom plugins containing rules, scanners or reporters must be specified as dependency of the Maven plugin. It is also possible to specify plugin specific properties:

pom.xml
<build>
    <plugins>
        <plugin>
            <groupId>com.buschmais.jqassistant.scm</groupId>
            <artifactId>jqassistant-maven-plugin</artifactId>
            <version>1.1.4</version>
            <configuration>
                <reportProperties>
                    <customReport.fileName>target/customReport.txt</customReport.fileName>
                </reportProperties>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>com.buschmais.jqassistant.examples</groupId>
                    <artifactId>jqassistant.examples.plugins.scanner</artifactId>
                    <version>1.1.4</version>
                </dependency>
                <dependency>
                    <groupId>com.buschmais.jqassistant.examples</groupId>
                    <artifactId>jqassistant.examples.plugins.rule</artifactId>
                    <version>1.1.4</version>
                </dependency>
                <dependency>
                    <groupId>com.buschmais.jqassistant.examples</groupId>
                    <artifactId>jqassistant.examples.plugins.report</artifactId>
                    <version>1.1.4</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

SonarQube

jQAssistant Plugin

jQAssistant comes with an integration for SonarQube 4.x and 5.1.x which allows creating issues for detected violations. The required artifacts are available from the standalone distribution in the folder "sonar/":

  • jqassistant.sonar.plugin-1.1.4.jar (plugin)

  • jqassistant.sonar.projectrules-1.1.4.jar (extension)

  • jqassistant.sonar.sonarrules-1.1.4.jar (extension)

For the installation the plugin and one of the mutually exclusive extensions must be copied to the directory "extensions/plugins" of the SonarQube server.

After startup a repository 'jQAssistant' is available in the view 'Coding rules'.

Project Rules (jqassistant.sonar.projectrules-1.1.4.jar)

This extension imports issues from an executed jQAssistant run as violations into SonarQube. jQAssistant will use concepts and constraints from the local build environment (i.e. rules in Asciidoc or XML documents). This setup is useful for seamless integration of jQAssistant violations via 'SonarQube Scanner' (see sonar-maven-plugin) without managing the rules in SonarQube and under complete control of the project team.

Sonar Rules (jqassistant.sonar.sonarrules-1.1.4.jar)

This extension makes all jQAssistant builtin concepts and constraints available as rules via a permalink that can be used by the jQAssistant Maven plugin or CLI via the 'rulesUrl' option. You can activate or define rules within SonarQube and assign them to projects. New rules can be added or created in the following ways:

  • by creating new concepts and constraints from the pre-defined templates (i.e. "Concept Template" and "Constraint Template")

  • by deploying a custom rule extension (demonstrated by the example "Custom Rule Extension")

This setup is useful for execution of jQAssistant using rules which are managed centrally withing SonarQube.

Example Setup

The example demonstrates a setup using rules which are administered within SonarQube, i.e. the extension jqassistant.sonar.sonarrules-1.1.4.jar needs to be deployed.

The following settings are applied to the jQAssistant Maven plugin in the pom.xml of the project to be analyzed:

pom.xml
<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.sonarsource.scanner.maven</groupId>
                <artifactId>sonar-maven-plugin</artifactId>
                <version>3.0.1</version>
            </plugin>
        </plugins>
    </pluginManagement>
    <plugins>
        <plugin>
            <groupId>com.buschmais.jqassistant.scm</groupId>
            <artifactId>jqassistant-maven-plugin</artifactId>
            <executions>
                <execution>
                    <id>scan</id>
                    <goals>
                        <goal>scan</goal>
                    </goals>
                </execution>
                <execution>
                    <id>analyze</id>
                    <goals>
                        <goal>analyze</goal>
                    </goals>
                    <configuration>
                        <!--
                        General configuration
                        -->
                        <failOnViolations>false</failOnViolations>
                        <severity>critical</severity>
                        <!--
                        rulesUrl must be set for the jqassistant.sonar.sonarrules extension
                        -->
                        <rulesUrl>http://localhost:9000/profiles/export?format=jqassistant&amp;language=java&amp;name=MyQualityProfile</rulesUrl>
                        <!--
                        The group name must be set to the name of the quality profile if the jqassistant.sonar.sonarrules
                        extension is used
                        -->
                        <groups>
                            <group>MyQualityProfile</group>
                        </groups>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
  • Rules are retrieved from the SonarQube server using the URL specified in 'rulesUrl'. The value is the jQAssistant permalink available within the quality profile from the SonarQube UI.

  • Special characters in the URL must be replaced by XML entities

  • Using the URL will deactivate all local rules (i.e. from a rule directory or plugins).

  • The specified 'group' must be the name of the quality profile used to analyze the project.

  • The build shall break if a violation is detected, therefore 'failOnViolations' is set to 'true'.

  • The build shall break only if violation is detected with severity equal to or higher than critical, therefore severity is set to critical.

Custom Rule Extension

A custom rule extension can be implemented to make user defined jQAssistant rules available for SonarQube. It is a Maven project which declares packaging 'sonar-plugin':

pom.xml
<project ...>
...

<properties>
    <org.codehaus.sonar_version>5.0</org.codehaus.sonar_version>
</properties>

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.sonar</groupId>
            <artifactId>sonar-packaging-maven-plugin</artifactId>
            <version>1.13</version>
            <extensions>true</extensions>
            <configuration>
                <basePlugin>jqassistantbase</basePlugin>
                <pluginKey>examplerules</pluginKey>
                <pluginName>jQAssistant example rules</pluginName>
                <pluginClass>com.buschmais.jqassistant.examples.sonar.ruleextension.MyJQAssistantExtension</pluginClass>
                <addMavenDescriptor>false</addMavenDescriptor>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>native2ascii-maven-plugin</artifactId>
            <version>1.0-beta-1</version>
            <executions>
                <execution>
                    <goals>
                        <goal>native2ascii</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

<dependencies>
    <dependency>
        <groupId>com.buschmais.jqassistant.sonar</groupId>
        <artifactId>jqassistant.sonar.plugin</artifactId>
        <version>1.1.4</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.codehaus.sonar</groupId>
        <artifactId>sonar-plugin-api</artifactId>
        <version>5.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>


...
</project>

Notes on the sonar plugin configuration:

  • 'basePlugin' must be set to 'jQAssistant' to indicate which plugin shall be extended.

  • The implementation of 'pluginClass' (i.e. 'MyJQAssistantExtension') returns an empty list of extensions. It must be specified as this is required by SonarQube.

MyJQAssistantExtension.java
package com.buschmais.jqassistant.examples.sonar.ruleextension;

import java.util.Collections;
import java.util.List;

import org.sonar.api.SonarPlugin;

/**
 * Defines a sonar extension.
 */
public class MyJQAssistantExtension extends SonarPlugin {

    @SuppressWarnings("rawtypes")
    @Override
    public List getExtensions() {
        return Collections.emptyList();
    }

}

The rules itself are packaged according to the following structure:

/META-INF/jqassistant-plugin.xml
<v1:jqassistant-plugin xmlns:v1="http://www.buschmais.com/jqassistant/core/plugin/schema/v1.1"
                       name="Sonar Rule Extension">
    <description>An example plugin.</description>
    <rules>
        <resource>example.xml</resource>
    </rules>
</v1:jqassistant-plugin>
  • example.xml specifies the path to a jQAssistant rule file relative to /META-INF/jqassistant-rules

/META-INF/jqassistant-rules/example.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <!-- Don't take these constraints serious - they are just here to illustrate integration with SonarQube -->

    <constraint id="example:AllClassesMustBeNamedFoo">
        <description>All classes must be named 'Foo'.</description>
        <cypher><![CDATA[
            MATCH
              (type:Class)
            WHERE NOT
              type.name = 'Foo'
            RETURN
              type AS InvalidClass
        ]]></cypher>
    </constraint>

    <constraint id="example:FieldsMustBeReadOnly" severity="critical">
        <description>All declared fields must be read-only (i.e. not be written).</description>
        <cypher><![CDATA[
            MATCH
              (m:Method)-[w:WRITES]->(f:Field)
            RETURN
              w AS WriteAccess
        ]]></cypher>
    </constraint>
</jqa:jqassistant-rules>

The created JAR archive and the jQAssistant must be copied to the folder 'extensions/plugins' of the SonarQube installation. The defined rules will be visible in the repository "jQAssistant".

Plugins

This section provides detailed descriptions of all distributed plugins.

CDI

Provides rules for CDI.

Scanner for beans.xml files

Imports beans descriptors from META-INF/beans.xml or WEB-INF/beans.xml files.

:File:Cdi:Beans

Represents a beans.xml file.

Table 1. Properties of :File:Cdi:Beans
Name Description

fileName

The file name

version

The version of the CDI specification this descriptor represents, e.g. '1.0'

beanDiscoveryMode

The bean discovery mode, i.e. "all", "annotated" or "none"

Table 2. Relations of :File:Cdi:Beans
Name Target label(s) Cardinality Description

HAS_INTERCEPTOR

:Java:Type

0..n

References an interceptor type which is activated

HAS_DECORATOR

:Java:Type

0..n

References a decorator type which is activated

HAS_ALTERNATIVE

:Java:Type

0..n

References an alternative type (class or stereotype annotation) which is activated

Refer to the plugin Javadoc for details about the model.

cdi.xml

Concepts
cdi:Alternative

Labels all types annotated by @javax.enterprise.inject.Alternative with "Cdi" and "Alternative".

MATCH
  (alternative:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(alternativeType:Type)
WHERE
  alternativeType.fqn="javax.enterprise.inject.Alternative"
SET
  alternative:Cdi:Alternative
RETURN
  alternative AS Alternative
cdi:Any

Labels all elements annotated by "javax.enterprise.inject.Any" with "Cdi" and "Any".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(anyType:Type)
WHERE
  anyType.fqn = "javax.enterprise.inject.Any"
SET
  e:Cdi:Any
RETURN
  e AS Any
cdi:ApplicationScoped

Labels all beans, fields or methods annotated by @javax.enterprise.context.ApplicationScoped with "Cdi" and "ApplicationScoped".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(scopeType:Type)
WHERE
  (e:Type or e:Method or e:Field)
  and scopeType.fqn="javax.enterprise.context.ApplicationScoped"
SET
  e:Cdi:ApplicationScoped
RETURN
  e AS ApplicationScopedElement
cdi:ConversationScoped

Labels all beans, fields or methods annotated by @javax.enterprise.context.ConversationScoped with "Cdi" and "ConversationScoped".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(scopeType:Type)
WHERE
  (e:Type or e:Method or e:Field)
  and scopeType.fqn="javax.enterprise.context.ConversationScoped"
SET
  e:Cdi:ConversationScoped
RETURN
  e AS ConversationScopedElement
cdi:Decorator

Requires concepts:

Labels all types annotated by @javax.decorator.Decorator with "Cdi" and "Decorator".

MATCH
  (decorator:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(decoratorType:Type)
WHERE
  decoratorType.fqn="javax.decorator.Decorator"
SET
  decorator:Cdi:Decorator
RETURN
  decorator AS Decorator
cdi:Default

Labels all elements annotated by "javax.enterprise.inject.Default" with "Cdi" and "Default".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(defaultType:Type)
WHERE
  defaultType.fqn = "javax.enterprise.inject.Default"
SET
  e:Cdi:Default
RETURN
  e AS Default
cdi:Delegate

Labels all fields annotated annotated by @javax.decorator.Delegate with "Cdi" and "Delegate".

MATCH
  (delegate:Field)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(delegateType:Type)
WHERE
  delegateType.fqn="javax.decorator.Delegate"
SET
  delegate:Cdi:Delegate
RETURN
  delegate AS Delegate
cdi:Dependent

Labels all beans, fields or methods annotated by @javax.enterprise.context.Dependent with "Cdi" and "Dependent".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(scopeType:Type)
WHERE
  (e:Type or e:Method or e:Field)
  and scopeType.fqn="javax.enterprise.context.Dependent"
SET
  e:Cdi:Dependent
RETURN
  e AS DependentElement
cdi:Disposes

Creates a relation DISPOSES between a parameter and its type if the parameter is annotated by @javax.enterprise.inject.Disposes.

MATCH
  (:Type)-[:DECLARES]->(disposeMethod:Method)-[:HAS]->(parameter:Parameter),
  (parameter)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(disposesType:Type),
  (parameter)-[:OF_TYPE]->(type)
WHERE
  disposesType.fqn="javax.enterprise.inject.Disposes"
CREATE UNIQUE
  (parameter)-[:DISPOSES]->(type)
RETURN
  disposeMethod AS DisposeMethod
cdi:EventConsumer

Requires concepts:

Labels all beans declaring method that has parameter of type "javax.enterprise.event.Observes" with "Cdi" and "EventConsumer".

MATCH
  (a:Type)-[:DECLARES]->(member:Method)-[:HAS]->(param:Parameter),
  (param)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(injectType:Type)
WHERE
  injectType.fqn = "javax.enterprise.event.Observes"
SET
  a:Cdi:EventConsumer
RETURN
  DISTINCT a.fqn AS cdiEventConsumer
cdi:EventProducer

Requires concepts:

Labels all beans declaring "InjectionPoint" of type "javax.enterprise.event.Event" with "Cdi" and "EventProducer".

MATCH
  (a:Type)-[:DECLARES]->(member:Field:Cdi:InjectionPoint),
  (member)-[:OF_TYPE]->(injectType:Type)
WHERE
  injectType.fqn = "javax.enterprise.event.Event"
SET
  a:Cdi:EventProducer
RETURN
  DISTINCT a.fqn AS cdiEventProducers
cdi:InjectionPoint

Labels all fields or methods annotated by @javax.inject.Inject with "Cdi" and "InjectionPoint".

MATCH
  (:Type)-[:DECLARES]->(member),
  (member)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(injectType:Type)
WHERE
  (member:Field or member:Method)
  and injectType.fqn="javax.inject.Inject"
SET
  member:Cdi:InjectionPoint
RETURN
  member AS InjectionPoint
cdi:Named

Labels all types or methods annotated by "javax.inject.Named" with "Cdi" and "Named".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(namedType:Type)
WHERE
  namedType.fqn = "javax.inject.Named"
SET
  e:Cdi:Named
RETURN
  e AS Named
cdi:New

Labels all elements annotated by "javax.enterprise.inject.New" with "Cdi" and "New".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(newType:Type)
WHERE
  newType.fqn = "javax.enterprise.inject.New"
SET
  e:Cdi:New
RETURN
  e AS New
cdi:Produces

Creates a relation PRODUCES between a field and its type or a method and its return type if the parameter is annotated by @javax.enterprise.inject.Disposes.

MATCH
  (:Type)-[:DECLARES]->(member),
  (member)-[:OF_TYPE|RETURNS]->(type),
  (member)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(producesType:Type)
WHERE
  (member:Field or member:Method)
  and producesType.fqn="javax.enterprise.inject.Produces"
CREATE UNIQUE
  (member)-[:PRODUCES]->(type)
RETURN
  member AS Producer
cdi:Qualifier

Labels all annotation types annotated by @javax.inject.Qualifier with "Cdi" and "Qualifier" and adds the labels "Cdi" and "Nonbinding" to all non-binding annotation values (i.e. which are annotated by @javax.enterprise.util.Nonbinding).

MATCH
  (qualifier:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(qualifierType:Type)
WHERE
  qualifierType.fqn = "javax.inject.Qualifier"
SET
  qualifier:Cdi:Qualifier
WITH
  qualifier
MATCH
  (qualifier)-[:DECLARES]->(attribute:Method),
  (attribute)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(nonbindingType:Type)
WHERE
  nonbindingType.fqn = "javax.enterprise.util.Nonbinding"
SET
  attribute:Cdi:Nonbinding
RETURN
  distinct qualifier AS Qualifier
cdi:RequestScoped

Labels all beans, fields or methods annotated by @javax.enterprise.context.RequestScoped with "Cdi" and "RequestScoped".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(scopeType:Type)
WHERE
  (e:Type or e:Method or e:Field)
  and scopeType.fqn="javax.enterprise.context.RequestScoped"
SET
  e:Cdi:RequestScoped
RETURN
  e AS RequestScopedElement
cdi:SessionScoped

Labels all beans, fields or methods annotated by @javax.enterprise.context.SessionScoped with "Cdi" and "SessionScoped".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(scopeType:Type)
WHERE
  (e:Type or e:Method or e:Field)
  and scopeType.fqn="javax.enterprise.context.SessionScoped"
SET
  e:Cdi:SessionScoped
RETURN
  e AS SessionScopedElement
cdi:SingletonScoped

Labels all beans annotated by @javax.inject.Singleton with "Cdi" and "SingletonScoped".

MATCH
  (t:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn = "javax.inject.Singleton"
SET
  t:Cdi:SingletonScoped
RETURN
  t AS cdiSingleton
cdi:Specializes

Labels all types and methods annotated by @javax.enterprise.inject.Specializes with "Cdi" and "Specializes".

MATCH
  (specializes)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(specializesType:Type)
WHERE
  (specializes:Type or specializes:Method)
  and specializesType.fqn="javax.enterprise.inject.Specializes"
SET
  specializes:Cdi:Specializes
RETURN
  specializes AS Specialization
cdi:Stereotype

Labels all annotation types annotated by @javax.enterprise.inject.Stereotype with "Cdi" and "Stereotype".

MATCH
  (stereotype:Type:Annotation)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(stereotypeType:Type)
WHERE
  stereotypeType.fqn="javax.enterprise.inject.Stereotype"
SET
  stereotype:Cdi:Stereotype
RETURN
  stereotype AS Stereotype
Constraints
cdi:BeansMustNotUseFieldInjection

Requires concepts:

CDI beans shall not use field injection (constructor and setter injections are fine.).

MATCH
  (a:Type)-[:DECLARES]->(member:Field:Cdi:InjectionPoint)
RETURN
  DISTINCT a.fqn AS invalidBean
cdi:BeansMustUseConstructorInjection

Requires concepts:

All CDI beans must use constructor injection.

MATCH
  (a:Type)-[:DECLARES]->(member:Cdi:InjectionPoint)
WHERE
  NOT member:Constructor
RETURN
  DISTINCT a.fqn AS invalidBean

decorator.xml

Concepts
decorator:Decorator

Requires concepts:

Labels all types annotated by @javax.decorator.Decorator with "Decorator".

MATCH
  (decorator:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(decoratorType:Type)
WHERE
  decoratorType.fqn="javax.decorator.Decorator"
SET
  decorator:Decorator
RETURN
  decorator AS Decorator
decorator:Delegate

Labels all fields annotated annotated by @javax.decorator.Delegate with "Decorator" and "Delegate".

MATCH
  (delegate:Field)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(delegateType:Type)
WHERE
  delegateType.fqn="javax.decorator.Delegate"
SET
  delegate:Decorator:Delegate
RETURN
  delegate AS Delegate

interceptor.xml

Concepts
interceptor:Binding

Labels all annotations annotated by "javax.interceptor.InterceptorBinding" with "Interceptor" and "Binding".

MATCH
  (binding:Type:Annotation)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(bindingType:Type)
WHERE
  bindingType.fqn = "javax.interceptor.InterceptorBinding"
SET
  binding:Interceptor:Binding
RETURN
  binding AS InterceptorBinding
interceptor:Interceptor

Labels all classes annotated by "javax.interceptor.Interceptor" with "Interceptor".

MATCH
  (interceptor:Type:Class)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(interceptorType:Type)
WHERE
  interceptorType.fqn = "javax.interceptor.Interceptor"
SET
  interceptor:Interceptor
RETURN
  interceptor AS Interceptor

EJB3

Provides rules for EJB3.

ejb3.xml

Concepts
ejb3:Local

Labels all types annotated with @javax.ejb.Local with "Ejb" and "Local".

MATCH (t:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE a.fqn="javax.ejb.Local"
SET t:Ejb:Local
RETURN t AS LocalBean
ejb3:MessageDrivenBean

Labels all types annotated with @javax.ejb.MessageDriven with "Ejb" and "MessageDriven".

MATCH (t:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE a.fqn="javax.ejb.MessageDriven"
SET t:Ejb:MessageDriven
RETURN t AS MessageDrivenBean
ejb3:Remote

Labels all types annotated with @javax.ejb.Remote with "Ejb" and "Remote".

MATCH (t:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE a.fqn="javax.ejb.Remote"
SET t:Ejb:Remote
RETURN t AS RemoteBean
ejb3:SingletonBean

Labels all classes annotated with @javax.ejb.Singleton with "Ejb" and "Singleton".

MATCH (t:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE a.fqn="javax.ejb.Singleton"
SET t:Ejb:Singleton
RETURN t AS SingletonEjb
ejb3:StatefulSessionBean

Labels all types annotated with @javax.ejb.Stateful with "Ejb" and "Stateful".

MATCH (t:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE a.fqn="javax.ejb.Stateful"
SET t:Ejb:Stateful
RETURN t AS StatefulEjb
ejb3:StatelessSessionBean

Labels all types annotated with @javax.ejb.Stateless with "Ejb" and "Stateless".

MATCH (t:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE a.fqn="javax.ejb.Stateless"
SET t:Ejb:Stateless
RETURN t AS StatelessEjb

GraphML

Provides a report plugin for generating GraphML files from the results of concepts.

GraphML Report

This plugin generates graphml xml files for result data of concepts. Those files can be used with several graph rendering and analytics tools like yEd and Gephi.

By default all concepts ending in .graphml will be rendered (e.g. "module:modules.graphml").

Configuration
Table 3. Configuration properties
Property Description Default

graphml.report.conceptPattern

Regular expression that describes the concept ids to use for rendering the result as GraphML file.

.*\.graphml$

graphml.report.directory

The directory where the .graphml files will be created

jqassistant/report

graphml.report.decorator

Specify the name of a class implementing the 'GraphMLDecorator' interface for layouting a graph

YedGraphMLDecorator

Example

The following concept will return package dependencies (as provided by the concept dependency:Package) as GraphML document:

reports.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <concept id="report:PackageDependencies.graphml">
        <requiresConcept refId="dependency:Package" />
        <description>Reports all package dependencies.</description>
        <cypher><![CDATA[
            MATCH
              (p1:Package)-[d:DEPENDS_ON]->(p2:Package)
            RETURN
              p1, d, p2
        ]]></cypher>
    </concept>

</jqa:jqassistant-rules>

The plugin also supports virtual relations, i.e. which are constructed in the return clause of the query. A part of the return clause constructs a JSON-Object with several properties:

role

to identify the type of virtual element (value: relationship)

type

relationship type

startNode

the start node of the relationship

endNode

the end node of the relationship

The following example virtually propagates the dependencies of Java types to the package level without creating a relationship in the store:

reports.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <concept id="report:VirtualPackageDependencies.graphml">
        <description>Reports all package dependencies.</description>
        <cypher><![CDATA[
            MATCH
              (p1:Package)-[:CONTAINS]->(t1:Type),
              (p2:Package)-[:CONTAINS]->(t2:Type),
              (t1)-[:DEPENDS_ON]->(t2)
            RETURN
              p1,
              {
                role: "relationship",
                type: "DEPENDS_ON",
                startNode: p1,
                endNode: p2
              },
              p2
        ]]></cypher>
    </concept>

</jqa:jqassistant-rules>

Virtual nodes will be provided in the same way like virtual relationships. These are the properties to use in the JSON-Object:

role

to identify the type of virtual element (value: node)

properties

node properties

labels

a list of labels for this node

The following example virtually aggregates some data without creating a node in the store:

reports.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <concept id="report:VirtualDataNode.graphml">
        <description>Aggregates data in a virtual node.</description>
        <cypher><![CDATA[
            MATCH
              (m:Method)
            RETURN
              {
                role: "node",
                properties: {totalCyclomaticComplexity : sum(m.cyclomaticComplexity)},
                labels: ["Metrics", "CyclomaticComplexity"]
              }
        ]]></cypher>
    </concept>

</jqa:jqassistant-rules>

To get a better structured GraphML-File subgraphs can be generated. With this pattern it is possible to drill down in the graph. These are the properties to use in the JSON-Object:

role

to identify the type of virtual element (value: graph)

parent

subgraphs must be nested in a parent node

nodes

all nodes that will be included in the subgraph

relationships

a list of relationships for the nodes. The relationships will be drawn if start- and end-node are part of the GraphML-file.

The following example creates a virtual subgraph:

reports.xml
<jqa:jqassistant-rules xmlns:jqa="http://www.buschmais.com/jqassistant/core/analysis/rules/schema/v1.0">

    <concept id="report:Subgraph.graphml">
        <description>Creates a Subgraph for a better overview.</description>
        <cypher><![CDATA[
            MATCH
              (t:Class)-[:DECLARES]->(m:Method)
            OPTIONAL MATCH
              (m)-[i:INVOKES]->(:Method)
            RETURN
              {
                role: "graph",
                parent: t,
                nodes: collect(m),
                relationships: collect(i)  (1)
              } as subgraph
        ]]></cypher>
    </concept>

</jqa:jqassistant-rules>
  1. The relationships can be used overall subgraphs

JAX-RS

Provides rules for JAX-RS.

jaxrs-resource.xml

Concepts
jaxrs:DeleteResourceMethod

Requires concepts:

Finds resource methods annotated with "@javax.ws.rs.DELETE" and labels them with 'DeleteResourceMethod'.

MATCH
  (m:JaxRS:ResourceMethod)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:JaxRS:RequestMethodDesignator)
WHERE
  a.fqn = "javax.ws.rs.DELETE"
SET
  m:DeleteResourceMethod
RETURN
  m AS DeleteMethod
jaxrs:GetResourceMethod

Requires concepts:

Finds resource methods annotated with "@javax.ws.rs.GET" and labels them with 'GetResourceMethod'.

MATCH
  (m:JaxRS:ResourceMethod)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:JaxRS:RequestMethodDesignator)
WHERE
  a.fqn = "javax.ws.rs.GET"
SET
  m:GetResourceMethod
RETURN
  m AS GetMethod
jaxrs:HeadResourceMethod

Requires concepts:

Finds resource methods annotated with "@javax.ws.rs.HEAD" and labels them with 'HeadResourceMethod'.

MATCH
  (m:JaxRS:ResourceMethod)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:JaxRS:RequestMethodDesignator)
WHERE
  a.fqn = "javax.ws.rs.HEAD"
SET
  m:HeadResourceMethod
RETURN
  m AS HeadMethod
jaxrs:OptionsResourceMethod

Requires concepts:

Finds resource methods annotated with "@javax.ws.rs.OPTIONS" and labels them with 'OptionsResourceMethod'.

MATCH
  (m:JaxRS:ResourceMethod)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:JaxRS:RequestMethodDesignator)
WHERE
  a.fqn = "javax.ws.rs.OPTIONS"
SET
  m:OptionsResourceMethod
RETURN
  m AS OptionsMethod
jaxrs:PostResourceMethod

Requires concepts:

Finds resource methods annotated with "@javax.ws.rs.POST" and labels them with 'PostResourceMethod'.

MATCH
  (m:JaxRS:ResourceMethod)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:JaxRS:RequestMethodDesignator)
WHERE
  a.fqn = "javax.ws.rs.POST"
SET
  m:PostResourceMethod
RETURN
  m AS PostMethod
jaxrs:PutResourceMethod

Requires concepts:

Finds resource methods annotated with "@javax.ws.rs.PUT" and labels them with 'PutResourceMethod'.

MATCH
  (m:JaxRS:ResourceMethod)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:JaxRS:RequestMethodDesignator)
WHERE
  a.fqn = "javax.ws.rs.PUT"
SET
  m:PutResourceMethod
RETURN
  m AS PutMethod
jaxrs:RequestMethodDesignator

Finds request method designator annotations (i.e. @GET, @POST, @PUT, @DELETE, @HEAD, @OPTIONS) and labels them with 'JaxRS' and 'RequestMethodDesignator'

MATCH
  (a:Type)
WHERE
  a.fqn IN ["javax.ws.rs.GET", "javax.ws.rs.POST", "javax.ws.rs.PUT", "javax.ws.rs.DELETE", "javax.ws.rs.HEAD", "javax.ws.rs.OPTIONS"]
SET
  a:JaxRS:RequestMethodDesignator
RETURN
  a AS RequestMethodDesignator
jaxrs:Resource

Requires concepts:

Finds classes or interfaces with atleast one method annotated with "@javax.ws.rs.Path" or with request method designator (i.e. @GET, @POST, @PUT, @DELETE, @HEAD, @OPTIONS) and labels them with 'JaxRS' and 'Resource'.

MATCH
  (t:Type)-[:DECLARES]->(m:Method)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:Type)
WHERE
  (a:JaxRS:RequestMethodDesignator OR a.fqn="javax.ws.rs.Path")
AND
  (t:Class OR t:Interface)
SET
  t:JaxRS:Resource
RETURN
  DISTINCT t AS RestResource
jaxrs:ResourceMethod

Requires concepts:

Finds methods that belong to resource class or interface and annotated with request method designator (i.e. @GET, @POST, @PUT, @DELETE, @HEAD, @OPTIONS) and labels them with 'JaxRS' and 'ResourceMethod'.

MATCH
  (c:JaxRS:Resource)-[:DECLARES]->(m:Method)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:JaxRS:RequestMethodDesignator)
SET
  m:JaxRS:ResourceMethod
RETURN
  m AS ResourceMethod
jaxrs:SubResourceLocator

Requires concepts:

Finds classes or interfaces with method annotated with "@javax.ws.rs.Path" but no request method designator and no entity parameters and labels the methods with 'JaxRS' and 'SubResourceLocator'.

MATCH
  (t:Type)-[:DECLARES]->(m:Method)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn = "javax.ws.rs.Path"
AND
  (t:Class OR t:Interface)
AND
  NOT (m)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(:JaxRS:RequestMethodDesignator)
AND
  (m)-[:HAS]->(:Parameter)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(:Type)
SET
  m:JaxRS:SubResourceLocator
RETURN
  DISTINCT m AS RestSubResourceLocator

jaxrs-provider.xml

Concepts
jaxrs:ContextProvider

Finds classes that implement "javax.ws.rs.ext.ContextResolver" and labels them with 'JaxRS' and 'ContextProvider'

MATCH
  (c:Type:Class)-[:IMPLEMENTS]->(a:Type)
WHERE
  a.fqn = "javax.ws.rs.ext.ContextResolver"
SET
  c:JaxRS:ContextProvider
RETURN
  DISTINCT c AS ContextProvider
jaxrs:EntityProvider

Finds classes that implement "javax.ws.rs.ext.MessageBodyReader" or "javax.ws.rs.ext.MessageBodyWriter" and labels them with 'JaxRS' and 'EntityProvider'

MATCH
  (c:Type:Class)-[:IMPLEMENTS]->(a:Type)
WHERE
  a.fqn IN ["javax.ws.rs.ext.MessageBodyReader", "javax.ws.rs.ext.MessageBodyWriter"]
SET
  c:JaxRS:EntityProvider
RETURN
  DISTINCT c AS EntityProvider
jaxrs:ExceptionMappingProvider

Finds classes that implement "javax.ws.rs.ext.ExceptionMapper" and labels them with 'JaxRS' and 'ExceptionMappingProvider'

MATCH
  (c:Type:Class)-[:IMPLEMENTS]->(a:Type)
WHERE
  a.fqn = "javax.ws.rs.ext.ExceptionMapper"
SET
  c:JaxRS:ExceptionMappingProvider
RETURN
  DISTINCT c AS ExceptionMappingProvider

Java

Provides scanner for Java elements (e.g. packages, classes, manifest and property files) and rules for common language concepts (e.g. Deprecation), dependencies and metrics.

Artifact Scanner

:Java:Artifact

A directory or archive containing packages, classes and resources.

Table 4. Properties of :Java:Artifact
Name Description

fqn

Fully qualified name, e.g. 'java.lang'

fileName

The file name of the artifact.

Table 5. Relations of :Java:Artifact
Name Target label(s) Cardinality Description

CONTAINS

[:File]

0..n

References contained files, e.g. packages, classes or resources

REQUIRES

:Java:Type

0..n

References a type which is required by a class in this artifact

:Java:Artifact:Directory

A directory representing a Java artifact.

:Java:Artifact:Jar:Archive:Container

A JAR file representing a Java artifact.

Package Scanner

Imports Java packages.

:Java:Package:Container

A Java package, i.e. a directory containing '.class' files or other directories.

Table 6. Properties of :Java:Package:Container
Name Description

fqn

Fully qualified name, e.g. 'java.lang'

name

The local name, e.g. 'lang'

Table 7. Relations of :Java:Package:Container
Name Target label(s) Cardinality Description

CONTAINS

:Java:Type

0..n

References a type located in the package

CONTAINS

:Java:Package:Container

0..n

References a package located in the package

Class Scanner

Imports Java classes, i.e. all scanned files having a '.class' suffix. Nodes with following labels will be created:

NOTE Some of these labels may be further qualified with other labels, see the description below.

NOTE The full set of information is only available for class files which have actually been scanned. Types which are only referenced (i.e. from external libraries not included in the scan) are represented by ':TYPE' nodes with a property 'fqn' and 'DECLARES' relations to their members. These are ':FIELD' or ':METHOD' labeled nodes which only provide the property 'signature'.

Configuration
Table 8. Configuration properties
Property Description Default

java.class.model.Type.DEPENDS_ON.weight

Enables/disables calculation of the weight attribute for DEPENDS_ON relations between types

true

:Java:Type

A Java type. Can be qualified by either ':Class', ':Interface', ':Enum' or ':Annotation'

Table 9. Properties of :Java:Type
Name Description

fqn

Fully qualified name, e.g. 'java.lang.Object'

name

The local name, e.g. 'Object'

sourceFileName

The name of the source file, e.g. 'Object.java' (optional).

visibility

optional, the visibility of the type, can be either 'public', 'protected', 'default' or 'private'

abstract

optional, 'true' indicates that the type is abstract, e.g. 'public abstract class …​'

static

optional, 'true' indicates that the type has the static modifier, e.g. 'private static class …​'

final

optional, 'true' indicates that the type is final, e.g. 'public final class…​'

synthetic

optional, 'true' indicates that the type is synthetic, i.e. it has been generated

byteCodeVersion

The byte code version of the class file, e.g. 52 for "Java SE 8"

md5

The MD5 hash sum of the class file.

valid

true if the class file could be scanned successfully.

Table 10. Relations of :Java:Type
Name Target label(s) Cardinality Description

DECLARES

:Java:Type

0..n

Declares an inner type of the type

DECLARES

:Java:Method

0..n

Declares a method of the type

DECLARES

:Java:Field

0..n

Declares a field of the type

EXTENDS

:Java:Type

0..1

References a type this type extends from

IMPLEMENTS

:Java:Type

0..1

References an "Interface" type this type implements

ANNOTATED_BY

:Java:Value:Annotation

0..n

References an annotation which is present on the type

DEPENDS_ON

:Java:Type

0..n

References a type which this type depends on (i.e. every reference to another class)

NOTE Types which are referenced by scanned classes but have not been scanned themselves will only provide the property "fqn" and the relation "DECLARES".

NOTE Inheritance between interfaces (i.e. "public interface A extends B { …​ }") is represented using IMPLEMENTS relations, i.e. queries must use (a:Type:Interface)-[:IMPLEMENTS]→(b:Type:Interface) for pattern matching.

Table 11. Properties of :DEPENDS_ON
Name Description

weight

The weight of the dependency, i.e. the count of occurrences of the referenced type

Table 12. Properties of :READS, :WRITES and :INVOKES
Name Description

lineNumber

The line number the referenced field or method is read, written or invoked

:Java:Type:Class

Qualifies a Java type as class.

:Java:Type:Interface

Qualifies a Java type node as interface.

:Java:Type:Enum

Qualifies a Java type as enumeration.

:Java:Type:Annotation

Qualifies a Java type as annotation.

:Java:Field

A field declared in a Java type.

Table 13. Properties of :Java:Field
Name Description

name

The field name, e.g. 'id'

signature

The raw signature of the field, e.g. 'int id', 'java.lang.String toString()'

visibility

optional, The visibility of the field, can be either 'public', 'protected', 'default' or 'private'

static

optional, 'true' indicates that the field has the static modifier, e.g. 'static int id;'

final

optional, 'true' indicates that the field is final, e.g. 'final int id;'

transient

optional, 'true' indicates that the field is transient, e.g. 'transient int id;'

volatile

optional, 'true' indicates that the field is volatile, e.g. 'volatile int id;'

synthetic

optional, 'true' indicates that the field is synthetic, i.e. it has been generated

Table 14. Relations of :Java:Field
Name Target label(s) Cardinality Description

OF_TYPE

:Java:Type

1

References the type of the field

ANNOTATED_BY

:Java:Value:Annotation

0..n

References an annotation which is present on the field

HAS

:Java:Value

0..1

References the primitive value which is used for initializing the field

NOTE Fields which are referenced by scanned classes but have not been scanned themselves will only provide the property "signature".

:Java:Method

A method declared in a Java type.

Table 15. Properties of :Java:Method
Name Description

name

The method name, e.g. 'getId'

signature

The raw signature of the method, e.g. 'int getId()', 'java.lang.String concat(java.lang.String,java.lang.String)'

visibility

optional, The visibility of the method, can be either 'public', 'protected', 'default' or 'private'

static

optional, 'true' indicates that the method has the static modifier, e.g. 'static int getId();'

final

optional, 'true' indicates that the method is final, e.g. 'final int getId();'

native

optional, 'true' indicates that the method is native, e.g. 'native int getId();'

synthetic

optional, 'true' indicates that the method is synthetic, i.e. it has been generated

cyclomaticComplexity

The cyclomatic complexity of the method

Table 16. Relations of :Java:Method
Name Target label(s) Cardinality Description

HAS

:Java:Parameter

0..n

References a parameter of the method

THROWS

:Java:Type

0..n

References the exception type thrown by the method

RETURNS

:Java:Type

0..n

References the return type of the method

ANNOTATED_BY

:Java:Value:Annotation

0..n

References an annotation which is present on the method declaration

READS

:Java:Field

0..n

References a field which is read by the method

WRITES

:Java:Field

0..n

References a field which is written by the method

INVOKES

:Java:Method

0..n

References a method which is invoked by the method

NOTE Methods which are referenced by scanned classes but have not been scanned themselves will only provide the property "signature".

:Java:Method:Constructor

Qualifies a method as constructor.

:Java:Parameter

A method parameter.

Table 17. Properties of :Java:Parameter
Name Description

index

The index of the parameter according to the method signature (starting with 0)

Table 18. Properties of :Java:Parameter
Name Target label(s) Cardinality Description

OF_TYPE

:Java:Type

1

References the type of the parameter

ANNOTATED_BY

:Java:Value:Annotation

0..n

References an annotation which is present on the parameter

:Java:Value

A value, can be qualified by either ':Primitive', ':Annotation', ':Class', ':Enum' or ':Array'.

Table 19. Properties of :Java:Value
Name Description

name

The method name, e.g. 'value'

:Value:Primitive

A primitive value.

Table 20. Properties of :Java:Value:Primitive
Name Description

value

The value

:Java:Value:Annotation

Represents a annotation on a Java element, e.g. '@Entity public class …​'

Table 21. Relations of :Java:Value:Annotation:
Name Target label(s) Cardinality Description

OF_TYPE

:Java:Type

1

References the type of the annotation

HAS

:Java:Value

0..n

References an attribute of the annotation, e.g. '@Entity(name="MyEntity")'

:Java:Value:Class

Represents a class instance, e.g. as specified by annotation attribute.

Table 22. Relations of :Java:Value:Class:
Name Target label(s) Cardinality Description

IS

:Java:Type

1

References the type

:Java:Value:Enum

Represents an enum value.

Table 23. Relations of :Java:Value:Enum:
Name Target label(s) Cardinality Description

IS

:Java:Field

1

References the field representing the enumeration value

:Java:Value:Array

Represents an array value, i.e. a node referencing value nodes.

Table 24. Relations of :Java:Value:Array:
Name Target label(s) Cardinality Description

CONTAINS

:Java:Value

0..n

References a value contained in the array

Manifest File Scanner

Imports manifest descriptors from META-INF/MANIFEST.MF files.

:File:Java:Manifest

A MANIFEST.MF file containing sections.

Table 25. Properties of :File:Java:Manifest
Name Description

fileName

The file name

Table 26. Relations of :File:Java:Manifest
Name Target label(s) Cardinality Description

DECLARES

:Java:ManifestSection

0..n

References a manifest section

:Java:ManifestSection

A manifest section.

Table 27. Relations of :Java:ManifestSection
Name Target label(s) Cardinality Description

HAS

:Java:Value:ManifestEntry

0..n

References a manifest entry in the section

:Java:Value:ManifestEntry

A manifest entry.

Table 28. Properties of :Java:Value:ManifestEntry
Name Description

name

The name of the entry, e.g. 'Main-Class'

value

The value of the entry, e.g. 'com.buschmais.jqassistant.scm.cli.Main'

Property File Scanner

Imports property files, i.e. all files having a suffix '.properties'.

:File:Properties

A property file containing key/value pairs.

Table 29. Properties of :File:Java:Properties
Name Description

fileName

The file name

Table 30. Relations of :File:Java:Properties
Name Target label(s) Cardinality Description

HAS

:Java:Value:Property

0..n

References a property value

:Java:Value:Property

A key value/pair.

Table 31. Properties of :Java:Value:Property
Name Description

name

The name of the property

value

The value of the property

Service Loader File Scanner

Imports service loader descriptors from "META-INF/services" directories.

:File:Java:ServiceLoader

A file containing the implementation class names for a service interface

Table 32. Properties of :File:Java:ServiceLoader
Name Description

fileName

The file name

Table 33. Relations of :File:Java:ServiceLoader
Name Target label(s) Cardinality Description

OF_TYPE

:Java:Type

1

The type representing the service interface

CONTAINS

:Java:Type

0..n

References a type which implements the service interface

Refer to the plugin Javadoc for details about the model.

java.xml

Concepts
java:AnonymousInnerType

Requires concepts:

Sets a label "Anonymous" on anonymous inner types, i.e. types without a name.

MATCH
  (innerType:Inner:Type)
WHERE
  innerType.name =~ ".*\\$[0-9]*"
SET
  innerType:Anonymous
RETURN
  innerType AS AnonymousInnerType
java:Deprecated

Labels all nodes representing deprecated elements (types, fields, methods, packages or parameters) with "Deprecated".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(dt:Type)
WHERE
  dt.fqn='java.lang.Deprecated'
SET
  e:Deprecated
RETURN
  e AS DeprecatedElement
java:Error

Labels types deriving from java.lang.Error as "Error".

MATCH
  (throwable)-[:EXTENDS*]->(t:Type)
WHERE
  t.fqn = 'java.lang.Error'
SET
  throwable:Error
RETURN
  throwable AS Error
java:Exception

Labels types deriving from java.lang.Exception as "Exception".

MATCH
  (exception)-[:EXTENDS*]->(t:Type)
WHERE
  t.fqn = 'java.lang.Exception'
SET
  exception:Exception
RETURN
  exception AS Exception
java:InnerType

Sets a label "Inner" on inner types.

MATCH
  (:Type)-[:DECLARES]->(innerType:Type)
SET
  innerType:Inner
RETURN
  innerType AS InnerType
java:InvokesOverriddenMethod

Requires concepts:

Propagates INVOKES relationships to methods which implement or override the invoked method.

MATCH
  (method:Method)-[invocation:INVOKES]->(invokedMethod:Method),
  (overridingMethod:Method)-[:OVERRIDES]->(invokedMethod)
MERGE
  (method)-[r:INVOKES{lineNumber:invocation.lineNumber}]->(overridingMethod)
RETURN count(r) AS OverridingInvocations
java:JavaVersion

Set a human readable property "javaVersion" on a class file based on its byte code version.

MATCH
  (type:Type:File)
SET
  type.javaVersion=
  CASE type.byteCodeVersion
    WHEN 52 THEN "Java 8"
    WHEN 51 THEN "Java 7"
    WHEN 50 THEN "Java 6"
    WHEN 49 THEN "Java 5"
    WHEN 48 THEN "Java 1.4"
    WHEN 47 THEN "Java 1.3"
    WHEN 46 THEN "Java 1.2"
    WHEN 45 THEN "Java 1.1/1.0"
  END
RETURN
  count(type) as Types
java:MethodOverloads

Creates a relationship OVERLOADS between two "Method" labeled nodes if one method overloads another one from the same type (i.e. the methods have the same name but not the same signature).

MATCH
  (type:Type)-[:DECLARES]->(method:Method),
  (type)-[:DECLARES]->(otherMethod:Method)
WHERE
  method <> otherMethod
  AND method.name = otherMethod.name
  AND method.signature <> otherMethod.signature
MERGE
  (method)-[:OVERLOADS]->(otherMethod)
RETURN method AS OverloadedMethod, type AS DeclaringType
java:MethodOverrides

Requires concepts:

Creates a relationship OVERRIDES between two "Method" labeled nodes if one method overrides another one from a super type (i.e. the methods have the same signature).

MATCH
  (type:Type)-[:DECLARES]->(method:Method),
  (superType:Type)-[:DECLARES]->(otherMethod:Method),
  (superType)-[:ASSIGNABLE_FROM]->(type)
WHERE
  method.name = otherMethod.name
  AND method.signature = otherMethod.signature
  AND method.visibility <> 'private'
MERGE
  (method)-[:OVERRIDES]->(otherMethod)
RETURN method AS OverriddenMethod, type AS DeclaringType, superType AS SuperType
java:RuntimeException

Labels types deriving from java.lang.RuntimeException as "RuntimeException".

MATCH
  (runtimeException)-[:EXTENDS*]->(t:Type)
WHERE
  t.fqn = 'java.lang.RuntimeException'
SET
  runtimeException:RuntimeException
RETURN
  runtimeException AS RuntimeException
java:Throwable

Labels types deriving from java.lang.Throwable as "Throwable".

MATCH
  (throwable)-[:EXTENDS*]->(t:Type)
WHERE
  t.fqn = 'java.lang.Throwable'
SET
  throwable:Throwable
RETURN
  throwable AS Throwable
java:TypeAssignableFrom

Creates a relationship ASSIGNABLE_FROM between two "Type" labeled nodes if one type is assignable from the other (i.e. a super class or interface).

MATCH
  (type:Type)
MERGE
  (type)-[:ASSIGNABLE_FROM]->(type)
WITH
  type
MATCH
  (type)-[:IMPLEMENTS|EXTENDS*]->(superType:Type)
MERGE
  (superType)-[:ASSIGNABLE_FROM]->(type)
RETURN type AS AssignableType, superType AS AssignableFrom

dependency.xml

Concepts
dependency:Artifact

Creates a new DEPENDS_ON relationship between artifacts or updates an existing one with a 'used' property if there are type dependencies between them, i.e. if an artifact contains a type with a fully qualified name which a type from another artifact requires.

MATCH
  (a1:Artifact)-[:CONTAINS]->(:Type)-[:DEPENDS_ON]->(type:Type)
WITH
  a1,type.fqn as fqn
MATCH
  (a2:Artifact)-[:CONTAINS]->(t2:Type)
WHERE
  a1 <> a2
  and t2.fqn = fqn
MERGE
  (a1)-[d:DEPENDS_ON]->(a2)
SET
  d.used=true
RETURN
  a1 AS Artifact, COLLECT(DISTINCT a2.fqn) AS Dependencies
dependency:Package

Creates a DEPENDS_ON relationship between a packages if there are type dependencies between them.

MATCH
    (p1:Package)-[:CONTAINS]->(t1:Type)-[:DEPENDS_ON]->(t2:Type)<-[:CONTAINS]-(p2:Package)
WHERE
    p1<>p2
CREATE UNIQUE
    (p1)-[:DEPENDS_ON]->(p2)
RETURN
    p1 AS package, COUNT(DISTINCT p2) AS PackageDependencies
Constraints
dependency:ArtifactCycles

Requires concepts:

There must be no cyclic artifact dependencies.

MATCH
    (a1:Artifact)-[:DEPENDS_ON]->(a2:Artifact),
    path=shortestPath((a2)-[:DEPENDS_ON*]->(a1))
WHERE
    a1<>a2
RETURN
    a1 AS Artifact, EXTRACT(a IN nodes(path) | a.fqn) AS Cycle
ORDER BY
    Artifact.fqn
dependency:PackageCycles

Requires concepts:

There must be no cyclic package dependencies.

MATCH
    (p1:Package)-[:DEPENDS_ON]->(p2:Package),
    path=shortestPath((p2)-[:DEPENDS_ON*]->(p1))
WHERE
    p1<>p2
RETURN
    p1 AS Package, EXTRACT(p IN nodes(path) | p.fqn) AS Cycle
ORDER BY
    Package.fqn

classpath.xml

Concepts
classpath:Resolve

Requires concepts:

Includes all concepts for resolving a Java classpath and returns the number of resolved elements.

MATCH
  ()-[r:RESOLVES_TO]->()
RETURN
  count(r) as ResolvedElements
classpath:ResolveAnnotationType

Requires concepts:

Propagates "OF_TYPE" relations between annotation and types to their resolved types with a property "resolved:true".

MATCH
  (a:Annotation)-[:OF_TYPE]->(:Type)-[:RESOLVES_TO]->(t:Type)
MERGE
  (a)-[:OF_TYPE{resolved:true}]->(t)
RETURN
  count(t) as ResolvedAnnotationTypes
classpath:ResolveDependency

Requires concepts:

Propagates "DEPENDS_ON" relations between types to their resolved types with a property "resolved:true".

MATCH
  (t:Type)-[:DEPENDS_ON]->(t1:Type)-[:RESOLVES_TO]->(t2:Type)
MERGE
  (t)-[:DEPENDS_ON{resolved:true}]->(t2)
RETURN
  count(t) as ResolvedDependencies
classpath:ResolveExtends

Requires concepts:

Propagates "EXTENDS" relations between types to their resolved types with a property "resolved:true".

MATCH
  (t:Type)-[:EXTENDS]->(t1:Type)-[:RESOLVES_TO]->(t2:Type)
MERGE
  (t)-[:EXTENDS{resolved:true}]->(t2)
RETURN
  count(t) as ResolvedSuperClass
classpath:ResolveFieldType

Requires concepts:

Propagates "OF_TYPE" relations between fields and types to their resolved types with a property "resolved:true".

MATCH
  (f:Field)-[:OF_TYPE]->(:Type)-[:RESOLVES_TO]->(t:Type)
MERGE
  (f)-[:OF_TYPE{resolved:true}]->(t)
RETURN
  count(t) as ResolvedFieldTypes
classpath:ResolveImplements

Requires concepts:

Propagates "IMPLEMENTS" relations between types to their resolved types with a property "resolved:true".

MATCH
  (t:Type)-[:IMPLEMENTS]->(t1:Type)-[:RESOLVES_TO]->(t2:Type)
MERGE
  (t)-[:IMPLEMENTS{resolved:true}]->(t2)
RETURN
  count(t1) as ResolvedInterfaces
classpath:ResolveInvokes

Requires concepts:

Propagates "INVOKES" relations between methods to their resolved methods with a property "resolved:true".

MATCH
  (m:Method)-[i:INVOKES]->(m1:Method)-[:RESOLVES_TO]->(m2:Method)
MERGE
  (m)-[:INVOKES{lineNumber:i.lineNumber,resolved:true}]->(m2)
RETURN
  count(i) as ResolvedInvocations
classpath:ResolveMember

Requires concepts:

Adds a relation "RESOLVES_TO" from a member (i.e. field or method) of a type to a member of another type if there is a relation "RESOLVES_TO" between the two types and the members have the same signature.

MATCH
  (t1:Type)-[:RESOLVES_TO]->(t2:Type),
  (t1)-[:DECLARES]->(m1),
  (t2)-[:DECLARES]->(m2)
WHERE
  (m1:Field or m1:Method)
  and m1.signature = m2.signature
MERGE
  (m1)-[:RESOLVES_TO{resolved:true}]->(m2)
RETURN
  count(m1) as ResolvedMembers
classpath:ResolveParameterType

Requires concepts:

Propagates "OF_TYPE" relations between method parameters and types to their resolved types with a property "resolved:true".

MATCH
  (m:Parameter)-[:OF_TYPE]->(:Type)-[:RESOLVES_TO]->(t:Type)
MERGE
  (m)-[:OF_TYPE{resolved:true}]->(t)
RETURN
  count(t) as ResolvedParameterTypes
classpath:ResolveReads

Requires concepts:

Propagates "READS" relations between methods and fields to their resolved fields with a property "resolved:true".

MATCH
  (m:Method)-[r:READS]->(f1:Field)-[:RESOLVES_TO]->(f2:Field)
MERGE
  (m)-[:READS{lineNumber:r.lineNumber,resolved:true}]->(f2)
RETURN
  count(r) as ResolvedReads
classpath:ResolveReturns

Requires concepts:

Propagates "RETURNS" relations between methods and types to their resolved types with a property "resolved:true".

MATCH
  (m:Method)-[:RETURNS]->(:Type)-[:RESOLVES_TO]->(t:Type)
MERGE
  (m)-[:RETURNS{resolved:true}]->(t)
RETURN
  count(t) as ResolvedReturnTypes
classpath:ResolveThrows

Requires concepts:

Propagates "THROWS" relations between methods and types to their resolved types with a property "resolved:true".

MATCH
  (m:Method)-[:THROWS]->(:Type)-[:RESOLVES_TO]->(t:Type)
MERGE
  (m)-[:THROWS{resolved:true}]->(t)
RETURN
  count(t) as ResolvedExceptionTypes
classpath:ResolveType

Adds a relation "RESOLVES_TO" from a type required by an artifact to a type contained in another artifact if their fully qualified names match.

MATCH
  (a1:Artifact)-[:REQUIRES]->(t1:Type)
WITH
  a1, t1, t1.fqn as fqn
MATCH
  (a2:Artifact)-[:CONTAINS]->(t2:Type)
WHERE
  t2.fqn=t1.fqn
MERGE
  (t1)-[:RESOLVES_TO]->(t2)
RETURN
  count(t1) as ResolvedTypes
classpath:ResolveValue

Requires concepts:

Propagates "IS" relations between values and types to their resolved types with a property "resolved:true".

MATCH
  (v:Value)-[:IS]->(e)-[:RESOLVES_TO]->(e2)
MERGE
  (v)-[:IS{resolved:true}]->(e2)
RETURN
  count(v) as ResolvedValueTypes
classpath:ResolveWrites

Requires concepts:

Propagates "WRITES" relations between methods and fields to their resolved fields with a property "resolved:true".

MATCH
  (m:Method)-[w:WRITES]->(f1:Field)-[:RESOLVES_TO]->(f2:Field)
MERGE
  (m)-[:WRITES{lineNumber:w.lineNumber,resolved:true}]->(f2)
RETURN
  count(w) as ResolvedWrites

metric.xml

Concepts
metric:Top10FieldsPerType

Returns the top 10 types regarding to the number of declared fields.

MATCH
    (t:Type:File)-[:DECLARES]->(f:Field)
RETURN
    t.fqn as Type, COUNT(f) as FieldCount
ORDER BY
    FieldCount DESC
LIMIT 10
metric:Top10MethodsPerType

Returns the top 10 types regarding to the number of declared methods (including constructors).

MATCH
    (t:Type:File)-[:DECLARES]->(m:Method)
RETURN
    t.fqn as Type, COUNT(m) as MethodCount
ORDER BY
    MethodCount DESC
LIMIT 10
metric:Top10TypeFanIn

Returns the top 10 types regarding the number of other types depending on them.

MATCH
    (t:Type:File)<-[:DEPENDS_ON]-(dependent:Type)
RETURN
    t.fqn as Type, COUNT(dependent) as Dependents
ORDER BY
    Dependents DESC
LIMIT 10
metric:Top10TypeFanOut

Returns the top 10 types regarding the number of other types they depend on.

MATCH
    (t:Type:File)-[:DEPENDS_ON]->(dependency:Type)
RETURN
    t.fqn as Type, COUNT(dependency) as Dependencies
ORDER BY
    Dependencies DESC
LIMIT 10
metric:Top10TypesPerArtifact

Returns the top 10 artifacts regarding the number of contained types.

MATCH
    (a:Artifact:File)-[:CONTAINS]->(t:Type:File)
RETURN
    a.fqn as Artifact, COUNT(t) as Types
ORDER BY
    Types DESC
LIMIT 10
metric:Top10TypesPerPackage

Returns the top 10 packages regarding the number of contained types.

MATCH
    (p:Package:File)-[:CONTAINS]->(t:Type:File)
RETURN
    p.fqn as Package, COUNT(t) as Types
ORDER BY
    Types DESC
LIMIT 10

Java 8

Provides Java 8 specific rules, e.g. concepts for functional interfaces and default methods.

java8.xml

Concepts
java8:DefaultMethod

Labels default methods of interfaces with "Default".

MATCH
  (type:Type:Interface)-[:DECLARES]->(defaultMethod:Method)
WHERE NOT
  has(defaultMethod.abstract)
SET
  defaultMethod:Default
RETURN
  defaultMethod AS DefaultMethod, type AS Interface
java8:FunctionalInterface

Labels functional interfaces (i.e. to be used as lambda expressions) with "FunctionalInterface".

MATCH
  (functionalInterface:Interface)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(functionalInterfaceType)
WHERE
  functionalInterfaceType.fqn = 'java.lang.FunctionalInterface'
SET
  functionalInterface:FunctionalInterface
RETURN
  functionalInterface AS FunctionalInterface

JPA 2

Provides a scanner for persistence.xml descriptors and rules for JPA2 specific elements (e.g. entities).

Scanner for persistence.xml files

Imports persistence descriptors from META-INF/persistence.xml or WEB-INF/persistence.xml files.

:File:Jpa:Persistence

A persistence.xml file containing persistence units.

Table 34. Properties of :File:Jpa:Persistence
Name Description

fileName

The file name

version

The version of the JPA specification this descriptor represents, e.g. '2.0'

Table 35. Relations of :File:Jpa:Persistence
Name Target label(s) Cardinality Description

CONTAINS

:Jpa:PersistenceUnit

0..n

References a contained persistence unit

:Jpa:PersistenceUnit

A persistence unit.

Table 36. Properties of :Jpa:PersistenceUnit
Name Description

description

The description of the persistence unit.

transactionType

The transaction type, can be 'RESOURCE_LOCAL' or 'JTA'

provider

The class name of the JPA provider.

jtaDatasource

The JNDI name of the transactional datasource

nonJtaDatasource

The JNDI name of the non-transactional datasource

validationMode

The validation mode, can be 'NONE', 'CALLBACK' or 'AUTO'

sharedCacheMode

The shared cache mode, e.g. 'NONE'

Table 37. Relations of :Jpa:PersistenceUnit
Name Target label(s) Cardinality Description

CONTAINS

:Java:Type

0..n

References a persistent type (entity) contained in the persistence unit

HAS

[:Value:Property]

0..n

References a property of the persistence unit

Refer to the plugin Javadoc for details about the model.

jpa2.xml

Concepts
jpa2:Embeddable

Labels all types annotated with @javax.persistence.Embeddable with "Jpa" and "Embeddable".

MATCH
  (t:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="javax.persistence.Embeddable"
SET
  t:Jpa:Embeddable
RETURN
  t AS JpaEmbeddable
jpa2:Embedded

Labels all fields or methods annotated with @javax.persistence.Embedded with "Jpa" and "Embedded".

MATCH
  (t:Type)-[:DECLARES]->(member),
  (member)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  (member:Field or member:Method)
  and a.fqn="javax.persistence.Embedded"
SET
  member:Jpa:Embedded
RETURN
  member AS JpaEmbedded
jpa2:EmbeddedId

Labels all fields or methods annotated with @javax.persistence.EmbeddedId with "Jpa" and "Embedded".

MATCH
  (t:Type)-[:DECLARES]->(member),
  (member)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  (member:Field or member:Method)
  and a.fqn="javax.persistence.EmbeddedId"
SET
  member:Jpa:EmbeddedId
RETURN
  member AS EmbeddedId
jpa2:Entity

Labels all types annotated with @javax.persistence.Entity with "Jpa" and "Entity".

MATCH
  (t:Type)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="javax.persistence.Entity"
SET
  t:Jpa:Entity
RETURN
  t AS JpaEntity
jpa2:NamedQuery

Requires concepts:

Creates a node labeled with "Jpa" and "NamedQuery" for each @NamedQuery defined for an entity. Furthermore a relation DEFINES is created between the entity and the named query.

MATCH
  (entity:Jpa:Entity),
  (entity)-[:ANNOTATED_BY]->(namedQueries:Annotation)-[:OF_TYPE]-(:Type{fqn:'javax.persistence.NamedQueries'}),
  (namedQueries)-[:HAS]->(:Value:Array)-[:CONTAINS]->(namedQuery),
  (namedQuery)-[:OF_TYPE]->(:Type{fqn:'javax.persistence.NamedQuery'}),
  (namedQuery)-[:HAS]->(nameAttribute:Value{name:'name'}),
  (namedQuery)-[:HAS]->(queryAttribute:Value{name:'query'})
MERGE
  (entity)-[:DEFINES]->(n:Jpa:NamedQuery {name:nameAttribute.value, query:queryAttribute.value})
RETURN
  entity as Entity, n.name as Name, n.query as Query
UNION ALL
MATCH
  (entity)-[:ANNOTATED_BY]->(namedQuery:Annotation),
  (namedQuery)-[:OF_TYPE]->(:Type{fqn:'javax.persistence.NamedQuery'}),
  (namedQuery)-[:HAS]->(nameAttribute:Value{name:'name'}),
  (namedQuery)-[:HAS]->(queryAttribute:Value{name:'query'})
MERGE
  (entity)-[:DEFINES]->(n:Jpa:NamedQuery {name:nameAttribute.value, query:queryAttribute.value})
RETURN
  entity as Entity, n.name as Name, n.query as Query
Constraints
jpa2:ValidationModeMustBeExplicitlySpecified

The validation mode of all persistence units must be explicitly specified and either set to CALLBACK or NONE.

MATCH
  (pu:PersistenceUnit)
WHERE
  not has(pu.validationMode)
  OR NOT (
    pu.validationMode='CALLBACK'
    OR pu.validationMode='NONE'
  )
RETURN
  pu AS PersistenceUnit

Java EE 6

Aggregates plugins providing scanners and rules for Java EE 6 technologies (e.g. JPA2, EJB3).

Scanner for EAR files

Imports EAR (Enterprise ARchive) files.

:File:Enterprise:Application:Archive:Container

A file representing an EAR file.

Table 38. Properties of :File:Enterprise:Application:Archive:Container
Name Description

fileName

The file name

Table 39. Relations of :File:Enterprise:Application:Archive:Container
Name Target label(s) Cardinality Description

CONTAINS

[:File]

0..n

References the files contained in the archive.

:File:Enterprise:Application:Xml

Represents a Java EE application.xml descriptor.

Table 40. Properties of :File:Enterprise:Application:Xml
Name Description

fileName

The file name

initializeInOrder

If initialize-in-order is true, modules must be initialized in the order they’re listed in the deployment descriptor

libraryDirectory

The path to the library directory.

Table 41. Relations of :File:Enterprise:Application:Xml
Name Target label(s) Cardinality Description

HAS_DESCRIPTION

:Description

0..n

References a description of this descriptor.

HAS_DISPLAY_NAME

:DisplayName

0..n

References a display name of this descriptor.

HAS_ICON

:Icon

0..n

References an icon of this descriptor.

HAS_MODULE

:Enterprise:Application:Module

1..n

References a module specified by this descriptor.

HAS_SECURITY_ROLE

:SecurityRole

0..n

References a security role defined by this descriptor.

:Enterprise:Application:Module

Represents a declared module of a Java EE Java application. Can be qualified by either :Ejb, :Web, :Connector or :JavaClient.

Table 42. Properties of :Enterprise:Application:Module
Name Description

path

The path to the module archive within the enterprise application archive.

:Enterprise:Application:Module:Web

Represents a declared web module of a Java EE Java application.

Table 43. Properties of :Enterprise:Application:Module:Web
Name Description

contextRoot

The context root path to use for the web module.

Scanner for WAR files

Imports WAR (Web Application Archive) files.

:File:Web:Application:Archive:Container

A file representing WAR file.

Table 44. Properties of :File:Web:Application:Archive:Container
Name Description

fileName

The file name

Table 45. Relations of :File:Web:Application:Archive:Container
Name Target label(s) Cardinality Description

CONTAINS

[:File]

0..n

References the files contained in the archive.

:File:Web:Xml

Represents a web application descriptor.

Table 46. Relations of :File:Web:Xml
Name Target label(s) Cardinality Description

HAS_SESSION_CONFIG

:SessionConfig

0..1

References the session configuration.

HAS_SERVLET

:Servlet

0..n

References a servlet declaration.

HAS_SERVLET_MAPPING

ServletMapping

0..n

References a servlet mapping declaration.

HAS_FILTER

Filter

0..n

References a filter declaration.

HAS_FILTER_MAPPING

FilterMapping

0..n

References a filter mapping declaration.

HAS_LISTENER

Listener

0..n

References a listener declaration.

HAS_CONTEXT_PARAM

[.ParamValue]

0..n

References a context parameter declaration.

HAS_ERROR_PAGE

ErrorPage

0..n

References an error page declaration.

HAS_SECURITY_CONSTRAINT

SecurityConstraint

0..n

References a security constraint declaration.

HAS_SECURITY_ROLE

:SecurityRole

0..n

References a security role declaration.

HAS_LOGIN_CONFIG

LoginConfig

0..n

References a login configuration.

:SessionConfig

Represents a session configuration.

Table 47. Properties of :SessionConfig
Name Description

sessionTimeout

The session timeout.

:Servlet

Represents a servlet declaration.

Table 48. Properties of :Servlet
Name Description

enabled

Indicates if this servlet is enabled.

jspFile

The JSP file representing the servlet.

loadOnStartup

Indicates whether the servlet will be loaded on startup.

Table 49. Relations of :Servlet
Name Target label(s) Cardinality Description

HAS_DESCRIPTION

:Description

0..n

References a description of this descriptor.

HAS_DISPLAY_NAME

:DisplayName

0..n

References a display name of this descriptor.

HAS_ICON

:Icon

0..n

References an icon of this descriptor.

HAS_INIT_PARAM

[:ParamValue]

0..n

References a init parameter.

Scanner for JSF-template files

Imports JSF template files (e.g. *.jspx) and builds references between them (template/includes).

Configuration
Table 50. Configuration properties
Property Description Default

facelet.file.pattern

Regular expression that describes scanable JSF template files.

.*\\.jspx

:File:Jsf:Facelet

A JSF template file.

Table 51. Properties of :File:Jsf:Facelet
Name Description

fileName

The file name

Table 52. Relations of :File:Jsf:Facelet
Name Target label(s) Cardinality Description

INCLUDES

:File:Jsf:Facelet

0..n

References a included JSF template file (e.g. <ui:include src="include.jspx"/>)

WITH_TEMPLATE

:File:Jsf:Facelet

0..1

References a used JSF template file (e.g. <ui:composition template="template.jspx" …​>)

:Description

Represents an internationalized description.

Table 53. Properties of :Description
Name Description

lang

The language, e.g. "en"

value

The description.

:DisplayName

Represents an internationalized display name.

Table 54. Properties of :DisplayName
Name Description

lang

The language, e.g. "en"

value

The description.

:Icon

Represents an icon.

Table 55. Properties of :Icon
Name Description

smallIcon

The file name of the small icon, e.g. "smallIcon.png".

largeIcon

The file name of the large icon, e.g. "largeIcon.png".

:SecurityRole

Represents a security role.

Table 56. Relations of :SecurityRole
Name Target label(s) Cardinality Description

HAS_DESCRIPTION

:Description

0..n

References a description of this security role.

HAS_ROLE_NAME

:Description

1

References the role name.

:RoleName

Represents a role name.

Table 57. Properties of :RoleName
Name Description

name

The name of the role.

Refer to the plugin Javadoc for details about the model.

JUnit

Provides scanner for JUnit test reports and rules (e.g. for test classes/methods and ignored tests).

Scanner for JUnit4 test suite results

Imports results from JUnit4 test suites matching the file name 'TEST-.xml'.

:File:JUnit:TestSuite

A file containing results of a JUnit4 test suite.

Table 58. Properties of :File:JUnit:TestSuite
Name Description

fileName

The file name

name

The name of the test suite, e.g. the name of the class defining the suite

tests

The number of executed tests

failures

The number of failed tests

errors

The number of tests in error

skipped

The number of skipped tests

time

The time it took to run the suite

Table 59. Relations of :File:JUnit:TestSuite
Name Target label(s) Cardinality Description

CONTAINS

:JUnit:TestCase

0..n

References test cases

:JUnit:TestCase

A test case.

Table 60. Properties of :JUnit:TestCase
Name Description

name

The name of the test, e.g. the name of the test method

className

The name of the class containing the test

time

The time it took to run the test

result

The result of the test, either 'SUCCESS', 'FAILURE', 'ERROR' or 'SKIPPED'

Table 61. Relations of :JUnit:TestCase
Name Target label(s) Cardinality Description

HAS_FAILURE

:JUnit:Failure

0..1

References failure details

HAS_ERROR

:JUnit:Error

0..1

References error details

:JUnit:Failure

Provides detail information about a test case with result "FAILURE".

Table 62. Properties of :JUnit:Failure
Name Description

type

The failure type, e.g. "java.lang.AssertionError"

details

Detail information, e.g. the stack trace.

:JUnit:Error

Provides detail information about a test case with result "ERROR".

Table 63. Properties of :JUnit:Error
Name Description

type

The error type, e.g. "java.lang.RuntimeException"

details

Detail information, e.g. the stack trace.

Refer to the plugin Javadoc for details about the model.

junit3.xml

Concepts
junit3:SetUpMethod

Requires concepts:

Labels all setUp methods declared by a test class with "SetUp" and "Junit3".

MATCH
  (c:Class:Test:Junit3)-[:DECLARES]->(m:Method)
WHERE
  m.signature = "void setUp()"
SET
  m:SetUp:Junit3
RETURN
  m AS SetUpMethod, c AS TestClass
junit3:TearDownMethod

Requires concepts:

Labels all tearDown methods declared by a test class with "TearDown" and "Junit3".

MATCH
  (c:Class:Test:Junit3)-[:DECLARES]->(m:Method)
WHERE
  m.signature = "void tearDown()"
SET
  m:TearDown:Junit3
RETURN
  m AS TearDownMethod, c AS TestClass
junit3:TestClass

Labels all non-abstract classes extending from junit.framework.TestCase "Test" and "Junit3".

MATCH
  (c:Type:Class)-[:EXTENDS*]->(testCaseType:Type)
WHERE
  testCaseType.fqn = "junit.framework.TestCase"
SET
  c:Test:Junit3
RETURN
  c AS TestClass
junit3:TestMethod

Requires concepts:

Labels all test methods declared by a test class with "Test" and "Junit3".

MATCH
  (c:Class:Test:Junit3)-[:DECLARES]->(m:Method)
WHERE
  m.signature =~ "void test.*\\(.*\\)"
SET
  m:Test:Junit3
RETURN
  m AS Test, c AS TestClass

junit4.xml

Concepts
junit4:AfterClassMethod

Labels all methods annotated by "@org.junit.AfterClass" with "Junit4" and "AfterClass".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.junit.AfterClass"
SET
  m:Junit4:AfterClass
RETURN
  m AS AfterClassMethod, c AS TestClass
junit4:AfterMethod

Labels all methods annotated by "@org.junit.After" with "Junit4" and "After".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.junit.After"
SET
  m:Junit4:After
RETURN
  m AS AfterMethod, c AS TestClass
junit4:AssertMethod

Labels all assertion methods declared by org.junit.Assert with "Junit4" and "Assert".

MATCH
  (assertType:Type)-[:DECLARES]->(assertMethod)
WHERE
  assertType.fqn = 'org.junit.Assert'
  and assertMethod.signature =~ 'void assert.*'
SET
  assertMethod:Junit4:Assert
RETURN
  assertMethod
junit4:BeforeClassMethod

Labels all methods annotated by "@org.junit.BeforeClass" with "Junit4" and "BeforeClass".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.junit.BeforeClass"
SET
  m:Junit4:BeforeClass
RETURN
  m AS BeforeClassMethod, c AS TestClass
junit4:BeforeMethod

Labels all methods annotated by "@org.junit.Before" with "Junit4" and "Before".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.junit.Before"
SET
  m:Junit4:Before
RETURN
  m AS BeforeMethod, c AS TestClass
junit4:IgnoreTestClassOrMethod

Labels all classes or methods annotated with "@org.junit.Ignore" with "Junit4" and "Ignore".

MATCH
  (e)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.junit.Ignore"
SET
  e:Junit4:Ignore
RETURN
  e AS IgnoredElement
junit4:SuiteClass

Labels all classes annotated by "@org.junit.runners.Suite.SuiteClasses" with "Junit4" and "Suite" and creates a relation "CONTAINS_TESTCLASS" to all referenced classes.

MATCH
  (suite:Type)-[:ANNOTATED_BY]->(suiteClasses)-[:OF_TYPE]->(suiteClassesType:Type)
WHERE
  suiteClassesType.fqn = "org.junit.runners.Suite$SuiteClasses"
SET
  suite:Junit4:Suite
WITH
  suite, suiteClasses
MATCH
  (suiteClasses)-[:HAS]->(:Array:Value)-[:CONTAINS]->(Class:Value)-[:IS]->(testClass:Type)
CREATE UNIQUE
  (suite)-[c:CONTAINS_TESTCLASS]->(testClass)
RETURN
  suite, collect(testClass)
junit4:TestCaseDefinedByClass

Creates a relation DEFINED_BY between all test cases from test reports and the class which defined it.

MATCH
  (testcase:TestCase)
WITH
  testcase
MATCH
  (testclass:Type)
WHERE
  testclass.fqn = testcase.className
MERGE
  (testcase)-[:DEFINED_BY]->(testclass)
RETURN
  testcase.name AS TestCase, testclass AS TestClass
junit4:TestCaseImplementedByMethod

Requires concepts:

Creates a relation IMPLEMENTED_BY between all test cases from test reports and their implementing methods.

MATCH
  (testcase:TestCase)-[:DEFINED_BY]->(testclass:Type),
  (testclass)-[:EXTENDS*0..]->(:Type)-[:DECLARES]->(testmethod:Method)
WHERE
  testmethod.name = testcase.name
MERGE
  (testcase)-[:IMPLEMENTED_BY]->(testmethod)
RETURN
  testcase.name AS TestCase, testmethod as TestMethod
junit4:TestClass

Requires concepts:

Labels all classes containing test methods with "Test" and "Junit4".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method:Junit4:Test)
SET
  c:Test:Junit4
RETURN
  c AS TestClass, COLLECT(m) AS TestMethods
junit4:TestClassOrMethod
_The rule is deprecated: This concept has been replaced by "junit4:TestMethod" and "junit4:TestClass"._

Requires concepts:

Finds test methods (i.e. annotated with "@org.junit.Test") and labels them and their containing classes with "Test" and "Junit4".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method:Junit4:Test)
RETURN
  c AS TestClass, COLLECT(m) AS TestMethods
junit4:TestMethod

Finds all test methods (i.e. annotated with "@org.junit.Test") and labels them with "Test" and "Junit4".

MATCH
  (m:Method)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.junit.Test"
SET
  m:Test:Junit4
RETURN
  m AS Test
Constraints
junit4:AssertionMustProvideMessage

Requires concepts:

All assertions must provide a message.

MATCH
  (testType:Type)-[:DECLARES]->(testMethod:Method),
  (testMethod)-[invocation:INVOKES]->(assertMethod:Assert:Method)
WHERE
  NOT assertMethod.signature =~ 'void assert.*\\(java.lang.String,.*\\)'
RETURN
  invocation AS Invocation,
  testType AS DeclaringType,
  testMethod AS Method
junit4:IgnoreWithoutMessage

All @Ignore annotations must provide a message.

MATCH
  (e)-[:ANNOTATED_BY]->(ignore:Annotation)-[:OF_TYPE]->(ignoreType:Type)
WHERE
  ignoreType.fqn= "org.junit.Ignore"
  AND NOT (ignore)-[:HAS]->(:Value{name:"value"})
RETURN
  e AS IgnoreWithoutMessage
junit4:TestMethodWithoutAssertion

Requires concepts:

All test methods must perform assertions (within a call hierarchy of max. 3 steps).

MATCH
  (testType:Type)-[:DECLARES]->(testMethod:Test:Method)
WHERE
  NOT (testMethod)-[:INVOKES*..3]->(:Method:Assert)
RETURN
  testType AS DeclaringType,
  testMethod AS Method

TestNG

Provides rules for TestNG.

testng.xml

Concepts
testng:AfterClassMethod

Labels all methods annotated by "@org.testng.annotations.AfterClass" with "TestNG" and "AfterClassMethod".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.testng.annotations.AfterClass"
SET
  m:TestNG:AfterClassMethod
RETURN
  m AS AfterClassMethod, c AS TestClass
testng:AfterMethod

Labels all methods annotated by "@org.testng.annotations.AfterMethod" with "TestNG" and "AfterMethod".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.testng.annotations.AfterMethod"
SET
  m:TestNG:AfterMethod
RETURN
  m AS AfterMethod, c AS TestClass
testng:AfterTestMethod

Labels all methods annotated by "@org.testng.annotations.AfterTest" with "TestNG" and "AfterTestMethod".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.testng.annotations.AfterTest"
SET
  m:TestNG:AfterTestMethod
RETURN
  m AS AfterTestMethod, c AS TestClass
testng:BeforeClassMethod

Labels all methods annotated by "@org.testng.annotations.BeforeClass" with "TestNG" and "BeforeClassMethod".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.testng.annotations.BeforeClass"
SET
  m:TestNG:BeforeClassMethod
RETURN
  m AS BeforeClassMethod, c AS TestClass
testng:BeforeMethod

Labels all methods annotated by "@org.testng.annotations.BeforeMethod" with "TestNG" and "BeforeMethod".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.testng.annotations.BeforeMethod"
SET
  m:TestNG:BeforeMethod
RETURN
  m AS BeforeMethod, c AS TestClass
testng:BeforeTestMethod

Labels all methods annotated by "@org.testng.annotations.BeforeTest" with "TestNG" and "BeforeTestMethod".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method),
  (m:Method)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.testng.annotations.BeforeTest"
SET
  m:TestNG:BeforeTestMethod
RETURN
  m AS BeforeTestMethod, c AS TestClass
testng:TestClass

Requires concepts:

Labels all classes containing test methods with "Test" and "TestNG".

MATCH
  (c:Type:Class)-[:DECLARES]->(m:Method:TestNG:Test)
SET
  c:Test:TestNG
RETURN
  c AS TestClass, COLLECT(m) AS TestMethods
testng:TestMethod

Finds all test methods (i.e. annotated with "@org.testng.annotations.Test") and labels them with "Test" and "TestNG".

MATCH
  (m:Method)-[:ANNOTATED_BY]-()-[:OF_TYPE]->(a:Type)
WHERE
  a.fqn="org.testng.annotations.Test"
SET
  m:Test:TestNG
RETURN
  m AS Test

Maven 2 Repository

Provides a scanner for maven repositories.

Scanner for remote maven repositories

Downloads the repository index and retrieves all available new artifacts for scanning.

This plugin should be triggered on the command line by providing an URL and a specific scope:

Examples:

>jqassistant.cmd scan -u maven:repository::http://[<user>:<password>@]<repository url>
>jqassistant.cmd scan -u maven:repository::http://foo:bar@example.com/m2repo
Tip
The plugin supports incremental runs on a maven repository. In this case only new artifacts will be downloaded and scanned. Old snapshot artifacts will be handled as predecessors (see below). Note that such predecessor artifacts will have no direct relationship to the :Maven:Repository node.
Tip
For incremental scanning it is necessary that the exactly the same URL is provided on sub-sequent scans.
Configuration
Table 64. Configuration properties
Property Description Default

m2repo.directory

A directory path. This directory is the target for Maven indices and artifacts.

./jqassistant/data/m2repo

m2repo.filter.includes

A comma separated list of artifact patterns to include in the scan

include all artifacts

m2repo.filter.excludes

A comma separated list of artifact patterns to exclude from the scan

exclude no artifacts

m2repo.artifacts.scan

A boolean value. If true then the content of the artifacts is scanned.

true

m2repo.artifacts.keep

A boolean value. If true then all downloaded artifacts where deleted after scanning.

false

Tip
The artifact patterns follow the Maven syntax, i.e. "[groupId]:[artifactId]:[type]:[version]" or "[groupId]:[artifactId]:[type]:[classifier]:[version]" and allow using wildcards.
:Maven:Repository

A remote Maven repository.

Table 65. Properties of :Maven:Repository
Name Description

url

the remote URL

lastUpdate

timestamp of the last scan

Table 66. Relations of :Maven:Repository
Name Target label(s) Cardinality Description

CONTAINS_POM

[:Maven:Pom:Xml]

0..n

References the POMs in the repository

CONTAINS_ARTIFACT

:Maven:Artifact

0..n

References the artifacts in the repository

Scanner for remote maven artifacts

Gets the maven artifact coordinates to retrieve the artifact from an repository and scans it. The scanner accepts org.apache.maven.index.ArtifactInfo-Items with the scope "maven:repository".

Note
This plugin needs some prerequisites to work properly. The context must contain a MavenRepositoryDescriptor to which the new Maven Artifact belongs and an ArtifactProvider-Object to load the artifact from the configured repository.

Refer to the plugin Javadoc for details about the model.

Maven 3

Provides a scanner for Maven 3 modules.

Scanner for Maven projects

Imports information from Maven projects.

:Maven:Project:File:Directory

A pom.xml file describing a single Maven project.

Table 67. Properties of :Maven:Project:File:Directory
Name Description

fileName

The directory of the project.

name

The name

groupId

The group id

artifactId

The artifact id

packaging

The packaging type, e.g. "jar"

version

The version

Table 68. Relations of :Maven:Project:File:Directory
Name Target label(s) Cardinality Description

CREATES

:Maven:Artifact

0..n

References an artifact created by the project

HAS_MODEL

:Maven:Pom

1

References the POM model of the project

HAS_EFFECTIVE_MODEL

:Maven:Pom

1

References the effective POM model of the project

HAS_PARENT

:Maven:Project:File:Directory

0..1

References the parent project (optional)

HAS_MODULE

:Maven:Project:File:Directory

0..n

References modules of this project (optional)

:Maven:Artifact

Represents an artifact, e.g. a JAR-File.

Table 69. Properties of :Maven:Artifact
Name Description

group

The group name

name

The artifact name

type

The type, e.g. "jar"

classifier

The classifier

version

The version

Table 70. Relations of :Maven:Artifact
Name Target label(s) Cardinality Description

CONTAINS

:File

0..n

References a file contained in the artifact

DEPENDS_ON

:Maven:Artifact

0..n

References an artifact which is a declared dependency

Table 71. Properties of :DEPENDS_ON
Name Description

scope

The declared scope, e.g. "compile"

optional

"true" indicates that this dependency is optional.

Scanner for Maven POMs

Imports information from Maven POMs (e.g. pom.xml) files.

:Maven:Pom

A POM describing a Maven project.

Table 72. Properties of :Maven:Pom
Name Description

group

The group id

name

The artifact id

type

The type, e.g. "jar"

classifier

The classifier (optional)

version

The version

Table 73. Relations of :Maven:Pom
Name Target label(s) Cardinality Description

HAS_PARENT

:Maven:Pom

0..1

References a parent aritfact

HAS_PROPERTY

:Value:Property

0..n

References a property

HAS_PROFILE

:Maven:Profile

0..n

References defined profiles

USES_LICENSE

:Maven:License

0..n

References used licenses

MANAGES_DEPENDENCY

:Maven:Artifact

0..n

References an artifact which is a managed dependency

DECLARES_DEPENDENCY

:Maven:Artifact

0..n

References an artifact which is a declared dependency

HAS_MODULE

:Maven:Module

0..n

References a sub module

MANAGES_PLUGIN

:Maven:Plugin

0..n

References a managed plugin

USES_PLUGIN

:Maven:Plugin

0..n

References a plugin that is used during maven lifecycle

HAS_CONTRIBUTOR

:Maven:Contributor

0..n

References a contributor

HAS_DEVELOPER

:Maven:Developer

0..n

References a developer

:Maven:Contributor

A contributor of the project.

Table 74. Properties of :Maven:Contributor
Name Description

id

The unique ID of the developer in the SCM

email

The email address of the developer.

name

The full name of the developer.

organization

The organization to which the contributor belongs.

organizationUrl

The URL of the organization.

timezone

The timezone the developer is in.

url

The URL for the homepage of the developer.

Table 75. Relations of :Maven:Contributor
Name Target label(s) Cardinality Description

HAS_ROLES

:Maven:Role

0..n

References a role the contributor has in the project.

:Maven:Developer

A developer taking part in the development of the project.

Table 76. Properties of :Maven:Developer
Name Description

id

The unique ID of the developer in the SCM

email

The email address of the developer.

name

The full name of the developer.

organization

The organization to which the contributor belongs.

organizationUrl

The URL of the organization.

timezone

The timezone the developer is in.

url

The URL for the homepage of the developer.

Table 77. Relations of :Maven:Developer
Name Target label(s) Cardinality Description

HAS_ROLES

:Maven:Role

0..n

References a role the developer has in the project.

:Maven:Role

The roles a person plays in the project.

Table 78. Properties of :Maven:Role
Name Description

name

The name of the role a person plays in the project.

:Maven:Profile

A maven profile

Table 79. Properties of :Maven:Profile
Name Description

id

The profile id

Table 80. Relations of :Maven:Profile
Name Target label(s) Cardinality Description

HAS_PROPERTY

:Value:Property

0..n

References a property

MANAGES_DEPENDENCY

:Maven:Artifact

0..n

References an artifact which is a managed dependency

DECLARES_DEPENDENCY

:Maven:Artifact

0..n

References an artifact which is a declared dependency

HAS_MODULE

:Maven:Module

0..n

References a sub module

MANAGES_PLUGIN

:Maven:Plugin

0..n

References a managed plugin

USES_PLUGIN

:Maven:Plugin

0..n

References a plugin that is used during maven lifecycle

HAS_ACTIVATION

:Maven:ProfileActivation

0..1

References the conditions which will trigger the profile.

:Maven:ProfileActivation

A maven profile activation

Table 81. Properties of :Maven:ProfileActivation
Name Description

activeByDefault

Specifies if the profile is activated by default

jdk

Specifies jdk needed to activate the profile

Table 82. Relations of :Maven:ProfileActivation
Name Target label(s) Cardinality Description

HAS_PROPERTY

:Value:Property

0..1

References a property

ACTIVATED_BY_FILE

:Maven:ActivationFile

0..1

References file specification used to activate a profile

ACTIVATED_BY_OS

:Maven:ActivationOS

0..1

References os specification used to activate a profile

:Maven:ActivationFile

File specification used to activate a profile

Table 83. Properties of :Maven:ActivationFile
Name Description

exists

Specifies the name of the file that should exist to activate a profile

missing

Specifies the name of the file that should be missing to activate a profile

:Maven:ActivationOS

Defines operating system’s attributes to activate a profile

Table 84. Properties of :Maven:ActivationOS
Name Description

arch

Specifies the architecture of the OS to be used to activate a profile

family

Specifies the general family of the OS to be used to activate a profile

name

Specifies the name of the OS to be used to activate a profile

version

Specifies the version of the OS to be used to activate a profile

:Maven:Module

A maven module

Table 85. Properties of :Maven:Module
Name Description

name

The module name

:Maven:Plugin

A maven plugin

Table 86. Properties of :Maven:Plugin
Name Description

group

The group id

name

The artifact id

type

The type, e.g. "jar"

classifier

The classifiert

version

The version

inherited

Whether any configuration should be propagated to child POMs

Table 87. Relations of :Maven:Plugin
Name Target label(s) Cardinality Description

HAS_EXECUTION

:Maven:PluginExecution

0..n

References a PluginExecution

HAS_CONFIGURATION

:Maven:Configuration

0..1

References the configuration for the plugin

IS_ARTIFACT

:Maven:Artifact

1

References Maven artifact representing the Maven plugin

:Maven:License

A used license

Table 88. Properties of :Maven:License
Name Description

name

The full legal name of the license.

url

The official url for the license text.

comments

Addendum information pertaining to this license.

distribution

The primary method by which this project may be distributed.

:Maven:PluginExecution

A plugin execution

Table 89. Properties of :Maven:PluginExecution
Name Description

id

The plugin id

inherited

Whether any configuration should be propagated to child POMs.

phase

The build lifecycle phase to bind the goals in this execution to.

Table 90. Relations of :Maven:PluginExecution
Name Target label(s) Cardinality Description

HAS_GOAL

:Maven:ExecutionGoal

0..n

The goals to execute with the given configuration

HAS_CONFIGURATION

:Maven:Configuration

0..1

References the configuration for the plugin

:Maven:Configuration

A configuration for plugins, executions

Table 91. Relations of :Maven:Configuration
Name Target label(s) Cardinality Description

CONTAINS

:Java:Value

0..n

References a value or a list of values

:Maven:ExecutionGoal

A goal for plugin executions

Table 92. Properties of :Maven:ExecutionGoal
Name Description

name

The name of the goal

Refer to the plugin Javadoc for details about the model.

maven3.xml

Constraints
maven3:HierarchicalParentModuleRelation

If a parent Maven project declares a module then the parent project must also be declared as the parent of the module (i.e. to keep the project hierarchy consistent).

match
  (parent:Maven:Project)-[:HAS_MODULE]->(module:Maven:Project)
where
  not (module)-[:HAS_PARENT]->(parent)
return
  module as InvalidModule

OSGi

Provides rules for OSGi bundles (e.g. Bundles, Activator).

osgi-bundle.xml

Concepts
osgi-bundle:Activator

Requires concepts:

Creates an ACTIVATES relation between a class and the bundle artifact if the class is declared as "Bundle-Activator" in the bundle manifest.

match
  (bundle:Osgi:Bundle)-[:CONTAINS]->(manifest:File:Manifest),
  (manifest)-[:DECLARES]->(section:ManifestSection),
  (section)-[:HAS]->(entry:ManifestEntry),
  (bundle)-[:CONTAINS]->(activator:Class)
where
  entry.name = "Bundle-Activator"
  and entry.value = activator.fqn
create unique
  (activator)-[:ACTIVATES]->(bundle)
return
  activator as Activator, bundle as Bundle
osgi-bundle:Bundle

Labels all artifacts with a manifest declaring a bundle name as "Osgi" and "Bundle" and adds the properties "bundleSymbolicName" and "bundleVersion".

MATCH
  (bundle:Artifact)-[:CONTAINS]->(manifest:Manifest:File),
  (manifest)-[DECLARES]->(section:ManifestSection),
  (section)-[:HAS]->(nameEntry:ManifestEntry),
  (section)-[:HAS]->(versionEntry:ManifestEntry)
WHERE
  nameEntry.name = "Bundle-SymbolicName"
  AND versionEntry.name = "Bundle-Version"
SET
  bundle:Osgi:Bundle,
  bundle.bundleSymbolicName = nameEntry.value,
  bundle.bundleVersion = versionEntry.value
RETURN
  bundle as Bundle, bundle.bundleSymbolicName as BundleSymbolicName, bundle.bundleVersion as BundleVersion
osgi-bundle:ExportPackage

Requires concepts:

Creates an EXPORTS relation from a bundle artifact to all packages which are declared as "Export-Package" in the bundle manifest.

match
 (bundle:Osgi:Bundle)-[:CONTAINS]->(package:Package)
with
  bundle, package, "(^|.*,)\\s*"+ replace(package.fqn, ".", "\\.")+"\\s*((;|,).*|$)" as pattern
match
  (bundle)-[:CONTAINS]->(manifest:File:Manifest),
  (manifest)-[:DECLARES]->(section:ManifestSection),
  (section)-[:HAS]->(entry:ManifestEntry)
where
  entry.name = "Export-Package"
  AND entry.value=~ pattern
create unique
  (bundle)-[:EXPORTS]->(package)
return
  bundle as Bundle, collect(package) as ExportedPackages
osgi-bundle:ImportPackage

Requires concepts:

Creates an IMPORTS relation from a bundle artifact to all packages which are declared as "Import-Package" in the bundle manifest.

match
 (package:Package)
with
  package, "(^|.*,)\\s*"+ replace(package.fqn, ".", "\\.")+"\\s*((;|,).*|$)" as pattern
match
  (bundle:Osgi:Bundle)-[:CONTAINS]->(manifest:File:Manifest),
  (manifest)-[:DECLARES]->(section:ManifestSection),
  (section)-[:HAS]->(entry:ManifestEntry)
where
  entry.name = "Import-Package"
  and entry.value =~ pattern
create unique
  (bundle)-[:IMPORTS]->(package)
return
  bundle as Bundle, collect(package) as ImportedPackages
osgi-bundle:InternalType

Requires concepts:

Labels all internal types (i.e. which are not located in an exported package) as "Internal".

match
  (bundle:Bundle:Osgi)-[:CONTAINS]->(internalPackage:Package),
  (bundle)-[:CONTAINS]->(internalType:Type),
  (internalPackage)-[:CONTAINS]->(internalType:Type)
where not
    (bundle)-[:EXPORTS]->(internalPackage)
set
  internalType:Internal
return bundle as Bundle, collect(internalType) as InternalTypes
Constraints
osgi-bundle:InternalTypeMustNotBePublic

Requires concepts:

Internal types must not be public if no depending types exist in other packages of the bundle.

match
  (bundle:Osgi:Bundle)-[:CONTAINS]->(internalType:Type:Internal),
  (internalPackage:Package)-[:CONTAINS]->(internalType)
optional match
  (bundle)-[:CONTAINS]->(otherPackage:Package),
  (otherPackage)-[:CONTAINS]->()-[:DEPENDS_ON]->(internalType)
where
  internalType.visibility='public'
with
  bundle, internalPackage, internalType, collect(otherPackage) as otherPackages
where
  all(otherPackage in otherPackages where internalPackage = otherPackage)
  and not
    (internalType)-[:ACTIVATES]->(bundle)
return
  bundle as Bundle, internalType as InternalType
osgi-bundle:UnusedInternalType

Requires concepts:

A bundle must not contain internal types which are not used by other types in the bundle.

match
  (bundle:Osgi:Bundle)-[:CONTAINS]->(internalType:Type:Internal)
where not (
    (internalType)-[:ACTIVATES]->(bundle)
  or
    (bundle)-[:CONTAINS]->(:Type)-[:DEPENDS_ON]->(internalType)
)
return
  bundle as Bundle, internalType as InternalType

Tycho

Provides a scanner for tycho modules.

Scanner for Tycho projects

Adds Tycho specific resources to be scanned to the file system scanner.

RDBMS

Provides a scanner for importing the metadata of a relational database schema.

Scanner for metadata of a relational database schema

Imports the metadata of a relational database schema, i.e. schemas, tables and columns.

NOTE The JDBC driver must be available on the jQAssistant classpath, e.g. as dependency of the Maven plugin or copied to the plugins/ folder of the distribution.

Connection URI scanner

The connection information may be specified as URI using scope "rdbms:connection", e.g. on the command line

jqassistant.sh scan -u rdbms:connection::jdbc:oracle:thin:username/password@host:1521:sid
Connection property file scanner

The connection properties can also be read from property files having a file name with prefix jqassistant.plugin.rdbms, e.g. "jqassistant.plugin.rdbms_test.properties". Each of them must contain at least the properties "driver", "url", "user" and "password", e.g.

jqassistant.plugin.rdbms_test.properties
## Required configuration properties
driver=org.hsqldb.jdbc.JDBCDriver
url=jdbc:hsqldb:file:target/myDatabase
user=SA
password=

## Optional properties which are passed to Schema Crawler (http://schemacrawler.sourceforge.net/), they affect the level of queried information.

## The name of the database specific driver provided by schema crawler, supported values are "sybaseiq", "sqlserver", "sqlite", "postgresql", "oracle", "mysql", "hsqldb", "derby", "db2"
# bundled_driver=mysql

## It may be necessary to use another info level for performance or compatibility reasons, e.g. if a database does not support retrieving metadata for stored
## procedures you might try to set "retrieve_routines=false". Allowed values are "standard", "minimum", "maximum" or "detailed"
# info_level=standard

## Activation/deactivation of single options on the selected info level
# retrieve_additional_column_attributes=true
# retrieve_additional_database_info=true
# retrieve_additional_jdbc_driver_info=true
# retrieve_additional_table_attributes=true
# retrieve_foreign_keys=true
# retrieve_indices=true
# retrieve_index_information=true
# retrieve_routines=true
# retrieve_routine_columns=true
# retrieve_routine_information=true
# retrieve_schema_crawler_info=true
# retrieve_sequence_information=true
# retrieve_tables=true
# retrieve_table_columns=true
# retrieve_trigger_information=true
# retrieve_view_information=true
:Rdbms:Connection:Properties

Represents a file containing the connection properties described above which have been used to read the schema metadata. It provides the same properties and relations as :File:Properties.

Table 93. Relations of :Rdbms:Connection:Properties
Name Target label(s) Cardinality Description

DESCRIBES_SCHEMA

:Rdbms:Schema

1

References the schema

:Rdbms:Schema

Describes a database schema.

Table 94. Properties of :Rdbms:Schema
Name Description

name

The name of the schema.

Table 95. Relations of :Rdbms:Schema
Name Target label(s) Cardinality Description

HAS_TABLE

:Rdbms:Table

0..n

References the tables in the schema

HAS_VIEW

:Rdbms:View

0..n

References the views in the schema

HAS_SEQUENCE

:Rdbms:Sequence

0..n

References the sequences in the schema

:Rdbms:Table

Describes a database table.

Table 96. Properties of :Rdbms:Table
Name Description

name

The name of the table.

Table 97. Relations of :Rdbms:Table
Name Target label(s) Cardinality Description

HAS_COLUMN

:Rdbms:Column

0..n

References the columns of the table

HAS_PRIMARY_KEY

:Rdbms:PrimaryKey

0..1

References the primary key of the table

HAS_INDEX

:Rdbms:Index

0..*

References indices defined for the table

:Rdbms:View

Describes a database view.

Table 98. Properties of :Rdbms:View
Name Description

name

The name of the view.

Table 99. Relations of :Rdbms:View
Name Target label(s) Cardinality Description

HAS_COLUMN

:Rdbms:Column

0..n

References the columns of the view

:Rdbms:Column

Describes a column of a table.

Table 100. Properties of :Rdbms:Column
Name Description

name

The name of the column

autoIncremented

Indicates an auto incremented value

generated

Indicates a generated value

defaultValue

The default value

size

The size of the column

decimalDigits

The number of digits for decimal types

partOfIndex

Indicates that the column is part of an index

partOfPrimaryKey

Indicates that the column is part of the primary key

partOfForeignKey

Indicates that the column is part of a foreign key

Table 101. Relations of :Rdbms:Column
Name Target label(s) Cardinality Description

OF_COLUMN_TYPE

:Rdbms:ColumnType

1

References the column type

:Rdbms:ColumnType

Describes a column data type, e.g. VARCHAR.

Table 102. Properties of :Rdbms:ColumnType
Name Description

databaseType

The database specific name of the type

autoIncrementable

Indicates that values of this type can auto incremented

precision

The precision

minimumScale

The minimum scale

maximumScale

The maximum scale

fixedPrecisionScale

The fixed precision scale

numericPrecisionRadix

The numeric precision radix

caseSensitive

Indicates that the type is case sensitive

unsigned

Indicates that the type is unsigned

userDefined

Indicates that the type is user defined

:Rdbms:PrimaryKey

Describes a primary key of a table.

Table 103. Properties of :Rdbms:PrimaryKey
Name Description

name

The name of the primary key.

Table 104. Relations of :Rdbms:PrimaryKey
Name Target label(s) Cardinality Description

ON_PRIMARY_KEY_COLUMN

:Rdbms:ColumnType

1

References a primary key column

ON_PRIMARY_KEY_COLUMN

Describes the properties of a column in a primary key.

Table 105. Properties of ON_PRIMARY_KEY_COLUMN
Name Description

indexOrdinalPosition

The ordinal position of the column in the primary key.

sortSequence

The sort sequence, i.e. "ascending" or "descending".

:Rdbms:Index

Describes an index defined for table.

Table 106. Properties of :Rdbms:Index
Name Description

name

The name of the index.

unique

"true" if the index is unique.

cardinality

The cardinality of the index.

indexType

The index type.

pages

The pages.

Table 107. Relations of :Rdbms:Index
Name Target label(s) Cardinality Description

ON_INDEX_COLUMN

:Rdbms:ColumnType

1

References an indexed column

ON_INDEX_COLUMN

Describes the properties of a column used by an index.

Table 108. Properties of ON_INDEX_COLUMN
Name Description

indexOrdinalPosition

The ordinal position of the column in the primary key.

sortSequence

The sort sequence, i.e. "ascending" or "descending".

:Rdbms:ForeignKey

Describes a foreign key.

Table 109. Properties of :Rdbms:ForeignKey
Name Description

name

The name of the foreign key

deferrability

The deferrability

deleteRule

The delete rule, e.g. "cascade"

updateRule

The update rule

Table 110. Relations of :Rdbms:ForeignKey
Name Target label(s) Cardinality Description

HAS_FOREIGN_KEY_REFERENCE

:Rdbms:ForeignKeyReference

1..n

The foreign key references

:Rdbms:ForeignKeyReference

Describes a foreign key reference, i.e. a pair consisting of a foreign key referencing a primary key.

Table 111. Relations of :Rdbms:ForeignKeyReference
Name Target label(s) Cardinality Description

FROM_FOREIGN_KEY_COLUMN

:Rdbms:Column

1

The foreign key column

TO_PRIMARY_KEY_COLUMN

:Rdbms:Column

1

The primary key column

:Rdbms:Sequence

Describes a database sequence.

Table 112. Properties of :Rdbms:Sequence
Name Description

name

The name of the sequence

minimumValue

The minimum value

maximumValue

The maximum value

increment

The increment

cycle

Indicates that the sequence restarts at the minimumValue if the the maximumValue has been reached.

Refer to the plugin Javadoc for details about the model.

XML

Provides scanners for XML and XSD documents.

Scanner for XML files

Imports all XML in a generic representation, e.g. namespaces, elements, attributes and text, using the Scanner for XML sources. The files to scan may be configured using include and exclude filters.

Configuration
Table 113. Configuration properties
Property Description Default

xml.file.include

A comma separated list of file name patterns, wildcards (?,*) are allowed, e.g. "/*-INF/ejb-jar.xml"

Scanner for XML sources

Imports all XML documents in a generic representation, e.g. namespaces, elements, attributes and text.

This plugin is internally used by other plugins (e.g. Scanner for XML files) to create an alternative native structure of XML documents.

:Xml:Document

Represents an XML document.

Table 114. Properties of :Xml:Document
Name Description

xmlVersion

The XML version

standalone

The "standalone" attribute of the XML declaration.

characterEncodingScheme

The encoding of the XML file.

xmlWellFormed

Indicates if the document is well-formed, i.e. could be parsed.

Table 115. Relations of :Xml:Document
Name Target label(s) Cardinality Description

HAS_ROOT_ELEMENT

:Xml:Element

1

References the root element of the document.

:Xml:Element

An XML element.

Table 116. Relations of :Xml:Element
Name Target label(s) Cardinality Description

DECLARES_NAMESPACE

:Xml:Namespace

0..n

References namespaces which are declared on the element.

OF_NAMESPACE

:Xml:Namespace

0..1

References the namespace of the element.

HAS_ELEMENT

:Xml:Element

0..n

References child elements of the element.

HAS_ATTRIBUTE

:Xml:Attribute

0..n

References attributes of the element.

HAS_TEXT

:Xml:Text

0..n

References the text values of the element.

:Xml:Namespace

A XML namespace declaration.

Table 117. Properties of :Xml:Namespace
Name Description

uri

The namespace URI.

prefix

The optional namespace prefix

:Xml:Attribute

An XML attribute.

Table 118. Properties of :Xml:Attribute
Name Description

name

The name of the atribute.

value

The value of the attribute.

Table 119. Relations of :Xml:Attribute
Name Target label(s) Cardinality Description

OF_NAMESPACE

:Xml:Namespace

0..1

References the namespace of the attribute.

:Xml:Text

A text value of an XML element.

Table 120. Properties of :Xml:Element
Name Description

value

The text value.

Generic scanner for XSD files

Imports all files with the file name suffix ".xsd" using the Scanner for XML files.

Refer to the plugin Javadoc for details about the model.

YAML

Provides a scanner for YAML files

Generic scanner for YAML files

Imports YAML 1.1 files in a generic representation for jQAssistant.

Seen from a more formal perspective a YAML document is build by a tree of nodes. Each node can have one of the following values as content: scalar value, sequence or mapping. This plugin imports a YAML file in a simplified manner as simply model of keys and values. See section Examples for examples.

Important
This YAML scanner supports not the full YAML 1.1 specification as is is intended to help to scan and validate YAML configuration files with the help of a simple graph model. If you need an better support for YAML files, please report a feature request.
Activation of the plugin

The YAML scanner is not activated by default for the jQAssistant Plugin for Maven, but for the commandline tool for jQAssistant. To activated for the jQAssistant for Maven it must be added to the list of dependencies as shown below.

<plugin>
    <groupId>com.buschmais.jqassistant.scm</groupId>
    <artifactId>jqassistant-maven-plugin</artifactId>
    <version>{projectVersion}</version>
    <dependencies>
        <dependency>
            <groupId>com.buschmais.jqassistant.plugin</groupId>
            <artifactId>jqassistant.plugin.yaml</artifactId>
            <version{projectVersion}</version>
        </dependency>
    </dependencies>
</plugin>
:File:YAML

A file with the file extension .yaml containing zero or more YAML documents.

Table 121. Relations of :File:Xml
Name Target label(s) Cardinality Description

CONTAINS_DOCUMENT

:Document:YAML

0..n

References a document in the file

Table 122. Properties of :File:YAML
Name Description

valid

Property to indicate if the documents of this file have been parsed successfully or not. If the YAML scanner was able to parse all documents, this property is true. Otherwise it is false. This property can be used to check if all of your YAML files could have been parsed or not.

An non-parsable file with YAML documents will not have any outgoing relationships to any dependent YAML documents. Please consider this aspect when writing your queries.

:Document:YAML
Table 123. Relations of :Document:YAML
Name Target label(s) Cardinality Description

CONTAINS_VALUE

:Key:YAML

0..n

References a key in the containing document

CONTAINS_KEY

:Value:YAML

0..n

References a value in the containing document

:Key:YAML
Table 124. Properties of :Key:YAML
Name Description

name

The name of the key

fqn

The full qualified name of the key. It is build by joining all parent keys and the name of the current key with a dot as delimiter

Table 125. Relations of :Key:YAML

Name

Target label(s)

Cardinality

Description

CONTAINS_KEY

:Key:YAML

0..n

References a child key of the containing key

CONTAINS_VALUE

:Value:YAML

0..n

References a value assigned to the key

:Value:YAML

Nodes tagged with :Value:YAML represents YAML scalars assigned to a :Key:YAML.

Table 126. Properties of :Value:YAML

Name

Description

value

The value itself.

Table 127. Relations of :Value:YAML

Name

Target label(s)

Cardinality

Description

CONTAINS_VALUE

:Value:YAML

0..n

References a child value assigned to this value

Examples

Not written yet.

Refer to the plugin Javadoc for details about the model.