<html xmlns:doc="eml://ecoinformatics.org/documentation-2.1.1" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <head> <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>eml-view Documentation </title> <link href="../default.css" type="text/css" rel="stylesheet"> </head> <body> <div class="book"> <table width="100%" border="0"> <tr valign="top"> <td> <h1> Module Documentation: eml-view</h1> </td><td><a class="navlink" href="index.html">Back to EML Contents</a></td> </tr> </table> <h3> The eml-view module - Data tables resulting from a database query </h3> <p> The eml-view module describes a view from a database management system. A view is a query statement that is stored as a database object and executed each time the view is called. </p> <h2>Module details</h2> <table border="0" class="tabledefault" id="eml-view"> <tr> <td class="tablepanel"> Recommended Usage: </td><td class="tablepanel">all datasets that contain one or more views</td> </tr> <tr> <td class="tablepanel"> Stand-alone: </td><td class="tablepanel">yes</td> </tr> <tr> <td class="tablepanel"> Imports: </td><td class="tablepanel">eml-entity, eml-documentation, eml-attribute, eml-protocol, eml-physical, eml-coverage, eml-resource, eml-constraint</td> </tr> <tr> <td class="tablepanel"> Imported By: </td><td class="tablepanel"></td> </tr> <tr> <td class="tablepanel"> View an image of the schema: </td><td class="tablepanel"><a href="eml-view.png" target="offline">eml-view image</a></td> </tr> </table> <table class="tabledefault" border="0"> <tr> <td colspan="2"> <h2>Element Definitions:</h2> </td> </tr> <tr> <td class="tablehead" colspan="1"><a class="sitelink" name="view"></a> <h4>view </h4> </td><td class="tablehead" colspan="1">This element has no default value.</td> </tr> <tr> <td width="40%" class="tablepanel"> Content of this field: </td><td class="tablepanel"> Description of this field: </td> </tr> <tr> <td class="tablepanel"> <table class="tabledefault" border="0"> <tr> <td class="tablepanel" valign="top"><span class="boldtext">Type: </span><a class="sitelink" href="#ViewType">ViewType</a></td> </tr> </table> </td><td valign="top" class="tablepanel" colspan="1"> <blockquote>The View element is a container for documenting a view. The structure of the view element is defined by the ViewType.</blockquote> </td> </tr> <tr> <td class="tablehead" colspan="1"><a class="sitelink" name="attributeList"></a> <h4>attributeList </h4> </td><td class="tablehead" colspan="1">This element has no default value.</td> </tr> <tr> <td width="40%" class="tablepanel"> Content of this field: </td><td class="tablepanel"> Description of this field: </td> </tr> <tr> <td class="tablepanel"> <table class="tabledefault" border="0"> <tr> <td class="tablepanel" valign="top"><span class="boldtext">Type: </span><a class="sitelink" href="eml-attribute.html#AttributeListType">att:AttributeListType</a></td> </tr> </table> </td><td valign="top" class="tablepanel" colspan="1"> <blockquote>The list of attributes associated with this entity. For more information see the eml-attribute module.</blockquote> </td> </tr> <tr> <td class="tablehead" colspan="1"><a class="sitelink" name="constraint"></a> <h4>constraint </h4> </td><td class="tablehead" colspan="1">This element has no default value.</td> </tr> <tr> <td width="40%" class="tablepanel"> Content of this field: </td><td class="tablepanel"> Description of this field: </td> </tr> <tr> <td class="tablepanel"> <table class="tabledefault" border="0"> <tr> <td class="tablepanel" valign="top"><span class="boldtext">Type: </span><a class="sitelink" href="eml-constraint.html#ConstraintType">con:ConstraintType</a></td> </tr> </table> </td><td valign="top" class="tablepanel" colspan="1"> <blockquote>Description of any relational constraints on ' this entity. For more information see the eml-constraint module.</blockquote> </td> </tr> <tr> <td class="tablehead" colspan="1"><a class="sitelink" name="queryStatement"></a> <h4>queryStatement </h4> </td><td class="tablehead" colspan="1">This element has no default value.</td> </tr> <tr> <td width="40%" class="tablepanel"> Content of this field: </td><td class="tablepanel"> Description of this field: </td> </tr> <tr> <td class="tablepanel"> <table class="tabledefault" border="0"> <tr> <td class="tablepanel" valign="top"><span class="boldtext">Type: </span><a class="sitelink" href="eml-resource.html#NonEmptyStringType">res:NonEmptyStringType</a></td> </tr> </table> </td><td valign="top" class="tablepanel" colspan="1"> <blockquote>The value of a queryStatement field is the actual query statement stored in the database is entered here. The query statement generates the entity being documented.<br> <span class="boldtext">Example(s): </span> <br>Select site as SiteID,common_name as CommonName, count as CountOfIndividuals from samples inner join taxonlist on samples.speciesid=taxonlist.speciesid<br> </blockquote> </td> </tr> <tr> <td colspan="2"> <h2>Attribute Definitions:</h2> </td> </tr> <tr> <td colspan="2" class="tablehead"><a class="sitelink" name="id"></a> <h4>id</h4> </td> </tr> <tr> <td class="tablepanel"> <p> <span class="boldtext">Type: </span><span class="plaintext"><a class="sitelink" href="eml-resource.html#IDType">res:IDType</a></span> </p> <p> <span class="boldtext">Use: </span><span class="plaintext">optional</span> </p> </td> </tr> <tr> <td colspan="2" class="tablehead"><a class="sitelink" name="system"></a> <h4>system</h4> </td> </tr> <tr> <td class="tablepanel"> <p> <span class="boldtext">Type: </span><span class="plaintext"><a class="sitelink" href="eml-resource.html#SystemType">res:SystemType</a></span> </p> <p> <span class="boldtext">Use: </span><span class="plaintext">optional</span> </p> </td> </tr> <tr> <td colspan="2" class="tablehead"><a class="sitelink" name="scope"></a> <h4>scope</h4> </td> </tr> <tr> <td class="tablepanel"> <p> <span class="boldtext">Type: </span><span class="plaintext"><a class="sitelink" href="eml-resource.html#ScopeType">res:ScopeType</a></span> </p> <p> <span class="boldtext">Use: </span><span class="plaintext">optional</span> </p> <p> <span class="boldtext">Default value: </span><span class="plaintext">document</span> </p> </td> </tr> <tr> <td colspan="2"> <h2>Complex Type Definitions:</h2> </td> </tr> <tr> <td class="tablehead" colspan="1"><a class="sitelink" name="ViewType"></a> <h4>ViewType </h4> </td><td class="tablehead" colspan="1"> </td> </tr> <tr> <td width="40%" class="tablepanel"> Content of this field: </td><td class="tablepanel"> Description of this field: </td> </tr> <tr> <td class="tablepanel"> <table class="tabledefault" border="0"> <tr> <td class="tablepanel" valign="top"><span class="boldtext"> Elements: </span></td><td class="tablepanel" valign="top"><span class="boldtext"> Use: </span></td><td class="tablepanel" valign="top"><span class="boldtext"> How many: </span></td> </tr> <tr> <td class="tablepanel" colspan="3"> A choice of (</td> </tr> <tr> <td class="tablepanel" colspan="3"> A sequence of (</td> </tr> <tr> <td class="tablepanel"><a class="sitelink" href="eml-entity.html#EntityGroup">ent:EntityGroup</a></td><td class="tablepanel"> </td><td class="tablepanel"> </td> </tr> <tr> <td class="tablepanel"><a class="sitelink" href="#attributeList">attributeList</a></td><td class="tablepanel">required</td><td class="tablepanel"></td> </tr> <tr> <td class="tablepanel"><a class="sitelink" href="#constraint">constraint</a></td><td class="tablepanel">optional</td><td class="tablepanel">unbounded</td> </tr> <tr> <td class="tablepanel"><a class="sitelink" href="#queryStatement">queryStatement</a></td><td class="tablepanel">required</td><td class="tablepanel"></td> </tr> <tr> <td class="tablepanel" colspan="3">)</td> </tr> <tr> <td class="tablepanel" colspan="3"> OR </td> </tr> <tr> <td class="tablepanel"><a class="sitelink" href="eml-resource.html#ReferencesGroup">res:ReferencesGroup</a></td><td class="tablepanel"> </td><td class="tablepanel"> </td> </tr> <tr> <td class="tablepanel" colspan="3">)</td> </tr> <tr> <td class="tablepanel" valign="top"><span class="boldtext"> Attributes: </span></td><td class="tablepanel" valign="top"><span class="boldtext"> Use: </span></td><td class="tablepanel" valign="top"><span class="boldtext"> Default Value: </span></td> </tr> <tr> <td class="tablepanel"><a class="sitelink" href="#id">id</a></td><td class="tablepanel"><span class="plaintext">optional</span></td> </tr> <tr> <td class="tablepanel"><a class="sitelink" href="#system">system</a></td><td class="tablepanel"><span class="plaintext">optional</span></td> </tr> <tr> <td class="tablepanel"><a class="sitelink" href="#scope">scope</a></td><td class="tablepanel"><span class="plaintext">optional</span></td><td class="tablepanel"><span class="plaintext">document</span></td> </tr> </table> </td><td valign="top" class="tablepanel" colspan="1"> <blockquote>The ViewType complex type defines the structure for documenting a view. This type extends the EntityGroup with a queryStatement.</blockquote> </td> </tr> <tr> <td colspan="2"> <h2>Group Definitions:</h2> </td> </tr> </table> <p class="contact"> Web Contact: <a href="mailto:jones@nceas.ucsb.edu">jones@nceas.ucsb.edu</a> </p> </div> </body> </html>