Plan/api/com/djrapitops/plan/query/CommonQueries.html

336 lines
12 KiB
HTML
Raw Normal View History

2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
2019-10-05 10:27:37 +02:00
<!-- Generated by javadoc (1.8.0_201) on Sat Oct 05 11:23:21 EEST 2019 -->
<title>CommonQueries (api 5.0 build %buildNumber% API)</title>
<meta name="date" content="2019-10-05">
2019-08-05 11:13:19 +02:00
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
2019-10-05 10:27:37 +02:00
parent.document.title="CommonQueries (api 5.0 build %buildNumber% API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../com/djrapitops/plan/query/QueryService.html" title="interface in com.djrapitops.plan.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/query/CommonQueries.html" target="_top">Frames</a></li>
<li><a href="CommonQueries.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.djrapitops.plan.query</div>
<h2 title="Interface CommonQueries" class="title">Interface CommonQueries</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CommonQueries</span></pre>
<div class="block">Class that allows performing most commonly wanted queries.
<p>
This exists so that SQL does not necessarily need to be written.
Obtain an instance from <a href="../../../../com/djrapitops/plan/query/QueryService.html" title="interface in com.djrapitops.plan.query"><code>QueryService</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#doesDBHaveTable-java.lang.String-">doesDBHaveTable</a></span>(java.lang.String&nbsp;table)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#doesDBHaveTableColumn-java.lang.String-java.lang.String-">doesDBHaveTableColumn</a></span>(java.lang.String&nbsp;table,
java.lang.String&nbsp;column)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchLastSeen-java.util.UUID-java.util.UUID-">fetchLastSeen</a></span>(java.util.UUID&nbsp;playerUUID,
java.util.UUID&nbsp;serverUUID)</code>
<div class="block">Fetch last seen Epoch ms for a player on a server.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Optional&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchNameOf-java.util.UUID-">fetchNameOf</a></span>(java.util.UUID&nbsp;playerUUID)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchPlaytime-java.util.UUID-java.util.UUID-long-long-">fetchPlaytime</a></span>(java.util.UUID&nbsp;playerUUID,
java.util.UUID&nbsp;serverUUID,
long&nbsp;after,
long&nbsp;before)</code>
<div class="block">Fetch playtime of a player on a server.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.util.UUID&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchServerUUIDs--">fetchServerUUIDs</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Optional&lt;java.util.UUID&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/CommonQueries.html#fetchUUIDOf-java.lang.String-">fetchUUIDOf</a></span>(java.lang.String&nbsp;playerName)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fetchPlaytime-java.util.UUID-java.util.UUID-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchPlaytime</h4>
<pre>long&nbsp;fetchPlaytime(java.util.UUID&nbsp;playerUUID,
java.util.UUID&nbsp;serverUUID,
long&nbsp;after,
long&nbsp;before)</pre>
<div class="block">Fetch playtime of a player on a server.
<p>
Returns 0 for any non existing players or servers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>playerUUID</code> - UUID of the player.</dd>
<dd><code>serverUUID</code> - UUID of the Plan server.</dd>
<dd><code>after</code> - Data after this Epoch ms should be fetched</dd>
<dd><code>before</code> - Data before this Epoch ms should be fetched</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Milliseconds the player has played with the defined parameters.</dd>
</dl>
</li>
</ul>
<a name="fetchLastSeen-java.util.UUID-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchLastSeen</h4>
<pre>long&nbsp;fetchLastSeen(java.util.UUID&nbsp;playerUUID,
java.util.UUID&nbsp;serverUUID)</pre>
<div class="block">Fetch last seen Epoch ms for a player on a server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>playerUUID</code> - UUID of the player.</dd>
<dd><code>serverUUID</code> - UUID of the Plan server.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Epoch ms the player was last seen, 0 if player has not played on server.</dd>
</dl>
</li>
</ul>
<a name="fetchServerUUIDs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchServerUUIDs</h4>
<pre>java.util.Set&lt;java.util.UUID&gt;&nbsp;fetchServerUUIDs()</pre>
</li>
</ul>
<a name="fetchUUIDOf-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchUUIDOf</h4>
<pre>java.util.Optional&lt;java.util.UUID&gt;&nbsp;fetchUUIDOf(java.lang.String&nbsp;playerName)</pre>
</li>
</ul>
<a name="fetchNameOf-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchNameOf</h4>
<pre>java.util.Optional&lt;java.lang.String&gt;&nbsp;fetchNameOf(java.util.UUID&nbsp;playerUUID)</pre>
</li>
</ul>
<a name="doesDBHaveTable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doesDBHaveTable</h4>
<pre>boolean&nbsp;doesDBHaveTable(java.lang.String&nbsp;table)</pre>
</li>
</ul>
<a name="doesDBHaveTableColumn-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doesDBHaveTableColumn</h4>
<pre>boolean&nbsp;doesDBHaveTableColumn(java.lang.String&nbsp;table,
java.lang.String&nbsp;column)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../com/djrapitops/plan/query/QueryService.html" title="interface in com.djrapitops.plan.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/query/CommonQueries.html" target="_top">Frames</a></li>
<li><a href="CommonQueries.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>