Showing:

Annotations
Attributes
Diagrams
Instances
Model
Properties
Source
Used by
Imported schema eml-storedProcedure.xsd
Namespace eml://ecoinformatics.org/storedProcedure-2.2.0
Annotations
'$RCSfile: eml-storedProcedure.xsd,v $'
       Copyright: 1997-2002 Regents of the University of California,
                            University of New Mexico, and
                            Arizona State University
        Sponsors: National Center for Ecological Analysis and Synthesis and
                  Partnership for Interdisciplinary Studies of Coastal Oceans,
                     University of California Santa Barbara
                  Long-Term Ecological Research Network Office,
                     University of New Mexico
                  Center for Environmental Studies, Arizona State University
   Other funding: National Science Foundation (see README for details)
                  The David and Lucile Packard Foundation
     For Details: http://knb.ecoinformatics.org/

        '$Author: obrien $'
          '$Date: 2009-02-25 23:51:54 $'
      '$Revision: 1.46 $'

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
moduleName: eml-storedProcedure

moduleDescription: 
        
          
            The eml-storedProcedure module - Data tables
            resulting from procedures stored in a database
          
        
        

recommendedUsage: Use the storedProcedure module to document
        datasets that use storedProcedures to retrieve archived
        data.

standAlone: yes
Properties
attribute form default unqualified
element form default unqualified
Schema location file:/Volumes/mob/EML_schema/EML-2.2.0/git_checkouts/eml/tmp/eml-storedProcedure.xsd
Element storedProcedure
Namespace eml://ecoinformatics.org/storedProcedure-2.2.0
Annotations
tooltip: Stored Procedure>

summary: The storedProcedure element documents stored
        procedures.

description: The storedProcedure element is meant to capture
        information on procedures that produce data output in the form of a
        data table. In an RDBMS one can code complex queries and transactions
        into stored procedures and then invoke them directly from front-end
        applications. This element allows the optional description of any
        parameters that are expected to be passed to the procedure when it is
        called. A common use of a stored procedure is to rotate a data table
        from attributes in columns to attributes in rows for statistical
        analysis.
Diagram
Diagram NO_NAMESPACE.tmp#StoredProcedureType_id NO_NAMESPACE.tmp#StoredProcedureType_system NO_NAMESPACE.tmp#StoredProcedureType_scope NO_NAMESPACE.tmp#EntityGroup_alternateIdentifier NO_NAMESPACE.tmp#EntityGroup_entityName NO_NAMESPACE.tmp#EntityGroup_entityDescription NO_NAMESPACE.tmp#EntityGroup_physical NO_NAMESPACE.tmp#EntityGroup_coverage NO_NAMESPACE.tmp#EntityGroup_methods NO_NAMESPACE.tmp#EntityGroup_additionalInfo NO_NAMESPACE.tmp#EntityGroup_annotation entity-2_2_0.tmp#EntityGroup NO_NAMESPACE.tmp#StoredProcedureType_attributeList NO_NAMESPACE.tmp#StoredProcedureType_constraint NO_NAMESPACE.tmp#StoredProcedureType_parameter NO_NAMESPACE.tmp#ReferencesGroup_references resource-2_2_0.tmp#ReferencesGroup storedProcedure-2_2_0.tmp#StoredProcedureType
Type StoredProcedureType
Properties
content complex
Model
Children additionalInfo, alternateIdentifier, annotation, attributeList, constraint, coverage, entityDescription, entityName, methods, parameter, physical, references
Instance
<storedProcedure id="" scope="document" system="" xmlns="eml://ecoinformatics.org/storedProcedure-2.2.0">
  <alternateIdentifier system="">{0,unbounded}</alternateIdentifier>
  <entityName>{1,1}</entityName>
  <entityDescription>{0,1}</entityDescription>
  <physical id="" scope="document" system="">{0,unbounded}</physical>
  <coverage id="" scope="document" system="">{0,1}</coverage>
  <methods>{0,1}</methods>
  <additionalInfo xml:lang="">{0,unbounded}</additionalInfo>
  <annotation>{0,unbounded}</annotation>
  <attributeList id="">{1,1}</attributeList>
  <constraint id="" scope="document" system="">{0,unbounded}</constraint>
  <parameter>{0,unbounded}</parameter>
  <references system="">{1,1}</references>
</storedProcedure>
Attributes
QName Type Default Use
id IDType optional
scope ScopeType document optional
system SystemType optional
Source
<xs:element name="storedProcedure" type="StoredProcedureType">
  <xs:annotation>
    <xs:documentation>tooltip: Stored Procedure> summary: The storedProcedure element documents stored procedures. description: The storedProcedure element is meant to capture information on procedures that produce data output in the form of a data table. In an RDBMS one can code complex queries and transactions into stored procedures and then invoke them directly from front-end applications. This element allows the optional description of any parameters that are expected to be passed to the procedure when it is called. A common use of a stored procedure is to rotate a data table from attributes in columns to attributes in rows for statistical analysis.</xs:documentation>
  </xs:annotation>
</xs:element>
Schema location file:/Volumes/mob/EML_schema/EML-2.2.0/git_checkouts/eml/tmp/eml-storedProcedure.xsd
Complex Type StoredProcedureType
Namespace eml://ecoinformatics.org/storedProcedure-2.2.0
Annotations
tooltip: Stored Procedure complex type>

