Revize 8a60bc88

Structure of the antipattern service and repository edited

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/detecting/detectors/AntiPatternDetector.java

@@ -13 +13 @@
  * you should implements all method correctly, see example TooLongSprintDetector.java
  */
 public interface AntiPatternDetector {
+    /**
+     * Method for setting anti-pattern to the detector
+     *
+     * @param antiPattern ap to set
+     */
+    void setAntiPattern(AntiPattern antiPattern);
+
+    /**
+     * Method for getting name of the json file with anti-pattern details
+     *
+     * @return json file name
+     */
+    String getJsonFileName();
 
     /**
      * Method for getting AP like model class for manipulating on UI.

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/detecting/detectors/BusinessAsUsualDetectorImpl.java

@@ -15 +15 @@
 
     private final Logger LOGGER = LoggerFactory.getLogger(BusinessAsUsualDetectorImpl.class);
 
-    private AntiPatternService antiPatternService = new AntiPatternServiceImpl();
-
     public final String configJsonFileName = "BusinessAsUsual.json";
 
-    private AntiPattern antiPattern = antiPatternService.getAntiPatternFromJsonFile(configJsonFileName);
+    private AntiPattern antiPattern;
 
     private final List<String> SQL_FILE_NAMES = Arrays.asList(
             "set_project_id.sql",
@@ -38 +36 @@
         return Arrays.asList(((String) antiPattern.getThresholds().get("searchSubstringsWithRetrospective").getValue()).split("\\|\\|"));
     }
 
+    @Override
+    public String getJsonFileName(){
+        return this.configJsonFileName;
+    }
+
+    @Override
+    public void setAntiPattern(AntiPattern antiPattern) {
+        this.antiPattern = antiPattern;
+    }
+
     @Override
     public AntiPattern getAntiPatternModel() {
         return this.antiPattern;

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/detecting/detectors/LongOrNonExistentFeedbackLoopsDetectorImpl.java

@@ -18 +18 @@
 
     private final Logger LOGGER = LoggerFactory.getLogger(LongOrNonExistentFeedbackLoopsDetectorImpl.class);
 
-    private AntiPatternService antiPatternService = new AntiPatternServiceImpl();
-
     public final String configJsonFileName = "LongOrNonExistentFeedbackLoops.json";
 
-    private AntiPattern antiPattern = antiPatternService.getAntiPatternFromJsonFile(configJsonFileName);
+    private AntiPattern antiPattern;
 
     private final List<String> SQL_FILE_NAMES = Arrays.asList(
             "set_project_id.sql",
@@ -49 +47 @@
         return Arrays.asList(((String) antiPattern.getThresholds().get("searchSubstringsWithFeedbackLoop").getValue()).split("\\|\\|"));
     }
 
+    @Override
+    public String getJsonFileName(){
+        return this.configJsonFileName;
+    }
+
+    @Override
+    public void setAntiPattern(AntiPattern antiPattern) {
+        this.antiPattern = antiPattern;
+    }
+
     @Override
     public AntiPattern getAntiPatternModel() {
         return this.antiPattern;

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/detecting/detectors/NinetyNinetyRuleDetectorImpl.java

@@ -15 +15 @@
 
     private final Logger LOGGER = LoggerFactory.getLogger(BusinessAsUsualDetectorImpl.class);
 
-    private AntiPatternService antiPatternService = new AntiPatternServiceImpl();
-
     public final String configJsonFileName = "NinetyNinetyRule.json";
 
-    private AntiPattern antiPattern = antiPatternService.getAntiPatternFromJsonFile(configJsonFileName);
+    private AntiPattern antiPattern;
 
     private final List<String> SQL_FILE_NAMES = Arrays.asList(
             "set_project_id.sql",
@@ -36 +34 @@
         return ((PositiveInteger) antiPattern.getThresholds().get("maxBadDivisionLimit").getValue()).intValue();
     }
 
+    @Override
+    public String getJsonFileName(){
+        return this.configJsonFileName;
+    }
+
+    @Override
+    public void setAntiPattern(AntiPattern antiPattern) {
+        this.antiPattern = antiPattern;
+    }
+
     @Override
     public AntiPattern getAntiPatternModel() {
         return this.antiPattern;

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/detecting/detectors/RoadToNowhereDetectorImpl.java

@@ -19 +19 @@
 
     private final Logger LOGGER = LoggerFactory.getLogger(SpecifyNothingDetectorImpl.class);
 
-    private AntiPatternService antiPatternService = new AntiPatternServiceImpl();
-
     public final String configJsonFileName = "RoadToNowhere.json";
 
-    private AntiPattern antiPattern = antiPatternService.getAntiPatternFromJsonFile(configJsonFileName);
+    private AntiPattern antiPattern;
 
     private final List<String> SQL_FILE_NAMES = Arrays.asList(
             "set_project_id.sql",
@@ -48 +46 @@
         return Arrays.asList(((String) antiPattern.getThresholds().get("searchSubstringsWithProjectPlan").getValue()).split("\\|\\|"));
     }
 
+    @Override
+    public String getJsonFileName(){
+        return this.configJsonFileName;
+    }
+
+    @Override
+    public void setAntiPattern(AntiPattern antiPattern) {
+        this.antiPattern = antiPattern;
+    }
+
     @Override
     public AntiPattern getAntiPatternModel() {
         return this.antiPattern;

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/detecting/detectors/SpecifyNothingDetectorImpl.java

@@ -19 +19 @@
 
     private final Logger LOGGER = LoggerFactory.getLogger(SpecifyNothingDetectorImpl.class);
 
-    private AntiPatternService antiPatternService = new AntiPatternServiceImpl();
-
     public final String configJsonFileName = "SpecifyNothing.json";
 
-    private AntiPattern antiPattern = antiPatternService.getAntiPatternFromJsonFile(configJsonFileName);
+    private AntiPattern antiPattern;
 
     private final List<String> SQL_FILE_NAMES = Arrays.asList(
             "set_project_id.sql",
@@ -51 +49 @@
         return Arrays.asList(((String) antiPattern.getThresholds().get("searchSubstringsWithProjectSpecification").getValue()).split("\\|\\|"));
     }
 
+    @Override
+    public String getJsonFileName(){
+        return this.configJsonFileName;
+    }
+
+    @Override
+    public void setAntiPattern(AntiPattern antiPattern) {
+        this.antiPattern = antiPattern;
+    }
+
     @Override
     public AntiPattern getAntiPatternModel() {
         return this.antiPattern;

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/detecting/detectors/TooLongSprintDetectorImpl.java

@@ -14 +14 @@
 
     private final Logger LOGGER = LoggerFactory.getLogger(TooLongSprintDetectorImpl.class);
 
-    private AntiPatternService antiPatternService = new AntiPatternServiceImpl();
-
     public final String configJsonFileName = "TooLongSprint.json";
 
-    private AntiPattern antiPattern = antiPatternService.getAntiPatternFromJsonFile(configJsonFileName);
+    private AntiPattern antiPattern;
 
     private final List<String> SQL_FILE_NAMES = Arrays.asList(
             "set_project_id.sql",
@@ -29 +27 @@
     // sql queries loaded from sql file
     private List<String> sqlQueries;
 
+    @Override
+    public String getJsonFileName(){
+        return this.configJsonFileName;
+    }
+
+    @Override
+    public void setAntiPattern(AntiPattern antiPattern) {
+        this.antiPattern = antiPattern;
+    }
+
     @Override
     public AntiPattern getAntiPatternModel() {
         return this.antiPattern;

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/detecting/detectors/VaryingSprintLengthDetectorImpl.java

@@ -18 +18 @@
 
     private final Logger LOGGER = LoggerFactory.getLogger(VaryingSprintLengthDetectorImpl.class);
 
-    private AntiPatternService antiPatternService = new AntiPatternServiceImpl();
-
     public final String configJsonFileName = "VaryingSprintLength.json";
 
-    private AntiPattern antiPattern = antiPatternService.getAntiPatternFromJsonFile(configJsonFileName);
+    private AntiPattern antiPattern;
 
     private final List<String> SQL_FILE_NAMES = Arrays.asList(
             "set_project_id.sql",
@@ -41 +39 @@
         return ((PositiveInteger) this.antiPattern.getThresholds().get("maxIterationChanged").getValue()).intValue();
     }
 
+    @Override
+    public String getJsonFileName(){
+        return this.configJsonFileName;
+    }
+
+    @Override
+    public void setAntiPattern(AntiPattern antiPattern) {
+        this.antiPattern = antiPattern;
+    }
+
     @Override
     public AntiPattern getAntiPatternModel() {
         return this.antiPattern;

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/repository/AntiPatternRepository.java

@@ -1 +1 @@
 package cz.zcu.fav.kiv.antipatterndetectionapp.repository;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import cz.zcu.fav.kiv.antipatterndetectionapp.detecting.detectors.AntiPatternDetector;
+import cz.zcu.fav.kiv.antipatterndetectionapp.model.AntiPattern;
+import cz.zcu.fav.kiv.antipatterndetectionapp.model.Threshold;
+import cz.zcu.fav.kiv.antipatterndetectionapp.model.types.Percentage;
+import cz.zcu.fav.kiv.antipatterndetectionapp.model.types.PositiveFloat;
+import cz.zcu.fav.kiv.antipatterndetectionapp.model.types.PositiveInteger;
+import cz.zcu.fav.kiv.antipatterndetectionapp.utils.JsonParser;
 import org.reflections.Reflections;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -22 +29 @@
 public class AntiPatternRepository implements ServletContextAware {
 
     private static final String QUERY_DIR = "/queries/";
+    private static final String AP_DIR = "/antipatterns/";
     private final Logger LOGGER = LoggerFactory.getLogger(AntiPatternRepository.class);
     private ServletContext servletContext;
-    private Map<Long, AntiPatternDetector> antiPatternDetectors = init();
+    private Map<Long, AntiPatternDetector> antiPatternDetectors;
+
+    /**
+     * This method load all queries from files for each AP.
+     *
+     * @param servletContext servlet context
+     */
+    @Override
+    public void setServletContext(ServletContext servletContext) {
+        this.servletContext = servletContext;
+
+        // initialize all detectors
+        this.antiPatternDetectors = initDetectors();
+
+        // initialize sql queries
+        initSqlQueries();
+    }
+
 
     /**
      * The method that loads all available detectors that implement
@@ -34 +59 @@
      *
      * @return map of all AP
      */
-    private Map<Long, AntiPatternDetector> init() {
+    private Map<Long, AntiPatternDetector> initDetectors() {
         LOGGER.info("-------START CREATING DETECTORS WITH REFLECTION-------");
+
         Map<Long, AntiPatternDetector> antiPatterns = new HashMap<>();
         try {
             Reflections reflections = new Reflections("cz.zcu.fav.kiv.antipatterndetectionapp");
             Set<Class<? extends AntiPatternDetector>> subTypes = reflections.getSubTypesOf(AntiPatternDetector.class);
             for (Class<? extends AntiPatternDetector> subType : subTypes) {
                 AntiPatternDetector antiPatternDetector = subType.getDeclaredConstructor().newInstance();
+
+                // loading anti-pattern from json file and linking it to the detector file
+                antiPatternDetector.setAntiPattern(getAntiPatternFromJsonFile(antiPatternDetector.getJsonFileName()));
+
                 antiPatterns.putIfAbsent(antiPatternDetector.getAntiPatternModel().getId(), antiPatternDetector);
                 LOGGER.info("Creating detector " + antiPatternDetector.getAntiPatternModel().getPrintName());
             }
@@ -49 +79 @@
             e.printStackTrace();
             LOGGER.error("Cannot get all detectors with reflection", e);
         }
-        LOGGER.info("-------FINISHED CREATING DETECTORS WITH REFLECTION-------");
-        return antiPatterns;
-    }
 
-    /**
-     * Get all loaded AP from global value.
-     *
-     * @return list of AP
-     */
-    public List<AntiPatternDetector> getAllAntiPatterns() {
-        return new ArrayList<>(this.antiPatternDetectors.values());
-    }
+        LOGGER.info("-------FINISHED CREATING DETECTORS WITH REFLECTION-------");
 
-    /**
-     * Get AP by given ID.
-     *
-     * @param id AP ID
-     * @return AP
-     */
-    public AntiPatternDetector getAntiPatternById(Long id) {
-        return this.antiPatternDetectors.getOrDefault(id, null);
+        return antiPatterns;
     }
 
     /**
-     * This method load all queries from files for each AP.
      *
-     * @param servletContext servlet context
      */
-    @Override
-    public void setServletContext(ServletContext servletContext) {
-        this.servletContext = servletContext;
+    private void initSqlQueries(){
         LOGGER.info("-------START READING SQL FROM FILES-------");
+
         for (AntiPatternDetector antiPatternDetector : getAllAntiPatterns()) {
             LOGGER.info("Reading sql files for AP " + antiPatternDetector.getAntiPatternModel().getPrintName());
             antiPatternDetector.setSqlQueries(loadSqlFile(antiPatternDetector.getSqlFileNames()));
-
         }
+
         LOGGER.info("-------FINISHED READING SQL FROM FILES-------");
     }
 
+
     /**
      * Method for loading list of sql files from given list of files
      *
@@ -100 +111 @@
 
         // walk through all sql filenames and load all sql queries
         for (String fileName : fileNames) {
-            LOGGER.info("Reading sql query from file name " + fileName);
+
+            LOGGER.info("Reading sql query from file " + fileName);
+
             try {
                 URL test = servletContext.getResource(QUERY_DIR + fileName);
                 BufferedReader read = new BufferedReader(
@@ -113 +126 @@
                 }
                 read.close();
             } catch (IOException e) {
-                LOGGER.warn("Cannot read sql from file " + fileName, e);
+                LOGGER.error("Cannot read sql from file " + fileName);
                 return queries;
             }
         }
         return queries;
     }
+
+    /**
+     *
+     * @param jsonFileName
+     * @return
+     */
+    public AntiPattern getAntiPatternFromJsonFile(String jsonFileName){
+        String json = "";   // json configuration file
+        JsonNode node = null;
+
+        LOGGER.info("Reading anti-pattern from json file " + jsonFileName);
+
+        try {
+            URL url = servletContext.getResource(AP_DIR + jsonFileName);
+            BufferedReader read = new BufferedReader(
+                    new InputStreamReader(url.openStream()));
+
+            String line;
+            while ((line = read.readLine()) != null) {
+                json += line;
+            }
+            node = JsonParser.parse(json);
+        } catch (IOException e) {
+            LOGGER.warn("Cannot read anti-pattern from json file " + jsonFileName);
+            return null;
+        }
+
+        Long APid = Long.parseLong(node.get("id").asText());
+        String APPrintName = node.get("printName").asText();
+        String APName = node.get("name").asText();
+        String APDescription = node.get("description").asText();
+        String APCatalogueFileName = node.get("catalogueFileName") != null ? node.get("catalogueFileName").asText() : null;
+
+        Map<String, Threshold> APMap = new HashMap<>();
+
+        JsonNode array = node.get("thresholds");
+        Threshold<?> tmpThreshold = null;
+
+        for(int i = 0; i < array.size(); i++){
+            JsonNode tmpNode = array.get(i);
+
+            String thresholdName = tmpNode.get("thresholdName").asText();
+            String thresholdType = tmpNode.get("thresholdType").asText();
+
+            JsonNode thresholdNode = tmpNode.get("threshold");
+
+            String tThresholdName = thresholdNode.get("thresholdName").asText();
+            String tThresholdPrintName = thresholdNode.get("thresholdPrintName").asText();
+            String tThresholdDescription = thresholdNode.get("thresholdDescription").asText();
+            String tThresholdErrorMess = thresholdNode.get("thresholdErrorMess").asText();
+            String tThresholdValue = thresholdNode.get("thresholdValue").asText();
+
+            tmpThreshold = getThreshold(thresholdType, tThresholdName, tThresholdPrintName, tThresholdDescription, tThresholdErrorMess, tThresholdValue);
+
+            APMap.put(thresholdName, tmpThreshold);
+        }
+
+        AntiPattern newAP = new AntiPattern(APid, APPrintName, APName, APDescription, APMap, APCatalogueFileName);
+
+        return newAP;
+    }
+
+    /**
+     * Get all loaded AP from global value.
+     *
+     * @return list of AP
+     */
+    public List<AntiPatternDetector> getAllAntiPatterns() {
+        return new ArrayList<>(this.antiPatternDetectors.values());
+    }
+
+    /**
+     * Get AP by given ID.
+     *
+     * @param id AP ID
+     * @return AP
+     */
+    public AntiPatternDetector getAntiPatternById(Long id) {
+        return this.antiPatternDetectors.getOrDefault(id, null);
+    }
+
+    /**
+     *
+     * @param thresholdType
+     * @param name
+     * @param printName
+     * @param description
+     * @param errorMessage
+     * @param value
+     * @return
+     */
+    private Threshold<?> getThreshold(String thresholdType, String name, String printName, String description, String errorMessage, String value){
+
+        if(thresholdType.equals("Percentage")){
+            return new Threshold<>(name, printName, description, errorMessage, new Percentage(Float.parseFloat(value)));
+        }
+        else if(thresholdType.equals("PositiveFloat")){
+            return new Threshold<>(name, printName, description, errorMessage, new PositiveFloat(Float.parseFloat(value)));
+        }
+        else if(thresholdType.equals("PositiveInteger")){
+            return new Threshold<>(name, printName, description, errorMessage, new PositiveInteger(Integer.parseInt(value)));
+        }
+        else if(thresholdType.equals("String")){
+            return new Threshold<>(name, printName, description, errorMessage, value);
+        }
+
+        return null;
+    }
+
 }

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/service/AntiPatternService.java

@@ -38 +38 @@
 
     AntiPattern setErrorMessages(AntiPattern antiPattern, List<String> wrongParameters);
 
-    AntiPattern getAntiPatternFromJsonFile(String fileName);
-
     String getDescriptionFromCatalogue(long id);
 }

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/service/AntiPatternServiceImpl.java

@@ -205 +205 @@
         return setErrorMessages(antiPatterns, wrongParameters).get(0);
     }
 
