diff --git a/EAR diagrams/FoodChain.eap b/EAR diagrams/FoodChain.eap index 961ec32..c99f1ee 100644 Binary files a/EAR diagrams/FoodChain.eap and b/EAR diagrams/FoodChain.eap differ diff --git a/src/main/java/cz/cvut/fel/sit/omo/foodchain/FoodChain.java b/src/main/java/cz/cvut/fel/sit/omo/foodchain/FoodChain.java index 843d32b..798b7ed 100644 --- a/src/main/java/cz/cvut/fel/sit/omo/foodchain/FoodChain.java +++ b/src/main/java/cz/cvut/fel/sit/omo/foodchain/FoodChain.java @@ -19,11 +19,18 @@ import java.util.logging.Level; import java.util.logging.LogManager; import java.util.logging.Logger; +/** + * Main application class + */ public class FoodChain { private static FactoryManager factoryManager = new FactoryManager(); + /** + * Main application method that parses configuration and starts Ticker. + * @param args args + */ public static void main(String[] args) { LogManager.getLogManager().reset(); @@ -67,6 +74,12 @@ public class FoodChain return factoryManager; } + /** + * Provides connection between FoodChain and ConfigurationParser. + * @param path file path + * @param rootElementTag tag to be parsed + * @return parser result + */ public static ParserResult parseDocument(String path, String rootElementTag) { try @@ -82,6 +95,10 @@ public class FoodChain return ConfigurationParser.getElements(rootElementTag); } + /** + * Parses channels. + * @param path file path + */ public static void parseChannels(String path) { ParserResult parserResult = parseDocument(path, "channel"); @@ -93,6 +110,10 @@ public class FoodChain } } + /** + * Parses nodes. + * @param path file path + */ public static void parseNodes(String path) { ParserResult parserResult = parseDocument(path, "node"); @@ -104,6 +125,10 @@ public class FoodChain } } + /** + * Parses products. + * @param path file path + */ public static void parseProducts(String path) { ParserResult parserResult = parseDocument(path, "product"); @@ -115,6 +140,10 @@ public class FoodChain } } + /** + * Parses scenarios. + * @param path file path + */ public static void parseScenarios(String path) { ParserResult parserResult = parseDocument(path, "scenario"); diff --git a/src/main/java/cz/cvut/fel/sit/omo/foodchain/util/ReportLogger.java b/src/main/java/cz/cvut/fel/sit/omo/foodchain/util/ReportLogger.java index f1b85b3..d5c31ff 100644 --- a/src/main/java/cz/cvut/fel/sit/omo/foodchain/util/ReportLogger.java +++ b/src/main/java/cz/cvut/fel/sit/omo/foodchain/util/ReportLogger.java @@ -4,8 +4,15 @@ import java.util.logging.Handler; import java.util.logging.Level; import java.util.logging.LogRecord; +/** + * Custom Logger used for TransactionReport + */ public class ReportLogger extends Handler { + /** + * Logs message and prints it out. + * @param record message to be printed + */ @Override public void publish(LogRecord record) { StringBuilder sb = new StringBuilder(); diff --git a/src/main/java/cz/cvut/fel/sit/omo/foodchain/util/Singleton.java b/src/main/java/cz/cvut/fel/sit/omo/foodchain/util/Singleton.java index ea49dbc..881809b 100644 --- a/src/main/java/cz/cvut/fel/sit/omo/foodchain/util/Singleton.java +++ b/src/main/java/cz/cvut/fel/sit/omo/foodchain/util/Singleton.java @@ -6,7 +6,7 @@ import java.util.HashMap; import java.util.Map; /** - * Singleton implementation 1 of 3 + * Singleton helper class */ public class Singleton {