summary: Structure for documenting a stored procedure

description: The StoredProcedureType complex type defines the structure
        for documenting a stored procedure.
Diagram
Diagram NO_NAMESPACE.tmp#StoredProcedureType_id NO_NAMESPACE.tmp#StoredProcedureType_system NO_NAMESPACE.tmp#StoredProcedureType_scope NO_NAMESPACE.tmp#EntityGroup_alternateIdentifier NO_NAMESPACE.tmp#EntityGroup_entityName NO_NAMESPACE.tmp#EntityGroup_entityDescription NO_NAMESPACE.tmp#EntityGroup_physical NO_NAMESPACE.tmp#EntityGroup_coverage NO_NAMESPACE.tmp#EntityGroup_methods NO_NAMESPACE.tmp#EntityGroup_additionalInfo NO_NAMESPACE.tmp#EntityGroup_annotation entity-2_2_0.tmp#EntityGroup NO_NAMESPACE.tmp#StoredProcedureType_attributeList NO_NAMESPACE.tmp#StoredProcedureType_constraint NO_NAMESPACE.tmp#StoredProcedureType_parameter NO_NAMESPACE.tmp#ReferencesGroup_references resource-2_2_0.tmp#ReferencesGroup
Used by
Model
Children additionalInfo, alternateIdentifier, annotation, attributeList, constraint, coverage, entityDescription, entityName, methods, parameter, physical, references
Attributes
QName Type Default Use
id IDType optional
scope ScopeType document optional
system SystemType optional
Source
<xs:complexType name="StoredProcedureType">
  <xs:annotation>
    <xs:documentation>tooltip: Stored Procedure complex type> summary: Structure for documenting a stored procedure description: The StoredProcedureType complex type defines the structure for documenting a stored procedure.</xs:documentation>
  </xs:annotation>
  <xs:choice>
    <xs:sequence>
      <xs:group ref="ent:EntityGroup"/>
      <xs:element name="attributeList" type="att:AttributeListType">
        <xs:annotation>
          <xs:documentation>tooltip: Attribute List summary: The list of attributes associated with this entity. description: The list of attributes associated with this entity. For more information see the eml-attribute module.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="constraint" type="con:ConstraintType" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>tooltip: Constraint summary: description: Description of any relational constraints on ' this entity. For more information see the eml-constraint module.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="parameter" type="ParameterType" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>tooltip: Parameter summary: A parameter that is required as input to the stored procedure. description: The parameter elements defines the fields that may be required to invoke a stored procedure.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
    <xs:group ref="res:ReferencesGroup"/>
  </xs:choice>
  <xs:attribute name="id" type="res:IDType" use="optional"/>
  <xs:attribute name="system" type="res:SystemType" use="optional"/>
  <xs:attribute name="scope" type="res:ScopeType" use="optional" default="document"/>
</xs:complexType>
Schema location file:/Volumes/mob/EML_schema/EML-2.2.0/git_checkouts/eml/tmp/eml-storedProcedure.xsd
Complex Type ParameterType
Namespace eml://ecoinformatics.org/storedProcedure-2.2.0
Annotations
tooltip: Parameter complex type

summary: The structure for defining a parameter that is required as
        input to the stored procedure.

description: The parameter complex type defines the structure for
        documenting the parameters that may be required to invoke a stored
        procedure.
Diagram
Diagram NO_NAMESPACE.tmp#ParameterType_name NO_NAMESPACE.tmp#ParameterType_domainDescription NO_NAMESPACE.tmp#ParameterType_required NO_NAMESPACE.tmp#ParameterType_repeats
Used by
Model
Children domainDescription, name, repeats, required
Source
<xs:complexType name="ParameterType">
  <xs:annotation>
    <xs:documentation>tooltip: Parameter complex type summary: The structure for defining a parameter that is required as input to the stored procedure. description: The parameter complex type defines the structure for documenting the parameters that may be required to invoke a stored procedure.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="name" type="res:NonEmptyStringType">
      <xs:annotation>
        <xs:documentation>tooltip: Parameter Name summary: The name of the parameter. description: The value of the name field is the name of the parameter.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="domainDescription" type="res:NonEmptyStringType">
      <xs:annotation>
        <xs:documentation>tooltip: Domain Description summary: A description of domain of valid values for the parameter. description: The domainDescription field is used to describe the valid entries for the parameter being described. A stored procedure will work only when the parameter's value corresponds to an actual value in a database.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="required" type="xs:boolean">
      <xs:annotation>
        <xs:documentation>tooltip: Required summary: Whether or not the parameter is required. description: The required field is used to document whether the parameter being described is or is not required when invoking the stored procedure.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="repeats" type="xs:boolean">
      <xs:annotation>
        <xs:documentation>tooltip: Repeats summary: Whether or not the parameter repeats. description: The repeats field is used to document whether or not the parameter being described can be repeated when invoking the stored procedure.</xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>
Schema location file:/Volumes/mob/EML_schema/EML-2.2.0/git_checkouts/eml/tmp/eml-storedProcedure.xsd