Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / 217d1a3f17a8391a16675cbcf59004b3c6a76080 / . / java_docs / org / eclipse / mosaic / lib / database / DatabaseUtils.html
blob: af4314d5b93d1262b2da9ee3337d44a879a711e9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_262) on Wed Mar 10 21:50:06 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DatabaseUtils (Eclipse MOSAIC Parent 21.0 API)</title>
<meta name="date" content="2021-03-10">
<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) {
parent.document.title="DatabaseUtils (Eclipse MOSAIC Parent 21.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="class-use/DatabaseUtils.html">Use</a></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><a href="../../../../../org/eclipse/mosaic/lib/database/Database.RouteBuilder.html" title="class in org.eclipse.mosaic.lib.database"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/lib/database/DatabaseUtils.html" target="_top">Frames</a></li>
<li><a href="DatabaseUtils.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">org.eclipse.mosaic.lib.database</div>
<h2 title="Class DatabaseUtils" class="title">Class DatabaseUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.mosaic.lib.database.DatabaseUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">DatabaseUtils</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class bundles static utilities to be called on <a href="../../../../../org/eclipse/mosaic/lib/database/Database.html" title="class in org.eclipse.mosaic.lib.database"><code>Database</code></a> and objects
contained in <a href="../../../../../org/eclipse/mosaic/lib/database/Database.html" title="class in org.eclipse.mosaic.lib.database"><code>Database</code></a>s.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/database/DatabaseUtils.html#DatabaseUtils--">DatabaseUtils</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/database/DatabaseUtils.html#detectGraphs-java.util.Collection-">detectGraphs</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&gt;&nbsp;nodes)</code>
<div class="block">This detects all graphs that exist in the database and returns them as lists of nodes.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/database/DatabaseUtils.html#getDuplicateConnection-org.eclipse.mosaic.lib.database.Database.Builder-org.eclipse.mosaic.lib.database.road.Connection-">getDuplicateConnection</a></span>(<a href="../../../../../org/eclipse/mosaic/lib/database/Database.Builder.html" title="class in org.eclipse.mosaic.lib.database">Database.Builder</a>&nbsp;databaseBuilder,
<a href="../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection)</code>
<div class="block">This checks if there already is a similar connection to the given one in the database
without it being the same <a href="../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Connection</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/database/DatabaseUtils.html#isIntersection-org.eclipse.mosaic.lib.database.road.Node-">isIntersection</a></span>(<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;node)</code>
<div class="block">Determines, if a node is a intersection node, that is, it has more than 2 outgoing or incoming streets.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/database/DatabaseUtils.html#searchGraph-org.eclipse.mosaic.lib.database.road.Node-">searchGraph</a></span>(<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;startNode)</code>
<div class="block">This searches all nodes of a graph by breadth-first search.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/database/DatabaseUtils.html#updateDb-java.io.File-">updateDb</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)</code>
<div class="block">Updates the database from the given <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> object to the latest scheme.</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DatabaseUtils--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DatabaseUtils</h4>
<pre>public&nbsp;DatabaseUtils()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="updateDb-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateDb</h4>
<pre>public static&nbsp;void&nbsp;updateDb(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file)</pre>
<div class="block">Updates the database from the given <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> object to the latest scheme.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - database file</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if an SQLException or IOException were caught</dd>
</dl>
</li>
</ul>
<a name="detectGraphs-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detectGraphs</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&gt;&gt;&nbsp;detectGraphs(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&gt;&nbsp;nodes)</pre>
<div class="block">This detects all graphs that exist in the database and returns them as lists of nodes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodes</code> - the collection of <a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Node</code></a>s that graphs should be detected in</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Lists of graph nodes.</dd>
</dl>
</li>
</ul>
<a name="searchGraph-org.eclipse.mosaic.lib.database.road.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>searchGraph</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&gt;&nbsp;searchGraph(<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;startNode)</pre>
<div class="block">This searches all nodes of a graph by breadth-first search.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>startNode</code> - Start node for searching.</dd>
</dl>
</li>
</ul>
<a name="getDuplicateConnection-org.eclipse.mosaic.lib.database.Database.Builder-org.eclipse.mosaic.lib.database.road.Connection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDuplicateConnection</h4>
<pre>public static&nbsp;<a href="../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;getDuplicateConnection(<a href="../../../../../org/eclipse/mosaic/lib/database/Database.Builder.html" title="class in org.eclipse.mosaic.lib.database">Database.Builder</a>&nbsp;databaseBuilder,
<a href="../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection)</pre>
<div class="block">This checks if there already is a similar connection to the given one in the database
without it being the same <a href="../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Connection</code></a>. This will always return false if one of the
nodes to check against or the found duplicate connection was not referenced in the database!
The check goes down to the edge level and checks all nodes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connection</code> - Connection to check whether there is a duplicate in the database.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>connection which was duplicated by the given one or null</dd>
</dl>
</li>
</ul>
<a name="isIntersection-org.eclipse.mosaic.lib.database.road.Node-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isIntersection</h4>
<pre>public static&nbsp;boolean&nbsp;isIntersection(<a href="../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;node)</pre>
<div class="block">Determines, if a node is a intersection node, that is, it has more than 2 outgoing or incoming streets.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>node</code> - the node to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the node is an intersection</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>
<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="class-use/DatabaseUtils.html">Use</a></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><a href="../../../../../org/eclipse/mosaic/lib/database/Database.RouteBuilder.html" title="class in org.eclipse.mosaic.lib.database"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/lib/database/DatabaseUtils.html" target="_top">Frames</a></li>
<li><a href="DatabaseUtils.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020&#x2013;2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>