Json imexport

.gitignore

@@ -5,3 +5,4 @@ ac_test_output/
 target/
 test-output/
 .DS_Store
+log_parser_output/

README.md

@@ -8,7 +8,11 @@ The basic method for using this library is, that you create a definition for you
 
 ![The Processes](diagrams/Log_Parser-Processes.png)
 
-## Defining a Parsing
+
+## Parse Definitions
+In order to parse logs you need to define a ParseDefinition. A ParseDefinition contains a set of ordered ParseDefinition Entries. While parsing a line of logs, the LogParser will see if all entries can be found in the line of logs. If that is the case, the line is stored according to the definitions.
+
+### Defining a Parsing
 Each Parse Definition consists of :
 - Title
 - A set of entries
@@ -21,7 +25,10 @@ Each entry for a Parse Definition allows us to define:
 - The start pattern of the string that will contain the value (null if in the start of a line)
 - The end pattern of the string that will contain the value (null if in the end of a line)
 - Case Sensitive search
-- Is to be kept. In some cases we just need to find a line with certain particularities, but we don't actually want to store the value
+- Is to be kept. In some cases we just need to find a line with certain particularities, but we don't actually want to store the value.
+
+### Import and Export
+You can import or store a Parse Definition to or from a JSON file.
 
 ## Using the Standard Method
 By default each entry for your lag parsing will be stored as a Generic entry. This means that all values will be stored as Strings. Each entry will have a :
@@ -41,11 +48,13 @@ Below is a diagram representing the class structure:
 
 ## Release Notes
 - 1.0.4 Snapshot
-  - #8  Added the filter function
-  - #13 Added copy constructors
-  - #13 Added a copy method in the StdLogEntry (#13)
+  - #6 We Can now import a definition from a JSON file. You can also export a ParseDefinition into a JSON file.
+  - #8 & #18  Added the filter function.
+  - #13 Added copy constructors.
+  - #13 Added a copy method in the StdLogEntry (#13).
   - #14 Added a set method to LogData. This allows you to change a Log data given a key value and ParseDefinition entry title
-  - Renamed exception IncorrectParseDefinitionTitleException to IncorrectParseDefinitionException
+  - Renamed exception IncorrectParseDefinitionTitleException to IncorrectParseDefinitionException.
+  - 
 - 1.0.3
   - Introduced the LogData Top Class. This encapsulates all results.
   - Introduced the LogDataFactory

diagrams/Log_Parser.drawio

