blob: 1bd298c349b9191c996553e9cb9c5499fce24f46 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>SQLStore (Apache SIS 1.3 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.sis.storage.sql, class: SQLStore">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.storage.sql.SQLStore class">
<meta name="keywords" content="getOpenParameters()">
<meta name="keywords" content="getIdentifier()">
<meta name="keywords" content="getMetadata()">
<meta name="keywords" content="components()">
<meta name="keywords" content="findResource()">
<meta name="keywords" content="addListener()">
<meta name="keywords" content="close()">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/SQLStore.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#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<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>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<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>
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.storage.sql</a></div>
<h1 title="Class SQLStore" class="title">Class SQLStore</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
<div class="inheritance"><a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a>
<div class="inheritance">SQLStore</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">Auto­Closeable</a></code>, <code><a href="../Aggregate.html" title="interface in org.apache.sis.storage">Aggregate</a></code>, <code><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></code>, <code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SQLStore</span>
<span class="extends-implements">extends <a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a>
implements <a href="../Aggregate.html" title="interface in org.apache.sis.storage">Aggregate</a></span></div>
<div class="block">A data store capable to read and create features from a spatial database.
<code>SQLStore</code> requires a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.sql/javax/sql/DataSource.html" title="class or interface in javax.sql" class="external-link"><code>Data­Source</code></a> to be specified (indirectly) at construction time.
The <code>Data­Source</code> should provide pooled connections, because <code>SQLStore</code> will frequently
opens and closes them.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>1.0</dd>
<p><font size="-1">Defined in the <code>sis-sqlstore</code> module</font></p>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-DataStore">Fields inherited from class&nbsp;<a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></h3>
<code><a href="../DataStore.html#listeners">listeners</a>, <a href="../DataStore.html#provider">provider</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.storage.sql.SQLStoreProvider,org.apache.sis.storage.StorageConnector,org.apache.sis.storage.sql.ResourceDefinition...)" class="member-name-link">SQLStore</a><wbr>(<a href="SQLStoreProvider.html" title="class in org.apache.sis.storage.sql">SQLStore­Provider</a>&nbsp;provider,
<a href="../StorageConnector.html" title="class in org.apache.sis.storage">Storage­Connector</a>&nbsp;connector,
<a href="ResourceDefinition.html" title="class in org.apache.sis.storage.sql">Resource­Definition</a>...&nbsp;resources)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new <code>SQLStore</code> for the given data source and tables, views or queries.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>&lt;T extends <a href="../event/StoreEvent.html" title="class in org.apache.sis.storage.event">Store­Event</a>&gt;<br>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)" class="member-name-link">add­Listener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;event­Type,
<a href="../event/StoreListener.html" title="interface in org.apache.sis.storage.event">Store­Listener</a>&lt;? super T&gt;&nbsp;listener)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Registers a listener to notify when the specified kind of event occurs in this data store.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Closes this SQL store and releases any underlying resources.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../FeatureSet.html" title="interface in org.apache.sis.storage">Feature­Set</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#components()" class="member-name-link">components</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the tables (feature sets) in this SQL store.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../FeatureSet.html" title="interface in org.apache.sis.storage">Feature­Set</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findResource(java.lang.String)" class="member-name-link">find­Resource</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;identifier)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Searches for a resource identified by the given identifier.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">Generic­Name</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIdentifier()" class="member-name-link">get­Identifier</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">SQL data store root resource has no identifier.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Metadata.html" title="class or interface in org.opengis.metadata" class="external-link">Metadata</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMetadata()" class="member-name-link">get­Metadata</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns information about the dataset as a whole.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">Parameter­Value­Group</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOpenParameters()" class="member-name-link">get­Open­Parameters</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the parameters used to open this netCDF data store.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-DataStore">Methods inherited from class&nbsp;<a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></h3>
<code><a href="../DataStore.html#getDisplayName()">get­Display­Name</a>, <a href="../DataStore.html#getLocale()">get­Locale</a>, <a href="../DataStore.html#getNativeMetadata()">get­Native­Metadata</a>, <a href="../DataStore.html#getProvider()">get­Provider</a>, <a href="../DataStore.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">remove­Listener</a>, <a href="../DataStore.html#setLocale(java.util.Locale)">set­Locale</a>, <a href="../DataStore.html#toString()">to­String</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hash­Code</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Resource">Methods inherited from interface&nbsp;<a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></h3>
<code><a href="../Resource.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">remove­Listener</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.sis.storage.sql.SQLStoreProvider,org.apache.sis.storage.StorageConnector,org.apache.sis.storage.sql.ResourceDefinition...)">
<h3>SQLStore</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SQLStore</span><wbr><span class="parameters">(<a href="SQLStoreProvider.html" title="class in org.apache.sis.storage.sql">SQLStoreProvider</a>&nbsp;provider,
<a href="../StorageConnector.html" title="class in org.apache.sis.storage">StorageConnector</a>&nbsp;connector,
<a href="ResourceDefinition.html" title="class in org.apache.sis.storage.sql">ResourceDefinition</a>...&nbsp;resources)</span>
throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Creates a new <code>SQLStore</code> for the given data source and tables, views or queries.
The given <code>connector</code> shall contain a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.sql/javax/sql/DataSource.html" title="class or interface in javax.sql" class="external-link"><code>Data­Source</code></a> instance.
Tables or views to include in the store are specified by the <code>resources</code> argument.
Only the main tables need to be specified; dependencies will be followed automatically.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>provider</code> - the factory that created this <code>Data­Store</code> instance, or <code>null</code> if unspecified.</dd>
<dd><code>connector</code> - information about the storage (JDBC data source, <i>etc</i>).</dd>
<dd><code>resources</code> - tables, views or queries to include in this store.</dd>
<dt>Throws:</dt>
<dd><code><a href="../DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while creating the data store for the given storage.</dd>
<dt>Since:</dt>
<dd>1.1</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getOpenParameters()">
<h3>getOpenParameters</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a>&gt;</span>&nbsp;<span class="element-name">getOpenParameters</span>()</div>
<div class="block">Returns the parameters used to open this netCDF data store.
The parameters are described by <a href="SQLStoreProvider.html#getOpenParameters()"><code>SQLStore­Provider​.get­Open­Parameters()</code></a> and contains
at least a parameter named <a href="../DataStoreProvider.html#LOCATION">"location"</a> with a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.sql/javax/sql/DataSource.html" title="class or interface in javax.sql" class="external-link"><code>Data­Source</code></a> value.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../DataStore.html#getOpenParameters()">get­Open­Parameters</a></code>&nbsp;in class&nbsp;<code><a href="../DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Returns:</dt>
<dd>parameters used for opening this data store.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../DataStoreProvider.html#getOpenParameters()"><code>Data­Store­Provider​.get­Open­Parameters()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIdentifier()">
<h3>getIdentifier</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a>&gt;</span>&nbsp;<span class="element-name">getIdentifier</span>()
throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">SQL data store root resource has no identifier.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Resource.html#getIdentifier()">get­Identifier</a></code>&nbsp;in interface&nbsp;<code><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../DataStore.html#getIdentifier()">get­Identifier</a></code>&nbsp;in class&nbsp;<code><a href="../DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Returns:</dt>
<dd>empty.</dd>
<dt>Throws:</dt>
<dd><code><a href="../DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while fetching the identifier.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../DataStore.html#getMetadata()"><code>Data­Store​.get­Metadata()</code></a></li>
<li><a href="../DataStore.html#getDisplayName()"><code>Data­Store​.get­Display­Name()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMetadata()">
<h3>getMetadata</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Metadata.html" title="class or interface in org.opengis.metadata" class="external-link">Metadata</a></span>&nbsp;<span class="element-name">getMetadata</span>()
throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Returns information about the dataset as a whole. The returned metadata object can contain information
such as the list of feature types.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Resource.html#getMetadata()">get­Metadata</a></code>&nbsp;in interface&nbsp;<code><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="../DataStore.html#getMetadata()">get­Metadata</a></code>&nbsp;in class&nbsp;<code><a href="../DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Returns:</dt>
<dd>information about the dataset.</dd>
<dt>Throws:</dt>
<dd><code><a href="../DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while reading the data.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../DataStore.html#getIdentifier()"><code>Data­Store​.get­Identifier()</code></a></li>
<li><a href="../../metadata/iso/DefaultMetadata.html#deepCopy(org.opengis.metadata.Metadata)"><code>Default­Metadata​.deep­Copy(Metadata)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="components()">
<h3>components</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a>&gt;</span>&nbsp;<span class="element-name">components</span>()
throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Returns the tables (feature sets) in this SQL store.
The list contains only the tables explicitly named at construction time.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Aggregate.html#components()">components</a></code>&nbsp;in interface&nbsp;<code><a href="../Aggregate.html" title="interface in org.apache.sis.storage">Aggregate</a></code></dd>
<dt>Returns:</dt>
<dd>children resources that are components of this SQL store.</dd>
<dt>Throws:</dt>
<dd><code><a href="../DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while fetching the components.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="findResource(java.lang.String)">
<h3>findResource</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a></span>&nbsp;<span class="element-name">findResource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;identifier)</span>
throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Searches for a resource identified by the given identifier.
The given identifier should match one of the table names.
It may be one of the tables named at construction time, or one of the dependencies.
The given name may be qualified with the schema name, or may be only the table name if there is no ambiguity.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../DataStore.html#findResource(java.lang.String)">find­Resource</a></code>&nbsp;in class&nbsp;<code><a href="../DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Parameters:</dt>
<dd><code>identifier</code> - identifier of the resource to fetch. Must be non-null.</dd>
<dt>Returns:</dt>
<dd>resource associated to the given identifier (never <code>null</code>).</dd>
<dt>Throws:</dt>
<dd><code><a href="../IllegalNameException.html" title="class in org.apache.sis.storage">Illegal­Name­Exception</a></code> - if no resource is found for the given identifier, or if more than one resource is found.</dd>
<dd><code><a href="../DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if another kind of error occurred while searching resources.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../Resource.html#getIdentifier()"><code>Resource​.get­Identifier()</code></a></li>
<li><a href="../FeatureNaming.html" title="class in org.apache.sis.storage"><code>Feature­Naming</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">
<h3>addListener</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;T extends <a href="../event/StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a>&gt;</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;eventType,
<a href="../event/StoreListener.html" title="interface in org.apache.sis.storage.event">StoreListener</a>&lt;? super T&gt;&nbsp;listener)</span></div>
<div class="block">Registers a listener to notify when the specified kind of event occurs in this data store.
The current implementation of this data store can emit only <a href="../event/WarningEvent.html" title="class in org.apache.sis.storage.event"><code>Warning­Event</code></a>s;
any listener specified for another kind of events will be ignored.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">add­Listener</a></code>&nbsp;in interface&nbsp;<code><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../DataStore.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">add­Listener</a></code>&nbsp;in class&nbsp;<code><a href="../DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Type Parameters:</dt>
<dd><code>T</code> - compile-time value of the <code>event­Type</code> argument.</dd>
<dt>Parameters:</dt>
<dd><code>event­Type</code> - type of <a href="../event/StoreEvent.html" title="class in org.apache.sis.storage.event"><code>Store­Event</code></a> to listen (cannot be <code>null</code>).</dd>
<dd><code>listener</code> - listener to notify about events.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="close()">
<h3>close</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()
throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Closes this SQL store and releases any underlying resources.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">Auto­Closeable</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="../DataStore.html#close()">close</a></code>&nbsp;in class&nbsp;<code><a href="../DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="../DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while closing the SQL store.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../event/StoreListeners.html#close()"><code>Store­Listeners​.close()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>