Design Pattern Detection

User Tools

Site Tools

You are here: start
Trace:
start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
start [2012/09/25 21:38] – shouzhengstart [2015/01/27 16:54] (current) – bil
Line 1: Line 1:
-This page shows a guideline for installing FINDER. +This wiki outlines the design pattern detection research that takes place at York University. It also includes detailed instructions on how to download and install the various design pattern detection tools that we have developed.
- +
-Prerequisites:\\ +
-You need to have [[http://www.swag.uwaterloo.ca/javex/index.html|Javex]], [[http://www.swag.uwaterloo.ca/grok/index.html|Grok]], and QL installed before running FINDER. These tools are developed by the Software Architecture Group (SWAG) at the University of Waterloo, and they can be found at [[http://www.swag.uwaterloo.ca|SWAG site]].\\ +
- +
-samples?\\ +
- +
-Make sure you have set up certain environment variables for using all these tools, so that FINDER knows where they are. \\ +
- +
-samples?\\ +
- +
-Installation:\\ +
-Download and extract {{finder.zip|FINDER}}. \\ +
- +
-In order to detect patterns by FINDER, you will need to edit the following files in the conf directory:\\ +
- +
-  *software.xml  +
-    *directory -- path to the software java class files +
-    *name  -- software system name +
-    *source_directory -- path to the software source code.  +
-    (Note: FINDER relies on both class files and source code of the target system.) +
- +
-  *scripts.xml   +
-    *scriptsDirectory -- path to FINDER scripts, which refer to FINDER/scripts +
-    *candidateInstancesDirectory -- path to detection results output directory +
- +
-  *designpatterns.xml +
-    *designpattern -- By commenting in/out each "designpattern" tag, you can choose certain design patterns to be included during the detection stage. +
-    *ql_script  -- path to the specific FINDER script for the related design pattern. They are located at FINDER/scripts/ql/ . +
- +
-  *run.properties +
-    *input.design.patterns.xml.file -- path to the above designpatterns.xml file +
-    *input.software.xml.file -- path to the above software.xml file +
-    *input.scripts.xml.file  -- path to the above scripts.xml file +
-    *output.exception.txt.file -- path to exception output file +
- +
- +
-To run FINDER, go to FINDER/bin and run the following commands:\\ +
-java -Xms1024M -Xmx1024M -Xss5000K ca.yorku.cse.FINDER.Engine "path to run.properties file" +
- +
-\\ +
-\\ +
-\\ +
-\\ +
- +
- +
- +
-This page shows a guideline for using the MoRe application suite.  +
- +
-Download and extract the {{MoRe.zip|MoRe application suite}}. Note that the "conf" folder contains all pre-defined MoRe models that are essential to all the following tools. The "models.xml" file inside the "conf" folder specifies the path to all MoRe models that are to be included in the tool suite. When launching the following tools, **enter the directory that contains all the Jars** and make sure the "conf" folder is located parallel to the tools. This allows the tools to find all the MoRe models.\\ +
- +
-A running example is also provided to test the tools suite. The example is based on the {{tab2ps.zip|TAB2PS}} system. +
- +
-   *FINDER converter  --  This tool requires an XML file that specifies the system name of the software system, the output location of converted results, and all design patterns with corresponding raw result file name. A sample of the configuration file, is shown below.  +
-   +
-  <FinderConf xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> +
-  <systemName>TAB2PS</systemName> +
-   <moreInstanceDestination>FINDERInstance/</moreInstanceDestination> +
-   <pattern patternName="Composite" inputFile="TAB2PS-finder/TAB2PS.composite.out"/> +
-   <pattern patternName="Decorator" inputFile="TAB2PS-finder/TAB2PS.decorator_degenerate.out"/> +
-   <pattern patternName="Template Method" inputFile="TAB2PS-finder/TAB2PS.templatemethod.out"/> +
-   </FinderConf> +
- +
-  Usage: java -jar finderConverter.jar finder_tab2ps.xml +
- +
-An {{tab2ps-finder.zip|example}} can be downloaded to test the converter. The example contains FINDER raw results of the TAB2PS system with corresponding "finder_tab2ps.xml" configuration file. You may need to edit "finder_tab2ps.xml" to specify the relative path from working directory to raw result files. +
- +
-    *PINOT Converter  --  Unlike FINDER that reports results for every pattern in a separate file, PINOT outputs all pattern detection results in a single file. Therefore, we do not use a configuration file for the usage of the converter. Instead, the converter accepts three parameters at the terminal. The first one gives the software system name, the second one is the input file name which contains PINOT raw results, and the last one specifies the location for the output of the converter which can be omitted for the current path. More specifically, usage of the PINOT raw result converter is: +
- +
-  Usage: +
-  java -jar pinotConverter.jar TAB2PS rawResult.txt outputPath +
- +
-An {{tab2ps-pinot.txt|example}} of PINOT raw result can be downloaded to test the converter. +
- +
-    *SSA Converter  --  The usage of SSA raw result converter is similar to that of PINOT raw result converter. It accepts three parameters at the terminal, which are the software system name, the input file name of raw results, and the location for the output of the converter which can be omitted. Usage of the SSA raw result converter is: +
- +
-  Usage: +
-  java -jar ssaConverter.jar TAB2PS rawResult.txt outputPath +
- +
-An {{tab2ps-ssa.zip|example}} of SSA raw result can be downloaded to test the converter. +
- +
-    *Presenter  +
- +
-  Usage: java -jar presenter.jar +
- +
-Also, we can provide a MoRe instance as a parameter for the presenter at terminal. This loads the presenter with the corresponding MoRe instance together.  +
-   +
-  Usage: java -jar presenter.jar aMoReInstance.xml +
- +
-You may wish to test the presenter with any MoReInstance file generated by the above three converters. +
- +
-    *The Comparator +
-The comparator is able to compute all proposed metrics as well as raw precision and recall between two MoRe instance files. Calculation can be performed based on either roles in the Benchmark or the intersection of Automatic and Benchmark roles. Usage is shown in the following: +
- +
-  Usage: java -jar comparator.jar Automatic Benchmark [option] +
-  options: +
-  -gap-b     Gross anchor precision based on Benchmark roles. +
-  -gar-b      Gross anchor recall based on Benchmark roles. +
-  -dap-b     Detailed anchor precision based on Benchmark roles. +
-  -dar-b      Detailed anchor recall based on Benchmark roles. +
-  -dapd-b   DAP diagram based on Benchmark roles. +
-  -dard-b    DAR diagram based on Benchmark roles. +
-  -gap-i       Gross anchor precision based on intersection of roles. +
-  -gar-i        Gross anchor recall based on intersection of roles. +
-  -dap-i       Detailed anchor precision based on intersection of roles. +
-  -dar-i        Detailed anchor recall based on intersection of roles. +
-  -dapd-i     DAP diagram based on intersection of roles. +
-  -dard-i      DAR diagram based on intersection of roles. +
-  -precision Regular precision +
-  -recall       Regular recall +
- +
-Combination of two MoRe instances can also be obtained by the comparator in the following way: +
-  Usage: java -jar comparator.jar result1 result2 combinedFile -c +
- +
-You may wish to test the comparator with two correspondence MoReInstance files generated by the above converters. +
- +
-    *Comparing All +
-The comparator can also compare detection results for all metrics of multiple patterns produced by two tools at one time. In order to do this, a configuration file is needed to specify the software system name, tool name of the automatic result set, tool name of the benchmark result set, comparison type (based on benchmark +
-roles or intersection of roles), and a list of pairs of MoRe instances to be compared. +
-A sample {{ssa_finder_compareAll.zip|configuration file}} is shown below. In order to run this example, you may need to edit the paths from working directory to all pairs of MoRe Instances. +
- +
-  <CompareAll xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> +
-  <systemName>TAB2PS</systemName> +
-  <automaticTool>SSA</automaticTool> +
-  <benchmarkTool>FINDER</benchmarkTool> +
-  <baseType>intersection</baseType> +
-  <listOfComparison> +
-  <comparison patternName="Decorator" benchFile="FINDERInstance/TAB2PS_Decorator.xml" +
-   autoFile="SSAInstance/TAB2PS_Decorator.xml"/> +
-  <comparison patternName="State" benchFile="FINDERInstance/TAB2PS_State.xml"  +
-   autoFile="SSAInstance/TAB2PS_State.xml"/> +
-  <comparison patternName="Strategy" benchFile="FINDERInstance/TAB2PS_Strategy.xml"  +
-   autoFile="SSAInstance/TAB2PS_Strategy.xml"/> +
-  <comparison patternName="TemplateMethod" benchFile="FINDERInstance/TAB2PS_TemplateMethod.xml"  +
-   autoFile="SSAInstance/TAB2PS_TemplateMethod.xml"/> +
-  </listOfComparison> +
-  </CompareAll> +
- +
-To perform the comparison, we use a separate jar in the following way: +
-  Usage: java -jar compareAll.jar compareAll.xml +
  
 +Please choose a link from the sidebar (currently only one) to learn more on this research topic.
  
 +For any questions, please email [[bil@yorku.ca]]
start.1348609088.txt.gz · Last modified: 2012/09/25 21:38 by shouzheng