- documentation (not finished yet)

Author: teceP

src/main/java/analyzer/CSSAnalyzeInterface.java

@@ -1,29 +1,20 @@
 package analyzer;
 
 import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-
-import org.w3c.css.sac.InputSource;
-
-
-import creator.CSSCreator;
 import git.GitProvider;
 import logger.Logger;
 import storage.StorageAdmin;
 import storage.StorageAdminInterface;
 
-public class CSSAnalyzer implements CSSAnalyzeInterface, Runnable {
+public class CSSAnalyzer implements Runnable {
 
     /**
      * GITHUB Cloned folder. NOT css style folder!
@@ -40,6 +31,10 @@ public class CSSAnalyzer implements CSSAnalyzeInterface, Runnable {
      */
     private List<File> files;
 
+    /**
+     * Runs the GitProvider, which will download the latest git repo with css-styles.
+     * Will collect all CSS Files and store it to the artifact folder.
+     */
     public CSSAnalyzer() {
         files = new ArrayList<File>();
         this.stylesFolder = "osm-styles";

src/main/java/analyzer/CSSAnalyzer.java

@@ -5,34 +5,63 @@
 import java.sql.SQLException;
 import java.util.ArrayList;
 import java.util.List;
-
 import logger.Logger;
 import models.MyTable;
 import psql.PostgreConnection;
 import storage.StorageAdmin;
 import storage.StorageAdminInterface;
 
 public class DBAnalyzer {
-	
+
+	/**
+	 * PostgreConnection
+	 */
 	private PostgreConnection connection;
+
+	/**
+	 * List of database tables
+	 */
 	private List<MyTable> tables;
-	
+
+	/**
+	 * DatasetMeta of database
+	 */
 	private DatabaseMetaData md;
+
+	/**
+	 * ResultSet for the tables of the given database
+	 */
 	private ResultSet rsTables;
+
+	/**
+	 * ResultSet for the columns of a specific table, in a given database
+	 */
 	private ResultSet rsColumns;
-	
-	private int counter;
-	
+
+	/**
+	 * Analyzes the database for tables and column of these tables.
+	 * Stores informations in the artifact folder.
+	 *
+	 * @param connection
+	 */
 	public DBAnalyzer(PostgreConnection connection) {
 		this.connection = connection;
 		this.tables = new ArrayList<MyTable>();
-		counter = 1;
 	}
 
 	public void start() {
 		this.getTables();
 	}
-	
+
+	/**
+	 * Collects all tables from the database under a specific schema.
+	 * Schema was set in the databaseconfig file, which will be anaylized after the
+	 * program starts.
+	 *
+	 * Databaseconfigfile = first parameter/argument
+	 *
+	 * @return
+	 */
 	private boolean getTables() {
 		Logger.log("**************************************");
 		Logger.log("Getting tablenames and colomnnames...");
@@ -57,21 +86,28 @@ private boolean getTables() {
 				}
 
 				this.tables.add(tempTable);
-				Logger.log("Added " + counter + " tables.");
-				counter++;
+				Logger.log("Added " + this.tables.size() + " tables.");
 				}
 
 			this.storeData();
 
 		} catch (SQLException e) {
-			// TODO Auto-generated catch block
 			e.printStackTrace();
 			return false;
 		}
 
 		return true;
 	}
 
+	/**
+	 * Converts the tableslist, to a list of strings, just with the name of the tables.
+	 * Calls the StorageAdmin, to store this data.
+	 *
+	 * TODO
+	 * Collect also the column names.
+	 * Use the StorageAdminHelper and implement in this class a new helpermethod.
+	 *
+	 */
 	public void storeData(){
 		StorageAdminInterface sa = new StorageAdmin();
 		List<String> tableNames = new ArrayList<>();
@@ -82,8 +118,5 @@ public void storeData(){
 
 		sa.storeList(tableNames, StorageAdminInterface.TABLE_NAMES, true);
 	}
-	
-	public List<MyTable> tables(){
-		return this.tables;
-	}
+
 }

src/main/java/analyzer/DBAnalyzer.java

@@ -5,15 +5,22 @@
 import models.Match;
 
 public class CSSCreator implements Runnable {
-	
-	private Match[] accordances;
-	
-	public CSSCreator(Match[] accordances) {
-		File folder = new File("output");
-		folder.mkdir();
-		
-		this.accordances = accordances;
-	}
+
+
+	/**
+	 * TODO
+	 *
+	 * Implement: this class should be able, to generate
+	 * all the CSS files, which should be modified, as they can
+	 * be used for the geoserver, in connection with the database of is.
+	 *
+	 * CSSClasses / Files needs the same name as the tables in the database are named.
+	 *
+	 * Hint: Store the Matches out of the artifact folder.
+	 * 		 For this, you can use the StorageAdmin-Method: stringToList(CSSIdentifier.MATCHES, ...)
+	 * 		 and the StorageAdminHelper-Method: stringToMatch(..)
+	 *
+	 */
 
 	@Override
 	public void run() {

src/main/java/creator/CSSCreator.java

@@ -1,32 +1,42 @@
 package enumerations;
 
 /**
- * Contains several important CSS identifiers/rules
- * @author Mario
+ * Contains several CSS identifiers/rules
+ *
+ * You can use this in the FileAnalyzer, to scan the files for this identifiers.
+ *
+ * @author Mario Teklic
  *
  */
 public enum CSSIdentifier {
-	
-	//Its important to let these whitespaces in the enums, because other methods will directly start to scan for the class/type/... value
 
 	/*
 	 * TODO:
 	 * Should add identifiers like "... and type in ..." to get more precise results
+	 * If you add new identifiers, you also need to scan for them.
+	 * For this you need the checkForMatches()-method, which calls the scanFile(...) method.
+	 * Both methods are in the FileAnalyzer.
+	 *
 	 */
 
-	/**
-	 * CSS Rules:
-	 */
+
 	CLASSNAME("[class = '"),
 	TYPE("[type = '"),
 	AND_TYPE_IN("and type in");
-	
+
+	/**
+	 * Identifier
+	 */
 	private String identifier;
 
 	CSSIdentifier(String identifier) {
 		this.identifier = identifier;
 	}
 
+	/**
+	 * Returns the identifier
+	 * @return
+	 */
 	public String getString() {
 		return this.identifier;
 	}

src/main/java/enumerations/CSSIdentifier.java

@@ -1,8 +1,6 @@
 package git;
 
 import java.io.File;
-import java.nio.file.Paths;
-
 import org.eclipse.jgit.api.Git;
 import org.eclipse.jgit.api.errors.GitAPIException;
 import org.eclipse.jgit.api.errors.JGitInternalException;

src/main/java/exceptions/WrongClassException.java

@@ -3,7 +3,6 @@
 import models.CssClass;
 import models.Match;
 import models.MyTable;
-
 import java.io.File;
 import java.util.ArrayList;
 import java.util.List;