| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>AbstractGridCoverageResource (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, class: AbstractGridCoverageResource"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.storage.AbstractGridCoverageResource class"> |
| <meta name="keywords" content="getEnvelope()"> |
| <meta name="keywords" content="createMetadata()"> |
| <meta name="keywords" content="canNotRead()"> |
| <meta name="keywords" content="logReadOperation()"> |
| <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"> </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><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/AbstractGridCoverageResource.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: </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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.sis.storage</a></div> |
| <h1 title="Class AbstractGridCoverageResource" class="title">Class AbstractGridCoverageResource</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="AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a> |
| <div class="inheritance">AbstractGridCoverageResource</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="DataSet.html" title="interface in org.apache.sis.storage">DataSet</a></code>, <code><a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></code>, <code><a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractGridCoverageResource</span> |
| <span class="extends-implements">extends <a href="AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a> |
| implements <a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></span></div> |
| <div class="block">Default implementations of several methods for classes that want to implement the <a href="GridCoverageResource.html" title="interface in org.apache.sis.storage"><code>GridCoverageResource</code></a> interface. |
| Subclasses should override the following methods: |
| |
| <ul> |
| <li><a href="GridCoverageResource.html#getGridGeometry()"><code>GridCoverageResource.getGridGeometry()</code></a> (mandatory)</li> |
| <li><a href="GridCoverageResource.html#getSampleDimensions()"><code>GridCoverageResource.getSampleDimensions()</code></a> (mandatory)</li> |
| </ul> |
| |
| This class also provides the following helper methods for implementation |
| of the <a href="GridCoverageResource.html#read(org.apache.sis.coverage.grid.GridGeometry,int...)"><code>read(…)</code></a> method in subclasses: |
| |
| <ul> |
| <li><a href="#canNotRead(java.lang.String,org.apache.sis.coverage.grid.GridGeometry,java.lang.Throwable)"><code>canNotRead(String, GridGeometry, Throwable)</code></a> for reporting a failure to read operation.</li> |
| <li><a href="#logReadOperation(java.lang.Object,org.apache.sis.coverage.grid.GridGeometry,long)"><code>logReadOperation(Object, GridGeometry, long)</code></a> for logging a notice about a read operation.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-storage</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-AbstractResource">Fields inherited from class <a href="AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a></h3> |
| <code><a href="AbstractResource.html#listeners">listeners</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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.storage.event.StoreListeners,boolean)" class="member-name-link">AbstractGridCoverageResource</a><wbr>(<a href="event/StoreListeners.html" title="class in org.apache.sis.storage.event">StoreListeners</a> parentListeners, |
| boolean hidden)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new resource which can send notifications to the given set of listeners.</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>protected <a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canNotRead(java.lang.String,org.apache.sis.coverage.grid.GridGeometry,java.lang.Throwable)" class="member-name-link">canNotRead</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> filename, |
| <a href="../coverage/grid/GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a> request, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates an exception for a failure to load data.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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="#createMetadata()" class="member-name-link">createMetadata</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Invoked in a synchronized block the first time that <code>getMetadata()</code> is invoked.</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><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEnvelope()" class="member-name-link">getEnvelope</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 envelope of the grid geometry if known.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#logReadOperation(java.lang.Object,org.apache.sis.coverage.grid.GridGeometry,long)" class="member-name-link">logReadOperation</a><wbr>(<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> file, |
| <a href="../coverage/grid/GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a> domain, |
| long startTime)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Logs the execution of a <a href="GridCoverageResource.html#read(org.apache.sis.coverage.grid.GridGeometry,int...)"><code>GridCoverageResource.read(GridGeometry, int...)</code></a> operation.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractResource">Methods inherited from class <a href="AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a></h3> |
| <code><a href="AbstractResource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">addListener</a>, <a href="AbstractResource.html#clearCache()">clearCache</a>, <a href="AbstractResource.html#getIdentifier()">getIdentifier</a>, <a href="AbstractResource.html#getMetadata()">getMetadata</a>, <a href="AbstractResource.html#getSynchronizationLock()">getSynchronizationLock</a>, <a href="AbstractResource.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">removeListener</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <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">getClass</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">hashCode</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">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</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-GridCoverageResource">Methods inherited from interface <a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></h3> |
| <code><a href="GridCoverageResource.html#getGridGeometry()">getGridGeometry</a>, <a href="GridCoverageResource.html#getLoadingStrategy()">getLoadingStrategy</a>, <a href="GridCoverageResource.html#getResolutions()">getResolutions</a>, <a href="GridCoverageResource.html#getSampleDimensions()">getSampleDimensions</a>, <a href="GridCoverageResource.html#read(org.apache.sis.coverage.grid.GridGeometry,int...)">read</a>, <a href="GridCoverageResource.html#setLoadingStrategy(org.apache.sis.storage.RasterLoadingStrategy)">setLoadingStrategy</a>, <a href="GridCoverageResource.html#subset(org.apache.sis.storage.Query)">subset</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Resource">Methods inherited from interface <a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></h3> |
| <code><a href="Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">addListener</a>, <a href="Resource.html#getIdentifier()">getIdentifier</a>, <a href="Resource.html#getMetadata()">getMetadata</a>, <a href="Resource.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">removeListener</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="<init>(org.apache.sis.storage.event.StoreListeners,boolean)"> |
| <h3>AbstractGridCoverageResource</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">AbstractGridCoverageResource</span><wbr><span class="parameters">(<a href="event/StoreListeners.html" title="class in org.apache.sis.storage.event">StoreListeners</a> parentListeners, |
| boolean hidden)</span></div> |
| <div class="block">Creates a new resource which can send notifications to the given set of listeners. |
| If <code>hidden</code> is <code>false</code> (the recommended value), then this resource will have its own set of |
| listeners with this resource declared as the <a href="event/StoreListeners.html#getSource()">source of events</a>. |
| It will be possible to add and remove listeners independently from the set of parent listeners. |
| Conversely if <code>hidden</code> is <code>true</code>, then the given listeners will be used directly |
| and this resource will not appear as the source of any event. |
| |
| <p>In any cases, the listeners of all parents (ultimately the data store that created this resource) |
| will always be notified, either directly if <code>hidden</code> is <code>true</code> |
| or indirectly if <code>hidden</code> is <code>false</code>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parentListeners</code> - listeners of the parent resource, or <code>null</code> if none. |
| This is usually the listeners of the <a href="DataStore.html" title="class in org.apache.sis.storage"><code>DataStore</code></a> that created this resource.</dd> |
| <dd><code>hidden</code> - <code>false</code> if this resource shall use its own <a href="event/StoreListeners.html" title="class in org.apache.sis.storage.event"><code>StoreListeners</code></a> |
| with the specified parent, or <code>true</code> for using <code>parentListeners</code> directly.</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="getEnvelope()"> |
| <h3>getEnvelope</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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><<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a>></span> <span class="element-name">getEnvelope</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 envelope of the grid geometry if known. |
| The envelope is absent if the grid geometry does not provide this information.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DataSet.html#getEnvelope()">getEnvelope</a></code> in interface <code><a href="DataSet.html" title="interface in org.apache.sis.storage">DataSet</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractResource.html#getEnvelope()">getEnvelope</a></code> in class <code><a href="AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the grid geometry envelope.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code> - if an error occurred while computing the grid geometry.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../coverage/grid/GridGeometry.html#getEnvelope()"><code>GridGeometry.getEnvelope()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createMetadata()"> |
| <h3>createMetadata</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <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> <span class="element-name">createMetadata</span>() |
| throws <span class="exceptions"><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div> |
| <div class="block">Invoked in a synchronized block the first time that <code>getMetadata()</code> is invoked. |
| The default implementation populates metadata based on information provided by |
| <a href="AbstractResource.html#getIdentifier()"><code>getIdentifier()</code></a>, |
| <a href="#getEnvelope()"><code>getEnvelope()</code></a>, |
| <a href="GridCoverageResource.html#getGridGeometry()"><code>getGridGeometry()</code></a> and |
| <a href="GridCoverageResource.html#getSampleDimensions()"><code>getSampleDimensions()</code></a>. |
| Subclasses should override if they can provide more information. |
| The default value can be completed by casting to <a href="../metadata/iso/DefaultMetadata.html" title="class in org.apache.sis.metadata.iso"><code>DefaultMetadata</code></a>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractResource.html#createMetadata()">createMetadata</a></code> in class <code><a href="AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the newly created metadata, or <code>null</code> if unknown.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code> - if an error occurred while reading metadata from this resource.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="canNotRead(java.lang.String,org.apache.sis.coverage.grid.GridGeometry,java.lang.Throwable)"> |
| <h3>canNotRead</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span> <span class="element-name">canNotRead</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> filename, |
| <a href="../coverage/grid/GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a> request, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</span></div> |
| <div class="block">Creates an exception for a failure to load data. |
| The exception sub-type is inferred from the arguments. |
| If the failure is caused by an envelope outside the resource domain, |
| then that envelope will be inferred from the <code>request</code> argument.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filename</code> - some identification (typically a file name) of the data that cannot be read.</dd> |
| <dd><code>request</code> - the requested domain, or <code>null</code> if unspecified.</dd> |
| <dd><code>cause</code> - the cause of the failure, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd>the exception to throw.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="NoSuchDataException.html" title="class in org.apache.sis.storage"><code>NoSuchDataException</code></a></li> |
| <li><a href="DataStoreReferencingException.html" title="class in org.apache.sis.storage"><code>DataStoreReferencingException</code></a></li> |
| <li><a href="DataStoreContentException.html" title="class in org.apache.sis.storage"><code>DataStoreContentException</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="logReadOperation(java.lang.Object,org.apache.sis.coverage.grid.GridGeometry,long)"> |
| <h3>logReadOperation</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">logReadOperation</span><wbr><span class="parameters">(<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> file, |
| <a href="../coverage/grid/GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a> domain, |
| long startTime)</span></div> |
| <div class="block">Logs the execution of a <a href="GridCoverageResource.html#read(org.apache.sis.coverage.grid.GridGeometry,int...)"><code>GridCoverageResource.read(GridGeometry, int...)</code></a> operation. |
| The log level will be <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.logging/java/util/logging/Level.html#FINE" title="class or interface in java.util.logging" class="external-link"><code>Level.FINE</code></a> if the operation was quick enough, |
| or <a href="../util/logging/PerformanceLevel.html#SLOWNESS"><code>PerformanceLevel.SLOWNESS</code></a> or higher level otherwise.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>file</code> - the file that was opened, or <code>null</code> for <a href="event/StoreListeners.html#getSourceName()"><code>StoreListeners.getSourceName()</code></a>.</dd> |
| <dd><code>domain</code> - domain of the created grid coverage.</dd> |
| <dd><code>startTime</code> - value of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/System.html#nanoTime()" title="class or interface in java.lang" class="external-link"><code>System.nanoTime()</code></a> when the loading process started.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </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> |