| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>Aggregate (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <meta name="keywords" content="org.apache.sis.storage.Aggregate interface"> |
| <meta name="keywords" content="components()"> |
| <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="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Aggregate (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Aggregate.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.storage</a></div> |
| <h2 title="Interface Aggregate" class="title">Interface Aggregate</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="WritableAggregate.html" title="interface in org.apache.sis.storage">WritableAggregate</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="geotiff/GeoTiffStore.html" title="class in org.apache.sis.storage.geotiff">GeoTiffStore</a></code>, <code><a href="netcdf/NetcdfStore.html" title="class in org.apache.sis.storage.netcdf">NetcdfStore</a></code>, <code><a href="sql/SQLStore.html" title="class in org.apache.sis.storage.sql">SQLStore</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Aggregate</span> |
| extends <a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></pre> |
| <div class="block">A collection of resources. An aggregate can have any number of components. |
| Each component can be another aggregate, thus forming a tree of resources. |
| Different kinds of aggregate may exist for various reasons, for example (adapted from ISO 19115): |
| |
| <ul class="verbose"> |
| <li><b>Series:</b> a generic collection of resources that share similar characteristics |
| (theme, date, resolution, <i>etc.</i>). The exact definition is determined by the data provider. |
| See <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/maintenance/ScopeCode.html?is-external=true#SERIES" title="class or interface in org.opengis.metadata.maintenance" class="externalLink"><code>ScopeCode.SERIES</code></a> for more examples.</li> |
| <li><b>Sensor series:</b> a collection of resources observed by the same sensor.</li> |
| <li><b>Platform series:</b> a collection of resources observed by sensors installed on the same platform. |
| The <a href="#components()">components</a> of a platform series are <cite>sensor series</cite>. |
| Those components usually share the same geospatial geometry.</li> |
| <li><b>Production series:</b> a collection of resources produced using the same process. Members of a production |
| series share <a href="../metadata/iso/DefaultMetadata.html#getResourceLineages()">lineage</a> and |
| <a href="../metadata/iso/lineage/DefaultLineage.html#getProcessSteps()">processing history</a>.</li> |
| <li><b>Initiative:</b> a collection of resources related by their participation in a common initiative.</li> |
| <li><b>Transfer aggregate:</b> a set of resources collected for the purpose of transfer. |
| The <a href="#components()">components</a> may be the results of an ad hoc query, for example on a Web Service.</li> |
| </ul> |
| |
| The same resource may be part of more than one aggregate. For example the same resource could be part of |
| a <cite>production series</cite> and a <cite>transfer aggregate</cite>. In Apache SIS implementation, |
| those two kinds of aggregate will usually be implemented by different <a href="DataStore.html" title="class in org.apache.sis.storage"><code>DataStore</code></a> instances. |
| |
| <div class="section">Metadata</div> |
| Aggregates should have <a href="Resource.html#getMetadata()"><code>metadata</code></a> / |
| <a href="../metadata/iso/DefaultMetadata.html#getMetadataScopes()"><code>metadataScope</code></a> / |
| <a href="../metadata/iso/DefaultMetadataScope.html#getResourceScope()"><code>resourceScope</code></a> sets to |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/maintenance/ScopeCode.html?is-external=true#SERIES" title="class or interface in org.opengis.metadata.maintenance" class="externalLink"><code>ScopeCode.SERIES</code></a> or |
| <code>ScopeCode.INITIATIVE</code> if applicable. |
| If not too expensive to compute, the names of all components should be listed as |
| <a href="../metadata/iso/identification/AbstractIdentification.html#getAssociatedResources()">associated resources</a> with an <code>AssociationType.IS_COMPOSED_OF</code> relation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-storage</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><? extends <a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#components()">components</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the children resources of this aggregate.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Resource"> |
| <!-- --> |
| </a> |
| <h3>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></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="components()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>components</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><? extends <a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a>> components() |
| throws <a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></pre> |
| <div class="block">Returns the children resources of this aggregate. The returned collection contains |
| the resources listed by their name in the following <a href="Resource.html#getMetadata()">metadata</a> elements. |
| The returned collection may contain more resources if the metadata are incomplete, |
| and the resources do not need to be in the same order: |
| |
| <blockquote><code><b>this</b>.metadata</code> / |
| <a href="../metadata/iso/DefaultMetadata.html#getIdentificationInfo()"><code>identificationInfo</code></a> / |
| <a href="../metadata/iso/identification/AbstractIdentification.html#getAssociatedResources()"><code>associatedResource</code></a> |
| with <code>AssociationType.IS_COMPOSED_OF</code></blockquote> |
| |
| The name of each child resource in the returned collection is given by the following metadata element: |
| |
| <blockquote><code><b>child</b>.metadata</code> / |
| <a href="../metadata/iso/DefaultMetadata.html#getIdentificationInfo()"><code>identificationInfo</code></a> / |
| <a href="../metadata/iso/identification/AbstractIdentification.html#getCitation()"><code>citation</code></a> / |
| <a href="../metadata/iso/citation/DefaultCitation.html#getTitle()"><code>title</code></a></blockquote> |
| |
| <div class="section">Lazy resource instantiation</div> |
| If the collection instantiates components only when first needed, and if a checked exception occurs |
| during invocation of a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Iterator</code></a> method, then the collection |
| or the iterator should wrap the exception in a <a href="../util/collection/BackingStoreException.html" title="class in org.apache.sis.util.collection"><code>BackingStoreException</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all children resources that are components of this aggregate. Never <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code> - if an error occurred while fetching the components.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Aggregate.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
