Update documentation for SQuelized 1.1

SamuelAl · Nov 13, 2020 · f35981d · f35981d
1 parent 842cf3b
commit f35981d
Show file tree

Hide file tree

Showing 159 changed files with 91,390 additions and 0 deletions.
diff --git a/distribution/SQuelized-2/download/SQuelized.zip b/distribution/SQuelized-2/download/SQuelized.zip
diff --git a/distribution/SQuelized-2/download/SQuelized/examples/example_1/example_1.pde b/distribution/SQuelized-2/download/SQuelized/examples/example_1/example_1.pde
@@ -0,0 +1,28 @@
+import samuelal.squelized.*;
+
+
+void setup() {
+
+  // Update the url to the chinook sample database for this to work
+  // you can download chinook sample database from 
+  // https://www.sqlitetutorial.net/sqlite-sample-database/
+  // more examples and documentation at https://samuelal.github.io/squelized.github.io/documentation/docs-main.html
+
+  SQLConnection myConnection = new SQLiteConnection("jdbc:sqlite:C:/chinook/chinook.db");
+
+  Table testTable = myConnection.getTable("employees");
+  printTable(testTable);
+
+}
+
+void printTable(Table table) {
+
+  for (TableRow row : table.rows())
+  {
+    for (int i = 0; i < row.getColumnCount(); i++)
+    {
+      System.out.print(row.getString(i) + "  ");
+    }
+    System.out.println();
+  }
+}
diff --git a/distribution/SQuelized-2/download/SQuelized/library.properties b/distribution/SQuelized-2/download/SQuelized/library.properties
@@ -0,0 +1,57 @@
+# More on this file here: https://github.com/processing/processing/wiki/Library-Basics
+# UTF-8 supported.
+
+# The name of your Library as you want it formatted.
+name = SQuelized
+
+# List of authors. Links can be provided using the syntax [author name](url).
+authors = [Samuel Alarco Cantos](https://samuelal.github.io/squelized.github.io/index.html)
+
+# A web page for your Library, NOT a direct link to where to download it.
+url = https://samuelal.github.io/squelized.github.io/index.html
+
+# The category (or categories) of your Library, must be from the following list:
+#   "3D"            "Animation"     "Compilations"      "Data"          
+#   "Fabrication"   "Geometry"      "GUI"               "Hardware"      
+#   "I/O"           "Language"      "Math"              "Simulation"    
+#   "Sound"         "Utilities"     "Typography"        "Video & Vision"
+# 
+# If a value other than those listed is used, your Library will listed as 
+# "Other". Many categories must be comma-separated.
+categories = Data
+
+# A short sentence (or fragment) to summarize the Library's function. This will 
+# be shown from inside the PDE when the Library is being installed. Avoid 
+# repeating the name of your Library here. Also, avoid saying anything redundant 
+# like mentioning that it's a Library. This should start with a capitalized 
+# letter, and end with a period.
+sentence = A library to facilitate the connection between Processing and SQL databases.
+
+# Additional information suitable for the Processing website. The value of
+# 'sentence' always will be prepended, so you should start by writing the
+# second sentence here. If your Library only works on certain operating systems,
+# mention it here.
+paragraph =  
+
+# Links in the 'sentence' and 'paragraph' attributes can be inserted using the
+# same syntax as for authors. 
+# That is, [here is a link to Processing](http://processing.org/)
+
+# A version number that increments once with each release. This is used to 
+# compare different versions of the same Library, and check if an update is 
+# available. You should think of it as a counter, counting the total number of 
+# releases you've had.
+version = 2  # This must be parsable as an int
+
+# The version as the user will see it. If blank, the version attribute will be 
+# used here. This should be a single word, with no spaces.
+prettyVersion = 1.1.0  # This is treated as a String
+
+# The min and max revision of Processing compatible with your Library.
+# Note that these fields use the revision and not the version of Processing, 
+# parsable as an int. For example, the revision number for 2.2.1 is 227. 
+# You can find the revision numbers in the change log: https://raw.githubusercontent.com/processing/processing/master/build/shared/revisions.txt
+# Only use maxRevision (or minRevision), when your Library is known to 
+# break in a later (or earlier) release. Otherwise, use the default value 0.
+minRevision = 0
+maxRevision = 0
diff --git a/distribution/SQuelized-2/download/SQuelized/library/SQuelized.jar b/distribution/SQuelized-2/download/SQuelized/library/SQuelized.jar
diff --git a/distribution/SQuelized-2/download/SQuelized/library/core.jar b/distribution/SQuelized-2/download/SQuelized/library/core.jar
diff --git a/distribution/SQuelized-2/download/SQuelized/library/mysql-connector-java-8.0.20.jar b/distribution/SQuelized-2/download/SQuelized/library/mysql-connector-java-8.0.20.jar
diff --git a/distribution/SQuelized-2/download/SQuelized/library/postgresql-42.2.14.jar b/distribution/SQuelized-2/download/SQuelized/library/postgresql-42.2.14.jar
diff --git a/distribution/SQuelized-2/download/SQuelized/library/sqlbuilder-3.0.0.jar b/distribution/SQuelized-2/download/SQuelized/library/sqlbuilder-3.0.0.jar
diff --git a/distribution/SQuelized-2/download/SQuelized/library/sqlite-jdbc-3.30.1.jar b/distribution/SQuelized-2/download/SQuelized/library/sqlite-jdbc-3.30.1.jar
diff --git a/distribution/SQuelized-2/download/SQuelized/reference/allclasses-index.html b/distribution/SQuelized-2/download/SQuelized/reference/allclasses-index.html
@@ -0,0 +1,200 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (11.0.7) on Fri Nov 13 14:48:06 GMT 2020 -->
+<title>All Classes</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="dc.created" content="2020-11-13">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
+<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
+<!--[if IE]>
+<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
+<![endif]-->
+<script type="text/javascript" src="jquery/jquery-3.4.1.js"></script>
+<script type="text/javascript" src="jquery/jquery-ui.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+    try {
+        if (location.href.indexOf('is-external=true') == -1) {
+            parent.document.title="All Classes";
+        }
+    }
+    catch(err) {
+    }
+//-->
+var data = {"i0":4,"i1":2,"i2":2,"i3":2,"i4":2,"i5":2};
+var tabs = {65535:["t0","All Classes"],2:["t2","Class Summary"],4:["t3","Enum Summary"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+var pathtoroot = "./";
+var useModuleDirectories = true;
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<header role="banner">
+<nav role="navigation">
+<div class="fixedNav">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a id="navbar.top">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.top.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="samuelal/squelized/package-summary.html">Package</a></li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-files/index-1.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="allclasses.html">All&nbsp;Classes</a></li>
+</ul>
+<ul class="navListSearch">
+<li><label for="search">SEARCH:</label>
+<input type="text" id="search" value="search" disabled="disabled">
+<input type="reset" id="reset" value="reset" disabled="disabled">
+</li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_top");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+</div>
+<a id="skip.navbar.top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+</div>
+<div class="navPadding">&nbsp;</div>
+<script type="text/javascript"><!--
+$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
+//-->
+</script>
+</nav>
+</header>
+<main role="main">
+<div class="header">
+<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
+</div>
+<div class="allClassesContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="typeSummary">
+<caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Enum Summary</a></span><span class="tabEnd">&nbsp;</span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Class</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><a href="samuelal/squelized/DatabaseType.html" title="enum in samuelal.squelized">DatabaseType</a></td>
+<th class="colLast" scope="row">
+<div class="block">Enum for database connection types</div>
+</th>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><a href="samuelal/squelized/MySQLConnection.html" title="class in samuelal.squelized">MySQLConnection</a></td>
+<th class="colLast" scope="row">
+<div class="block">Represents connection to a MySQL database.</div>
+</th>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><a href="samuelal/squelized/PostgreSQLConnection.html" title="class in samuelal.squelized">PostgreSQLConnection</a></td>
+<th class="colLast" scope="row">&nbsp;</th>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><a href="samuelal/squelized/QueryBuilder.html" title="class in samuelal.squelized">QueryBuilder</a></td>
+<th class="colLast" scope="row">
+<div class="block">Helper class to support CRUD database operations
+ using SqlQueryBuilder library</div>
+</th>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><a href="samuelal/squelized/SQLConnection.html" title="class in samuelal.squelized">SQLConnection</a></td>
+<th class="colLast" scope="row">
+<div class="block">Main class that represents and abstract SQL database
+ connection.</div>
+</th>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><a href="samuelal/squelized/SQLiteConnection.html" title="class in samuelal.squelized">SQLiteConnection</a></td>
+<th class="colLast" scope="row">
+<div class="block">Represents connection to SQLite database.</div>
+</th>
+</tr>
+</table>
+</li>
+</ul>
+</div>
+</main>
+<footer role="contentinfo">
+<nav role="navigation">
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a id="navbar.bottom">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.bottom.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="samuelal/squelized/package-summary.html">Package</a></li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-files/index-1.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="allclasses.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_bottom");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+</div>
+<a id="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</nav>
+</footer>
+</body>
+</html>
diff --git a/distribution/SQuelized-2/download/SQuelized/reference/allclasses.html b/distribution/SQuelized-2/download/SQuelized/reference/allclasses.html
@@ -0,0 +1,33 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (11.0.7) on Fri Nov 13 14:48:06 GMT 2020 -->
+<title>All Classes</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="dc.created" content="2020-11-13">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
+<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
+<!--[if IE]>
+<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
+<![endif]-->
+<script type="text/javascript" src="jquery/jquery-3.4.1.js"></script>
+<script type="text/javascript" src="jquery/jquery-ui.js"></script>
+</head>
+<body>
+<h1 class="bar">All&nbsp;Classes</h1>
+<main role="main" class="indexContainer">
+<ul>
+<li><a href="samuelal/squelized/DatabaseType.html" title="enum in samuelal.squelized">DatabaseType</a></li>
+<li><a href="samuelal/squelized/MySQLConnection.html" title="class in samuelal.squelized">MySQLConnection</a></li>
+<li><a href="samuelal/squelized/PostgreSQLConnection.html" title="class in samuelal.squelized">PostgreSQLConnection</a></li>
+<li><a href="samuelal/squelized/QueryBuilder.html" title="class in samuelal.squelized">QueryBuilder</a></li>
+<li><a href="samuelal/squelized/SQLConnection.html" title="class in samuelal.squelized">SQLConnection</a></li>
+<li><a href="samuelal/squelized/SQLiteConnection.html" title="class in samuelal.squelized">SQLiteConnection</a></li>
+</ul>
+</main>
+</body>
+</html>