@@ -1 +1 @@
-<mxfile host="Electron" modified="2021-04-28T07:47:19.788Z" agent="5.0 (Macintosh; Intel Mac OS X 11_2_3) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.5.1 Chrome/89.0.4389.82 Electron/12.0.1 Safari/537.36" etag="R9LsTS7Kjvs_fmLlblDj" version="14.5.1" type="device" pages="2"><diagram id="GF7U1PxuMcIbTAeL1bwN" name="Classes">5VnbcpswEP0aZtqHZAABth99TTNxM5kmvaRvMsigiYxcIcd2v76SkbgYEseOiTNpXqxdiZV0dPasIAboz1YXDM6jrzRAxLDNYGWAgWHblmV64kd61qmnLS3pCBkO1KDccYv/IuU0lXeBA5SUBnJKCcfzstOncYx8XvJBxuiyPGxKSXnWOQxRxXHrQ1L1/sQBj9QuXDP3f0E4jHi2YdUzgf5DyOgiVvMZNhht/tLuGdSx1PgkggFdFlxgaIA+o5Snrdmqj4jEVsOWPjd6ojdbN0Mxf8kDACU/uovrS5ddTcetPhqvv12eqSiPkCwUHjeQJWiApjjGHNNYrZ2vNV6bHSMZ0zRAbxlhjm7n0Je9S8EQ4Yv4jAjLEs3qGvWEiHG0KrjUmi8QnSHO1mKI6vUUfIpe+lyW+VlZGuGocE76MajoEWaBc4hEQ6G0B2LOLsSGsZ7mYNimNOZ9SijbPAtAB/RdT/oxIQW/olsTMNutU+PsVnC2KqCiOOhKCRAWnaO4DKLoVGpjiX33Eg4Z16MDDGc0Du4iHOsuPdbRjhGWC94cFwqEZKhpKeMRDWkMyTD39iDBoQg1IGgqgOlJ3LHQmK5yTyjndCYjrTD/JaOeu8q618sV7cFKTyiNtTIInCDSy9SmSABnZA2GzxDmSWIkdMF89Az8HSXFkIWIPycg6vwlRC/hmVYcxTOQWgwRyPFj+aDrKKXi3lAsNpQFdd0ye0Fni5XpdtVTRY3cCtSydgRK8agE2jA82+zhpG9VSG/YHpGMSuYwLpHf+7OQlaOXl6EzP2VAVwIaTj4JWAyZsmIp5lb7c/68aIXy19IziYWnk6X+j5B0UpELWSfNez2LNPK821hNJt7OhHL2zCfzvOWWOKsp/MqcytReh7UOzCm7vSPQEzmVB9ID6XSaoEbyrl3Ju1vOcBxuSvsI+py+tqQfoUSDrRPJbpYnq9GdCmxjGg4ghyfHym2/s2ujJn2JYoGA6wjXxQbwOj23rOqryZvVwuGKi0KWHFARJ4T6D+U66KVmobKV6mV9abJ2lKb6e2R2day9R+4uqCe5aVqgqaumed42nU6Vx95xKqTbOvGt8y0rpGVX0vECxYhhv17AjitPTmcLoXaNPFk18uQ2Jk+gqueITM823wGEcEuBSdVjwjJZEUhhlDSMlff+sPL+Cyn/QJJs7620rU6DSttyy684Byut52xdc9ovU1rBCbguDJvLAckzpcHZWjAw91rX1njRSFfQpOzfBVcdB89G369/r7vB+N6zb1DN92F1wz/iS1FF2mpI++KXogYv+sLMv9anAOf/EgHDfw==</diagram><diagram id="LirX-YWR1LI0kx1sx8zC" name="Processes">7VtRd6I4FP41PrYHCIh9HLW10+mc07POnm370hMhQrZA3Bir7q/fgAEMQcUOiM5OX2ouIZDvfvfej4t2wCBcjSic+d+Ji4KOobmrDhh2DEPXtS7/F1vWG0svHsUGj2JXTMoNY/wvEkZNWBfYRXNpIiMkYHgmGx0SRchhkg1SSpbytCkJ5KvOoIcUw9iBgWr9C7vMT3dh5/Z7hD0/vbLevdkcmUDn3aNkEYnrdQxwl/xtDocwXUtsdO5Dlyy3TOC2AwaUELb5FK4GKIixTWFzPXhvgWA9Cd9v70Z9y3Dm9tVmsbtjTsl2SFHE6l3a6Im9sXWKJ3I5vGJIKPOJRyIY3ObWfoIZipfV+Cif80jIjBt1bvwbMbYWXIELRrjJZ2EgjqIVZs9bn1/ipa4tMRquxMrJYJ0OIkbXz9uDzVmGlY7z85JRemIAJyjoZ74ekIDQZKept0F/SiK2ZQc3YGB1ub0i7sI/c7KgDtoHtggsBqmH9i2Ycjd2xRbJhV9HiISI75BPoCiADH/IkQBFQHnZvJwV/IMgxjEkEff9AYOFuNQTpHPETUM0xRFmmEQKj2SWLH3M0HgGE4CWPBPJjMhiS6/mseM884EoQ6u9SIqjNyLWRS7U09hf5pkls/lbWaWrNYV9V8FeQTqGaXYS3LIsDifpxbVj8AS6peKpGyqedq8pPK3DeM4ZJe9ZMTEUps7ieeHKi+vp9TQgS8eHlF27xFmEHFdjB93nm3QoUlZDjM/4UpnyKfwp5Xuqh7STMt787SHZQ5bsoJKUdFoHAcVBj8Sb4oCrwFYc1YpvWoPftC5dsh1SbLvkWO317bBisysqNtM4L8Vml4XoEDJ4Bx1GxBUuXq0ZtiwvDN1uWa4BVV6MEnVmaP31fr38iwVxMnpCFHNgET27yE4D9mBkA7PuyBanPhHMd5JxuVvkslXg6GZL4qwCTbPb+AnmqirrhIzMWfiydaSckSd7oG/a5ZZecHnPqOTy4xfasLw57qiSfTvr1aMJeRYJcQRZ7NRyUXgmVck2KlSl00pGtYEj5MCvoQNMcG46wDQvpr7zQbFM76r59gUpd7NifW+v1/rqjLtwFI7ejB8Df8jCEYxAtr/z501r/fiCpz5HmlLwSzRh6bxemww512Z8SbO4mmN2dyZv5M6XVdb6aiqtl2Kvdr4UpI9uxldusteOp62dsBtfiudlt3oPMH43g86xF196t5f9sqR+/7TXiS+9WfXd4IU04mv0TGvg25eu1BoX880JtV5Foaa3qtR6SniOGcWRl+i1Fhvx9Ss1YMuZsaud8AG83POtPkidtJ35yTCrv4OtF0hgf7KdeXCh+tqZe7KGFLjfeeQZXRgmyp5D2/+GOBJ8eW3M3KyXJiZ4LPPNpQe2Bc4usG8upu6eVWetuWJsVSzG7XZNtP9PMbbkp0hgn7Bt8vbPEL+yh+H9G/ry8Ocr+OOrPbnSFGDPtBb/RJTlkb3VAn2RYrk8sl0495N96vXGauUvtOyJl9o1gmHKb2qyNzfHagRTkxcCRfLWpxFKKd2OvMw5JlFMb6545FFkb4eRtjeMmqL03sxe8TtatVO6+PJRYWJVShe/LN3gW3wdes9frbH1qD38WFy9fMPIHF+VVEgczoL4zcITJQ6aq10lXrmYTFEYYC/inwM0jY/E1Q07MPgizCF23SQWymqpHB8xaUUkcEEuxuLSLVfYYhLrqQXWKCuwRg0FttR1uuo6BiMXUve38w44r9uc7/gw/3XYJkrzn+CB2/8A</diagram></mxfile>
+<mxfile host="Electron" modified="2021-05-02T09:48:11.002Z" agent="5.0 (Macintosh; Intel Mac OS X 11_2_3) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.5.1 Chrome/89.0.4389.82 Electron/12.0.1 Safari/537.36" etag="AATw7p0fba_PmMM8O1gx" version="14.5.1" type="device" pages="2"><diagram id="GF7U1PxuMcIbTAeL1bwN" name="Classes">5Vlbc9sqEP41nul5SEZ3RY++5nSSdjwnaU9zXjpYwhITDC7CtZ1fX5BAF0uxEx8rzrR+MbugZfnY/Rahnj1cbK4ZWCafaARxzzKiTc8e9SzLNA1P/EnNNtdcSUkqYoYiNahU3KEnqJSG0q5QBNPaQE4p5mhZV4aUEBjymg4wRtf1YXOK67MuQQwbirsQ4Kb2XxTxRK3CNUr93xDFCS8WrHpmIHyMGV0RNV/PsifZL+9eAG1LjU8TENF1RWWPe/aQUcrz1mIzhFhiq2HLn5s801v4zSDhL3nAhunX/urzR5fdzG/9Ibzd/vPxQln5CfBK4TEFLIUjOEcEcUSJ8p1vNV7ZiqG0afTswTpBHN4tQSh71yJChC7hCywkUzSbPuoJIeNwU1Epn68hXUDOtmKI6vUVfCq8zEDJ63KzTA1xUtkoT+mAio+4sFxiJBoKpldA5hyCbEz0NEfjNqeEDymmLHvWtgN76HpSjzCu6FW8dYGzY54bZ7eBs9kAFZKoLzlASHQJSR1E0anoxhTrHqQcMK5HRwgsKInuE0R0lx7raMUESYez7YKR4Aw1LWU8oTElAI9L7QBgFAtTIwznApiBxB0Jkukr9YxyThfS0gbxb9LqpaukB+2uaI82ekIpbJWAwQziQUE31QBwJuZovCdgng2MlK5YCPfAHyguBiyGfB+DqP2XEL0kzjTlqDizc4lBDDj6Wd/otpBSdqcUiQUVRl2vHr2uvROV+XLVU1WS3DHkWwcM5Xg0DGURXiz2+KD3G0HfszwsIypdAlILfu/HSpaOQVmHLsI8AvoS0Hj2wXJFDgn/hSvGTvuv8nnRiuW/qWcSjueT5frfIekkI1eyTooPehYplHmXSV0m3sGEcl6ZT8al79ZLpHGSnDLteipY7pE5ZQUHDD2TU6UhPZDO5ynsJO+uGnl3xxkicVbaJyDk9P+W9BOUaHtnRwr5bDU6aMB2S+MR4ODsWLnBezs36rSsxVgk8DrBebEDwGzv7IA1X07erBiON1xUsvSIkjjDNHysF0IvFyulrVYw22uTeaA2tR8ki7Nj60HycEU9y1HTtLs6axqXV4YTNOPYO02JdK/OfOx8yxJpWo10vIYEMhS2E9iJ6cnYQchqoSezhZ52Dxunoye7yecQzy+yiwBB3NLBnD1mrKAVgRSCacdY+e8PK++PoPLfiJKtVzOtH3TItL5Xf8c5mmk9t54bjvUyphUxAbaVYUs5IN1TGty6w45vvM6v+njRyD3okvbvo5vAQYvJl8//bfvR7YNnTWHLDbE64p/wrahBbS1B+2zoOTtvRW960n96+jabksT4Tr4nbHjz4ya4nx6+VD8JdHt4QV8Lp5zRR1jpMbLfnotkySSa68zKDUsoNgOy02yYZb23DWuebESMZ3vG/tA92r1q8LvbIiGWH8Fy1iq/NNrjXw==</diagram><diagram id="LirX-YWR1LI0kx1sx8zC" name="Processes">7Vxde6I4FP41XtoHCB962dZqp9PZ7a6zz7ZzM0+EFNkB4mCc2vn1GyCRj0TFFgRn7E3JIQRy3vd85BDsgetgPYngYv4JO8jvaYqz7oFRT9NUVTHpv1jymkoGcSsWuJHnsE6ZYOr9REyoMOnKc9Cy0JFg7BNvURTaOAyRTQoyGEX4pdjtGfvFuy6giwTB1Ia+KP3Xc8icz8LK5LfIc+f8zqo5TM/MoP3NjfAqZPfraWCc/KWnA8jHYhNdzqGDX3IicNMD1xHGJD0K1tfIj3XL1ea48NYA/uss+HYznlwZmr20+ulg40Mu2cwwQiGpd2htwOZGXrk+kUPVy5o4InPs4hD6N5n0KtEZiodVaCvrc4/xggpVKvwPEfLKuAJXBFPRnAQ+O4vWHnnMHT/FQ10YrDVas5GTxitvhCR6fcw30qs0g7ez65IWv9CHM+RfbbC+xj6OkplytMHVMw5JTg6G4Nowqbyi3hk+S7yKbLRL2cywCIxctGtAzt0YihzJGa4ThANEZ0g7RMiHxPtRtATIDMrd9MtYQQ8YMeQkGT/+delPHr/3H57QOLy1Q6I+9fnAP6C/4iRZLyju3eGOVpU8F4oyLBJIV8EeBiWtBxR5VJ0oYkIHLufJPNRqHFuSCH9DuTNK8sfYx6arqhvWlbBvmIZS3NXhkVi38zFzrHuA0RJR0Qg9e6FHPBwKDCzy62XuETRdwEQfLzT+Fbm08egVMTwMiB8oImjd22W/7KxmshDDQrAKWPslC2gqD0PzXDDj19WufN3ojm2/LS7sCwvbfH7tNNhvj1bFsKBrbYWFnc+dM9B77I4ggWNoE8zucPLGqetF49T4vFszTmAIip9QtSyo6Cp+8J5m+vQZrmYRPXLjo7zDVG5CIsHmFzNvaczujs1zU95r80Cv2+bZpQ/YozPZsNxSSiwvszedEruqRODNY7yD01qbjMxY+JQ7I2fk0dYTTUNuDkqQD7VKkB8+UMry5rij7/SHJVqliTgvFWhC0FnE/YK1G1dLLp59/GLPYUQuqBcJvBCSGFRp6OpKvBoYpWRSlSSTSkPxSr6OEBMFHqJiSynAY35fYX6iv0zs9pJ2UNXFOjvJw9rY82PnflDYS/vQeaS3Tjv+ltGwtkWrdoRFqyxgyslmtpkT88cUc+JfIxk2y2lC68mwrrdivFsM0Wpw2Sl3GGCg7XYZtFG2/LfbptTk9Iq5bP1lTXk+AkrlFGAaTeWyX+ypCSfB5Kv2+Xo+IsEEhmCjt5MNJ83X1GsJFFLlS+KEtN/gSGFCXlFXhDBxshX1wzKRkyibVyWWPAE5FrN2PWXniuZCilEVme1F89I6x5Stc5pKRaS6t7pjvR2tmTdnnYOKbr9d6xwI1jklkRe6iY22WDWv3zp1ULROSzniQkGOfKtp2VErjG80s9oTcYMn3pwExhsrjHsHqq/CuMNrFAz3E7U8zYRBbH9JSekjopqgwytT4mzW/KyDvMh0koZtDDtn2MNWDLvFCoByMRzWVASoJSJL8+CqEfm9AVnuMbTSW9sBaOx9ljwPF1d4v2qoNzStoGowOGIi/vX7yPtC7ka3X9Hl3T9fwN8frFlfERTb0Uj/Hl+QbWnLyjVPBY9TYQVeoxOovLdlh73U7gZ0tegGNps5Ds5ArFJN0SoNVF8GIqV0O8lrxrECxdQ9FKslxFl5M1J2mlFTlN7p2Stu16r/tb2yh4lVKa2XyuQNvrZXofv4wZga98rd51X/6aOH9GlfEiG9YOHHtaqHCNtouRQ4TyMXKVIU+p4b0mMfPcdn4ujm2dC/ZOLAc5zEFmSxtGgf+XrigLfZrdteTBeBMnQxwGqyAKvVEGCl0IkbwqcEhg6MnDN4e8Azj4idNC83BewEpNx098wWfbAPeeCMd1dq0VN5EzRQJGmkqkvSSLMhTYnbigRN8f1CDrZXQTL7fVn7LOXt/cyvTs0dL0E8399WH8rbQ8nSKnF9O3u2Ysjh2Ww9EhGU7TwyjIYQBGcED0TQKkaalvHTBPzusUsFY89HYoA5BSi1HJQ2fca4HFM/mK0BJtvp14ngYoACsa1h28FFrCifJJ9rdU3WSQWX4RnBAxHsVnBRxQXoObpUQbM9xMR84EPQrW1TzWy8qHWrdlPVMjlk/Cch9m4OfW+17H3MEisad9M///jNnMAbEqtSWVzVBhcSv65KvIQJmsJSXLefvcTB2ymP6yWA6CW2b29szUmI5YSzk3iDkzCVDjgJsQxa+JqsDGmnPhqsH6HyR4NAUqY+8keD4gL5bGzVtmOUllkyKI9ra+JK+QxlJSj5V/F8E1NzSNJm9ktm6Rve7OfiwM3/</diagram></mxfile>

