User Tools

Site Tools


finder

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
finder [2012/12/10 05:26] shouzhengfinder [2015/01/28 03:40] (current) shouzheng
Line 5: Line 5:
  
 Prerequisites:\\ Prerequisites:\\
-In order to run FINDER, you need to have [[http://www.swag.uwaterloo.ca/javex/index.html|Javex]], [[http://www.swag.uwaterloo.ca/grok/index.html|Grok]], and [[http://www.swag.uwaterloo.ca/qldx/index.html|QL]] installed in advance. 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]]. \\+In order to run FINDER, you need to have [[http://www.swag.uwaterloo.ca/javex/index.html|Javex]], [[http://www.swag.uwaterloo.ca/grok/index.html|Grok]], and [[http://www.swag.uwaterloo.ca/qldx/index.html|QL]] installed in advance. 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]]. (Note: FINDER is not compatible with all versions of the aforementioned tools. Some low versions of Javex may not work properly in FINDER. We suggest using FINDER equipped with Javex 1.0.8+. Some latest versions of Grok such as v95 which currently is the default downloadable version may report some warnings at runtime, although it doesn't influence the final results. However, the Grok (v83) that comes with QL should always work.)\\ 
 Make sure you have set up certain environment variables for using all these tools, so that FINDER knows where they are. You can test this by calling the three tools at terminal. Messages such as "command not found" should not be there. \\ Make sure you have set up certain environment variables for using all these tools, so that FINDER knows where they are. You can test this by calling the three tools at terminal. Messages such as "command not found" should not be there. \\
  
Line 11: Line 12:
  
 Installation:\\ Installation:\\
-Download and extract {{FinderAndMoRe.tar.gz|FINDER and MoRe}} (all in one package) anywhere in your system. A number of configuration files need to be configured in order to apply FINDER and MoRe. \\ +Download and extract {{finderandmore_all.tar.gz|FINDER and MoRe}} (all in one package) anywhere in your system. A number of configuration files need to be configured in order to apply FINDER and MoRe. \\ 
-Let's assume that the path to the top level FINDER directory is <path>.\\+Let's assume that the path to the top level extracted directory is <path>.\\
 Add the following commands to your .tcshrc file (adjust accordingly for other shells): Add the following commands to your .tcshrc file (adjust accordingly for other shells):
  
Line 42: Line 43:
 To run FINDER, simply give:\\ To run FINDER, simply give:\\
  
-''finderDPDT "path to run.properties file"'' \\+''finderDPD "path to run.properties file"'' \\
  
 \\ \\
Line 60: Line 61:
   Usage: finderConverter "path to the configuration file"   Usage: finderConverter "path to the configuration file"
  
-   *PINOT converter -- This tool converts PINOT raw results into MoRe Instances. 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:+   *PINOT converter -- [[http://www.cs.ucdavis.edu/~shini/research/pinot|PINOT]] is one design pattern detection tool developed by Nija Shi and Ron Olsson. PINOT converter converts PINOT raw results into MoRe Instances. 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: pinotConverter "software system name" "path to the raw result file" "output path (optional)"   Usage: pinotConverter "software system name" "path to the raw result file" "output path (optional)"
  
-   *SSA converter -- This tool converts SSA raw results into MoRe Instances. The usage of SSA raw result converter is same to that of PINOT raw result converter. +   *SSA converter -- [[http://ieeexplore.ieee.org/xpl/login.jsp?tp=&arnumber=4015512&url=http%3A%2F%2Fieeexplore.ieee.org%2Fxpls%2Fabs_all.jsp%3Farnumber%3D4015512|SSA]] is also one design pattern detection tool developed by N. Tsantalis et al. SSA converter converts SSA raw results into MoRe Instances. The usage of SSA raw result converter is same to that of PINOT raw result converter. 
  
   Usage: ssaConverter "software system name" "path to the raw result file" "output path (optional)"   Usage: ssaConverter "software system name" "path to the raw result file" "output path (optional)"
Line 120: Line 121:
 'runSample_tab2ps' \\ 'runSample_tab2ps' \\
  
-This command involves using FINDER to detect desgin patterns used in TAB2PS system, converting FINDER, PINOT and SSA raw results into MoRe instances, obtaining all the metric values among the results, and finally presenting the combination of all the results of Decorator pattern of the three tools as an example. \\+This command involves using FINDER to detect design patterns used in TAB2PS system, converting FINDER, PINOT and SSA raw results into MoRe instances, obtaining all the metric values among the results, and finally presenting the combination of all the results of Decorator pattern of the three tools as an example. \\
  
  
finder.1355117207.txt.gz · Last modified: 2012/12/10 05:26 by shouzheng