<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="sv"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:55 CET 2014 --> <title>Database</title> <meta name="date" content="2014-11-16"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title = "Database"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-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"> <li><a href="../../../../com/intellectualcrafters/plot/database/AbstractDB.html" title="class in com.intellectualcrafters.plot.database"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/intellectualcrafters/plot/database/DBFunc.html" title="class in com.intellectualcrafters.plot.database"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/intellectualcrafters/plot/database/Database.html" target="_top">Frames</a></li> <li><a href="Database.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field_summary">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">com.intellectualcrafters.plot.database</div> <h2 title="Class Database" class="title">Class Database</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.intellectualcrafters.plot.database.Database</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../com/intellectualcrafters/plot/database/MySQL.html" title="class in com.intellectualcrafters.plot.database">MySQL</a>, <a href="../../../../com/intellectualcrafters/plot/database/SQLite.html" title="class in com.intellectualcrafters.plot.database">SQLite</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">Database</span> extends java.lang.Object</pre> <div class="block">Abstract Database class, serves as a base for any connection method (MySQL, SQLite, etc.) </div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected org.bukkit.plugin.Plugin</code></td> <td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/database/Database.html#plugin">plugin</a></strong></code> <div class="block">Plugin instance, use for plugin.getDataFolder()</div> </td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier</th> <th class="colLast" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected </code></td> <td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/database/Database.html#Database(org.bukkit.plugin.Plugin)">Database</a></strong>(org.bukkit.plugin.Plugin plugin)</code> <div class="block">Creates a new Database</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/database/Database.html#checkConnection()">checkConnection</a></strong>()</code> <div class="block">Checks if a connection is open with the database</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/database/Database.html#closeConnection()">closeConnection</a></strong>()</code> <div class="block">Closes the connection with the database</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract java.sql.Connection</code></td> <td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/database/Database.html#getConnection()">getConnection</a></strong>()</code> <div class="block">Gets the connection with the database</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract java.sql.Connection</code></td> <td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/database/Database.html#openConnection()">openConnection</a></strong>()</code> <div class="block">Opens a connection with the database</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract java.sql.ResultSet</code></td> <td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/database/Database.html#querySQL(java.lang.String)">querySQL</a></strong>(java.lang.String query)</code> <div class="block">Executes a SQL Query<br> If the connection is closed, it will be opened </div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract int</code></td> <td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/database/Database.html#updateSQL(java.lang.String)">updateSQL</a></strong>(java.lang.String query)</code> <div class="block">Executes an Update SQL Query<br> See <code>Statement.executeUpdate(String)</code><br> If the connection is closed, it will be opened </div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="plugin"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>plugin</h4> <pre>protected org.bukkit.plugin.Plugin plugin</pre> <div class="block">Plugin instance, use for plugin.getDataFolder()</div> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Database(org.bukkit.plugin.Plugin)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Database</h4> <pre>protected Database(org.bukkit.plugin.Plugin plugin)</pre> <div class="block">Creates a new Database</div> <dl> <dt><span class="strong">Parameters:</span></dt> <dd><code>plugin</code> - Plugin instance</dd> </dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="openConnection()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>openConnection</h4> <pre>public abstract java.sql.Connection openConnection() throws java.sql.SQLException, java.lang.ClassNotFoundException</pre> <div class="block">Opens a connection with the database</div> <dl> <dt><span class="strong">Returns:</span></dt> <dd>Opened connection</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.sql.SQLException</code> - if the connection can not be opened</dd> <dd><code>java.lang.ClassNotFoundException</code> - if the driver cannot be found</dd> </dl> </li> </ul> <a name="checkConnection()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>checkConnection</h4> <pre>public abstract boolean checkConnection() throws java.sql.SQLException</pre> <div class="block">Checks if a connection is open with the database</div> <dl> <dt><span class="strong">Returns:</span></dt> <dd>true if the connection is open</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.sql.SQLException</code> - if the connection cannot be checked</dd> </dl> </li> </ul> <a name="getConnection()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getConnection</h4> <pre>public abstract java.sql.Connection getConnection()</pre> <div class="block">Gets the connection with the database</div> <dl> <dt><span class="strong">Returns:</span></dt> <dd>Connection with the database, null if none</dd> </dl> </li> </ul> <a name="closeConnection()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>closeConnection</h4> <pre>public abstract boolean closeConnection() throws java.sql.SQLException</pre> <div class="block">Closes the connection with the database</div> <dl> <dt><span class="strong">Returns:</span></dt> <dd>true if successful</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.sql.SQLException</code> - if the connection cannot be closed</dd> </dl> </li> </ul> <a name="querySQL(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>querySQL</h4> <pre>public abstract java.sql.ResultSet querySQL(java.lang.String query) throws java.sql.SQLException, java.lang.ClassNotFoundException</pre> <div class="block">Executes a SQL Query<br> If the connection is closed, it will be opened </div> <dl> <dt><span class="strong">Parameters:</span></dt> <dd><code>query</code> - Query to be run</dd> <dt><span class="strong">Returns:</span></dt> <dd>the results of the query</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.sql.SQLException</code> - If the query cannot be executed</dd> <dd><code>java.lang.ClassNotFoundException</code> - If the driver cannot be found; see <a href="../../../../com/intellectualcrafters/plot/database/Database.html#openConnection()"><code>openConnection()</code></a> </dd> </dl> </li> </ul> <a name="updateSQL(java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>updateSQL</h4> <pre>public abstract int updateSQL(java.lang.String query) throws java.sql.SQLException, java.lang.ClassNotFoundException</pre> <div class="block">Executes an Update SQL Query<br> See <code>Statement.executeUpdate(String)</code><br> If the connection is closed, it will be opened </div> <dl> <dt><span class="strong">Parameters:</span></dt> <dd><code>query</code> - Query to be run</dd> <dt><span class="strong">Returns:</span></dt> <dd>Result Code, see <code>Statement.executeUpdate(String)</code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.sql.SQLException</code> - If the query cannot be executed</dd> <dd><code>java.lang.ClassNotFoundException</code> - If the driver cannot be found; see <a href="../../../../com/intellectualcrafters/plot/database/Database.html#openConnection()"><code>openConnection()</code></a> </dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-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"> <li><a href="../../../../com/intellectualcrafters/plot/database/AbstractDB.html" title="class in com.intellectualcrafters.plot.database"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/intellectualcrafters/plot/database/DBFunc.html" title="class in com.intellectualcrafters.plot.database"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/intellectualcrafters/plot/database/Database.html" target="_top">Frames</a></li> <li><a href="Database.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All 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> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field_summary">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>