<p>INSPIREMetadataValidator</p>
<p>INSPIREMetadataValidator</p>

INSPIREMetadataValidator

Provides facilities to read, write and validate geographic metadata
defined with ISO TC211 / OGC ISO geographic information metadata standards, and
encoded using the ISO 19139 and ISO 19115-3 (XML) standard technical specifications.
This includes ISO 19110 (Feature cataloguing), 19115 (dataset metadata), 19119 (service metadata)
and 19136 (GML). Other interoperable schemas from the OGC are progressively supported
as well, such as the Sensor Web Enablement (SWE) Common Data Model, the OGC GML
Coverage Implementation Schema (GMLCOV), or the OGC GML Referenceable Grid (GMLRGRID).

Emmanuel Blondel

geometa

Tools for Reading and Writing ISO/OGC Geographic Metadata

INSPIREMetadataValidator function

INSPIREMetadataValidator — INSPIREMetadataValidator

<p><code><a href='https://r6.r-lib.org/reference/R6Class.html'>R6Class</a></code> object.</p>

Format

<p>Emmanuel Blondel &lt;emmanuel.blondel1@gmail.com&gt;</p>

Author

<p><code>geometa::geometaLogger</code> -&gt; <code>INSPIREMetadataValidator</code></p>

Super class

<p><div class="r6-fields"></p><dl>
<dt><code>url</code></dt>
<dd><p>url of the INSPIRE metadata validator</p></dd>


<dt><code>running</code></dt>
<dd><p>wether the service is up and running</p></dd>


<dt><code>status</code></dt>
<dd><p>status</p></dd>


</dl><p></div></p>

Public fields


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-INSPIREMetadataValidator-new'><code>INSPIREMetadataValidator$new()</code></a></p></li>
<li><p><a href='#method-INSPIREMetadataValidator-uploadFile'><code>INSPIREMetadataValidator$uploadFile()</code></a></p></li>
<li><p><a href='#method-INSPIREMetadataValidator-getAPIKey'><code>INSPIREMetadataValidator$getAPIKey()</code></a></p></li>
<li><p><a href='#method-INSPIREMetadataValidator-getValidationReport'><code>INSPIREMetadataValidator$getValidationReport()</code></a></p></li>
<li><p><a href='#method-INSPIREMetadataValidator-clone'><code>INSPIREMetadataValidator$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="geometa" data-topic="geometaLogger" data-id="ERROR"><a href='../../geometa/html/geometaLogger.html#method-geometaLogger-ERROR'><code>geometa::geometaLogger$ERROR()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="geometaLogger" data-id="INFO"><a href='../../geometa/html/geometaLogger.html#method-geometaLogger-INFO'><code>geometa::geometaLogger$INFO()</code></a></span></li>
<li><span class="pkg-link" data-pkg="geometa" data-topic="geometaLogger" data-id="WARN"><a href='../../geometa/html/geometaLogger.html#method-geometaLogger-WARN'><code>geometa::geometaLogger$WARN()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-INSPIREMetadataValidator-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Method used to instantiate an INSPIRE Metadata validator. To check 
   metadata with the INSPIRE metadata validator, a user API key is now required, 
   and should be specified with the <code>apiKey</code>. By default, the <code>url</code> will be
   the INSPIRE production service <a href='https://inspire.ec.europa.eu/validator/swagger-ui.html'>https://inspire.ec.europa.eu/validator/swagger-ui.html</a>.</p>   
<p>The <code>keyring_backend</code> can be set to use a different backend for storing 
   the INSPIRE metadata validator API key with <span class="pkg">keyring</span> (Default value is 'env').</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>INSPIREMetadataValidator$new(
  url = "https://inspire.ec.europa.eu/validator-api",
  apiKey,
  keyring_backend = "env"
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>url</code></dt>
<dd><p>url</p></dd>


<dt><code>apiKey</code></dt>
<dd><p>API key</p></dd>


<dt><code>keyring_backend</code></dt>
<dd><p>backend name to use with <span class="pkg">keyring</span> to store API key</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-INSPIREMetadataValidator-uploadFile"></a></p><div class='section' id='method-uploadfile-'>
<h3>Method <code>uploadFile()</code></h3>
<p>Uploads a file. Upload a XML metadata file to INSPIRE web-service. Method called internally through
   <code>getValidationReport</code>.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>INSPIREMetadataValidator$uploadFile(path)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>path</code></dt>
<dd><p>path</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>the response from the web-service</p>
</div>

</div><p><hr>
<a id="method-INSPIREMetadataValidator-getAPIKey"></a></p><div class='section' id='method-getapikey-'>
<h3>Method <code>getAPIKey()</code></h3>
<p>Retrieves the API key</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>INSPIREMetadataValidator$getAPIKey()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>the API key as <a href='https://rdrr.io/r/base/character.html'>character</a></p>
</div>

</div><p><hr>
<a id="method-INSPIREMetadataValidator-getValidationReport"></a></p><div class='section' id='method-getvalidationreport-'>
<h3>Method <code>getValidationReport()</code></h3>
<p>Get validation report for a metadata specified either as R object of class
   ISOMetadata (from <span class="pkg">geometa</span> package) or <a href='https://rdrr.io/pkg/XML/man/XMLNode-class.html'>XMLInternalNode-class</a> 
   (from <span class="pkg">XML</span> package), or as XML file, providing the path of the XML file
   to be sent to the INSPIRE metadata validator web-service. By default, a summary
   report is returned. To append the raw response of INSPIRE validation web-service
   to the summary report, set <code>raw = TRUE</code>.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>INSPIREMetadataValidator$getValidationReport(
  obj = NULL,
  file = NULL,
  raw = FALSE
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>obj</code></dt>
<dd><p>obj</p></dd>


<dt><code>file</code></dt>
<dd><p>file</p></dd>


<dt><code>raw</code></dt>
<dd><p>raw</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>an object of class <a href='https://rdrr.io/r/base/list.html'>list</a></p>
</div>

</div><p><hr>
<a id="method-INSPIREMetadataValidator-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>INSPIREMetadataValidator$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


INSPIREMetadataValidator: INSPIREMetadataValidator

Description

Arguments

Value

References

Examples