| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>org.apache.sis.storage.event (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.event"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.storage.event package"> |
| <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="package-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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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 class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li><a href="#related-package-summary">Related Packages</a></li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <h1 title="Package org.apache.sis.storage.event" class="title">Package org.apache.sis.storage.event</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.storage.event</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Provides interfaces and classes for dealing with different types of events fired by resources. |
| The different types of events are specified by the <a href="StoreEvent.html" title="class in org.apache.sis.storage.event"><code>StoreEvent</code></a> subclasses. |
| For example if a warning occurred while reading data from a file, |
| then the <a href="../DataStore.html" title="class in org.apache.sis.storage"><code>DataStore</code></a> implementation should fire a <a href="WarningEvent.html" title="class in org.apache.sis.storage.event"><code>WarningEvent</code></a>. |
| |
| <p>Events may occur in the following situations:</p> |
| <ul> |
| <li>When a warning occurred.</li> |
| <li>When the data store content changed (e.g. new feature instance added or removed).</li> |
| <li>When the data store structure changed (e.g. a column is added in tabular data).</li> |
| <li>Any other change at implementation choice.</li> |
| </ul> |
| |
| Users can <a href="../Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">declare their interest |
| to a specific kind of event</a>.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-storage</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.sis.storage</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><a href="../DataStore.html" title="class in org.apache.sis.storage">Data store</a> base types for retrieving and saving geospatial data |
| in various storage formats.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CascadedStoreEvent.html" title="class in org.apache.sis.storage.event">CascadedStoreEvent</a><E extends <a href="CascadedStoreEvent.html" title="class in org.apache.sis.storage.event">CascadedStoreEvent</a><E>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An event which, when occurring on a parent resource, is also fired by all children resources.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CloseEvent.html" title="class in org.apache.sis.storage.event">CloseEvent</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Notifies listeners that a resource or a data store is being closed and should no longer be used.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Parent class of events happening in a data store resource.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StoreListener.html" title="interface in org.apache.sis.storage.event">StoreListener</a><E extends <a href="StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">An object which listens for events (typically changes or warnings) occurring in a resource |
| or one of its children.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StoreListeners.html" title="class in org.apache.sis.storage.event">StoreListeners</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Holds a list of <a href="StoreListener.html" title="interface in org.apache.sis.storage.event"><code>StoreListener</code></a> instances and provides convenience methods for sending events.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="WarningEvent.html" title="class in org.apache.sis.storage.event">WarningEvent</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Describes non-fatal errors that occurred in a resource or a data store.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