pom.xml

@@ -331,5 +331,16 @@
             <version>2.1</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.11.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>3.0.0</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

src/main/java/com/adobe/campaign/tests/logparser/LogData.java

@@ -321,7 +321,7 @@ public LogData<GenericEntry> groupBy(String in_parseDefinitionEntryKey)
      * @return a new LogDataObject containing only the filtered values
      *
      */
-    public LogData<T> filter(Map<String, Object> in_filterKeyValues) {
+    public LogData<T> filterBy(Map<String, Object> in_filterKeyValues) {
         LogData<T> lr_filteredLogData = new LogData<>();
 
         for (String lt_logDataKey : this.getEntries().keySet()) {

src/main/java/com/adobe/campaign/tests/logparser/LogParser.java

@@ -0,0 +1,19 @@
+/**
+ * MIT License
+ *
+ * © Copyright 2020 Adobe. All rights reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package com.adobe.campaign.tests.logparser;
+
+public abstract class LogParser {
+
+    public static final String OUTPUT_ROOT = "log_parser_output";
+    public static final String OUTPUT_DIR = OUTPUT_ROOT + "/" + "data";
+
+}

src/main/java/com/adobe/campaign/tests/logparser/ParseDefinition.java

@@ -19,6 +19,8 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
 /**
  * The main class for analyzing logs. It gathers a list of Pars Definiton
  * Entries and allows for defining high level definitions of how the gathered
@@ -42,6 +44,10 @@ public class ParseDefinition {
     protected static final String STD_DATA_FREQUENCE = "frequence";
     protected static final String STD_DATA_KEY = "key";
 
+    public ParseDefinition() {
+        super();
+    }
+
     /**
      * The main constructor for the ParseDefiition
      * 
@@ -55,7 +61,7 @@ public ParseDefinition(String in_title) {
         definitionEntries = new ArrayList<>();
         keyOrder = new ArrayList<>();
     }
-    
+
     public ParseDefinition(ParseDefinition in_oldParseDefinition) {
         super();
         this.title = in_oldParseDefinition.title;
@@ -72,8 +78,8 @@ public ParseDefinition(ParseDefinition in_oldParseDefinition) {
      * Author : gandomi
      *
      * @param in_parseDefinitionEntry
-     *        a {@link ParseDefinitionEntry} which represents a step in the rules for
-     *        analyzing a line.
+     *        a {@link ParseDefinitionEntry} which represents a step in the
+     *        rules for analyzing a line.
      *
      */
     public void addEntry(ParseDefinitionEntry in_parseDefinitionEntry) {
@@ -198,9 +204,10 @@ public void defineKeys(List<ParseDefinitionEntry> in_keyOrderDefinitions) {
      */
     public void defineKeys(ParseDefinitionEntry in_parseDefinitionAsKey) {
         defineKeys(Arrays.asList(in_parseDefinitionAsKey));
-        
+
     }
 
+    @JsonIgnore
     public String getPrintOutPadding() {
         return printOutPadding;
     }

src/main/java/com/adobe/campaign/tests/logparser/ParseDefinitionEntry.java

@@ -11,6 +11,8 @@
  */
 package com.adobe.campaign.tests.logparser;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
 /**
  * This class allows for the definition of one rule that allows you to extract
  * one piece of data from a string.
@@ -192,6 +194,7 @@ public void setEndEOL() {
      *         null)
      *
      */
+    @JsonIgnore
     public boolean isEndEOL() {
 
         return getEnd() == null;
@@ -232,6 +235,7 @@ public String fetchAppliedSensitivity(String in_string) {
      *         line. (I.e. if start is null)
      *
      */
+    @JsonIgnore
     public boolean isStartStartOfLine() {
 
         return getStart() == null;