-    @Override
-    public AntiPattern getAntiPatternFromJsonFile(String jsonFileName){
-        String json = "";   // json configuration file
-        JsonNode node = null;
-        try {
-            json = new String(Files.readAllBytes(Paths.get(new FileSystemResource("").getFile().getAbsolutePath() + "\\src\\main\\webapp\\antipatterns\\" + jsonFileName)));
-            node = JsonParser.parse(json);
-        } catch (IOException e) {
-            e.printStackTrace();
-        }
-
-        Long APid = Long.parseLong(node.get("id").asText());
-        String APPrintName = node.get("printName").asText();
-        String APName = node.get("name").asText();
-        String APDescription = node.get("description").asText();
-        String APCatalogueFileName = node.get("catalogueFileName") != null ? node.get("catalogueFileName").asText() : null;
-
-        Map<String, Threshold> APMap = new HashMap<>();
-
-        JsonNode array = node.get("thresholds");
-        Threshold<?> tmpThreshold = null;
-
-        for(int i = 0; i < array.size(); i++){
-            JsonNode tmpNode = array.get(i);
-
-            String thresholdName = tmpNode.get("thresholdName").asText();
-            String thresholdType = tmpNode.get("thresholdType").asText();
-
-            JsonNode thresholdNode = tmpNode.get("threshold");
-
-            String tThresholdName = thresholdNode.get("thresholdName").asText();
-            String tThresholdPrintName = thresholdNode.get("thresholdPrintName").asText();
-            String tThresholdDescription = thresholdNode.get("thresholdDescription").asText();
-            String tThresholdErrorMess = thresholdNode.get("thresholdErrorMess").asText();
-            String tThresholdValue = thresholdNode.get("thresholdValue").asText();
-
-            tmpThreshold = getThreshold(thresholdType, tThresholdName, tThresholdPrintName, tThresholdDescription, tThresholdErrorMess, tThresholdValue);
-
-            APMap.put(thresholdName, tmpThreshold);
-        }
-
-        AntiPattern newAP = new AntiPattern(APid, APPrintName, APName, APDescription, APMap, APCatalogueFileName);
-
-        return newAP;
-    }
-
-    private Threshold<?> getThreshold(String thresholdType, String name, String printName, String description, String errorMessage, String value){
-
-        if(thresholdType.equals("Percentage")){
-            return new Threshold<>(name, printName, description, errorMessage, new Percentage(Float.parseFloat(value)));
-        }
-        else if(thresholdType.equals("PositiveFloat")){
-            return new Threshold<>(name, printName, description, errorMessage, new PositiveFloat(Float.parseFloat(value)));
-        }
-        else if(thresholdType.equals("PositiveInteger")){
-            return new Threshold<>(name, printName, description, errorMessage, new PositiveInteger(Integer.parseInt(value)));
-        }
-        else if(thresholdType.equals("String")){
-            return new Threshold<>(name, printName, description, errorMessage, value);
-        }
-
-        return null;
-    }
-
     @Override
     public String getDescriptionFromCatalogue(long id) {
         AntiPattern ap = this.getAntiPatternById(id).getAntiPatternModel();