/[volute]/trunk/projects/registry/VODataService/VODataService.tex
ViewVC logotype

Diff of /trunk/projects/registry/VODataService/VODataService.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 5054 by msdemlei, Fri Jun 22 13:42:22 2018 UTC revision 5055 by msdemlei, Fri Jun 22 13:59:25 2018 UTC
# Line 1  Line 1 
1  \documentclass[11pt,a4paper]{ivoa}  \documentclass[11pt,a4paper]{ivoa}
2  \input tthdefs  \input tthdefs
3    \usepackage{listings}
4    \lstloadlanguages{XML}
5    \lstset{flexiblecolumns=true,tagstyle=\ttfamily,showstringspaces=False}
6    \usepackage{todonotes}
7    
8  \title{VODataService: A VOResource Schema Extension for Describing  \title{VODataService: A VOResource Schema Extension for Describing
9  Collections and Services}  Collections and Services}
# Line 119  Line 123 
123  for the standardization of new metadata for describing specialized  for the standardization of new metadata for describing specialized
124  kinds of resources in a modular way without deprecating the core  kinds of resources in a modular way without deprecating the core
125  schema or other extensions.  This document defines one such extension  schema or other extensions.  This document defines one such extension
126  referred to as \strong{VODataService}.  referred to as VODataService.
127    
128  \subsection{The Role in the IVOA Architecture}  \subsection{The Role in the IVOA Architecture}
129    
# Line 306  Line 310 
310  This example illustrates some of the features of the VODataService  This example illustrates some of the features of the VODataService
311  extension:  extension:
312    
313  \begin{enumeration}  \begin{enumerate}
314  \item the extra namespaces associated with  \item the extra namespaces associated with
315         VODataService metadata; if STC coverage information         VODataService metadata; if STC coverage information
316         \citep{STC} is not         \citep{STC} is not
# Line 326  Line 330 
330         description plus waveband keywords.         description plus waveband keywords.
331  \item a description of the table that is returned  \item a description of the table that is returned
332         by the service.         by the service.
333  \end{enumeration}  \end{enumerate}
334    
335  \subsection{The Schema Namespace and Location}  \subsection{The Schema Namespace and Location}
336    
# Line 368  Line 372 
372  The prefix, \xmlel{vs}, is used by convention as the prefix  The prefix, \xmlel{vs}, is used by convention as the prefix
373  defined for the VODataService schema; however, instance documents may  defined for the VODataService schema; however, instance documents may
374  use any prefix.  In applications where common use of prefixes is  use any prefix.  In applications where common use of prefixes is
375  recommended (such as with the Registry Interface specification [<a  recommended (such as with the Registry Interfaces specification),
376  href="#RI">RI</a>]), use of the \xmlel{vs} prefix is recommended.  use of the \xmlel{vs} prefix is recommended.
377  Note also that in this document, the \xmlel{vr} prefix is used to  Note also that in this document, the \xmlel{vr} prefix is used to
378  label, as shorthand, a type or element name that is defined in the  label, as shorthand, a type or element name that is defined in the
379  VOResource schema, as in \xmlel{vr:Resource}.  VOResource schema, as in \xmlel{vr:Resource}.
# Line 385  Line 389 
389         it is already in defined to represent VODataService v1.0 and         it is already in defined to represent VODataService v1.0 and
390         cannot be overridden.  At this writing, there are no IVOA         cannot be overridden.  At this writing, there are no IVOA
391         applications in which this is the case.  Consult         applications in which this is the case.  Consult
392         <a href="#appB">Appendix B</a> for more details on         appendix~\ref{vods10-compat} for more details on
393         compatibility issues.</dd>         compatibility issues.</dd>
394  \end{admonition}  \end{admonition}
395    
# Line 449  Line 453 
453         data access layer protocols such as Simple Image Access         data access layer protocols such as Simple Image Access
454         \citep{SIA} and Simple Cone Search         \citep{SIA} and Simple Cone Search
455         \citep{SCS}.         \citep{SCS}.
456    \end{bigdescription}
457    
458    
459  In general, \xmlel{coverage} refers to  In general, \xmlel{coverage} refers to
# Line 814  Line 819 
819  \item\verb|schema[@name="default"]|  \item\verb|schema[@name="default"]|
820  \item\verb|schema/table[@name="default"]|  \item\verb|schema/table[@name="default"]|
821  \end{itemize}  \end{itemize}
822    \end{admonition}
823    
824  Name uniqueness is only required when the table set description is  Name uniqueness is only required when the table set description is
825  part of a VOResource description.  The name uniqueness rules  part of a VOResource description.  The name uniqueness rules
# Line 860  Line 866 
866  use of the following extension mechanisms when richer descriptions are  use of the following extension mechanisms when richer descriptions are
867  desired:  desired:
868    
869  \begin{enumeration}  \begin{enumerate}
870  \item Use extended types by applying the \xmlel{xsi:type}  \item Use extended types by applying the \xmlel{xsi:type}
871         attribute to the \xmlel{tableset},         attribute to the \xmlel{tableset},
872         \xmlel{schema}, \xmlel{table},         \xmlel{schema}, \xmlel{table},
# Line 891  Line 897 
897         section~\ref{sect:tbldatatypes}).         section~\ref{sect:tbldatatypes}).
898         to indicate a more specific data type then those defined by the         to indicate a more specific data type then those defined by the
899         \xmlel{vs:TableParam} type.         \xmlel{vs:TableParam} type.
900  \end{enumeration}  \end{enumerate}
901    
902  \subsection{Interface Type Extension: ParamHTTP}  \subsection{Interface Type Extension: ParamHTTP}
903  \label{sect:paramif}  \label{sect:paramif}
# Line 976  Line 982 
982  describing a standard interface as long as these are consistent with  describing a standard interface as long as these are consistent with
983  the service specification and the corresponding \xmlel{param}  the service specification and the corresponding \xmlel{param}
984  elements include the attribute \verb|use="required"| (see  elements include the attribute \verb|use="required"| (see
985  section~\ref{sect:inputparam).  The \xmlel{param}  section~\ref{sect:inputparam}.  The \xmlel{param}
986  elements for custom parameters that are not part of the standard (but  elements for custom parameters that are not part of the standard (but
987  are rather local customizations) should include the attribute  are rather local customizations) should include the attribute
988  \verb|std="false"|.  \verb|std="false"|.
# Line 1168  Line 1174 
1174    
1175  The \xmlel{vs:TAPType} XML type provides an additional attribute,  The \xmlel{vs:TAPType} XML type provides an additional attribute,
1176  \xmlel{size}, corresponding to the \verb|"size"| column from the  \xmlel{size}, corresponding to the \verb|"size"| column from the
1177  TAP_SCHEMA.columns defined by the TAP standard  TAP\_SCHEMA.columns defined by the TAP standard
1178  \citep{TAP}.\todo{deprecate}  \citep{TAP}.\todo{deprecate}
1179    
1180    
# Line 1226  Line 1232 
1232  encouraged to use the \xmlel{extendedType} attribute to refer to  encouraged to use the \xmlel{extendedType} attribute to refer to
1233  a more specific type.  Note that the TAP standard  a more specific type.  Note that the TAP standard
1234  \citep{TAP} defines an explicit mapping between  \citep{TAP} defines an explicit mapping between
1235  TAP_SCHEMA types and VOTable types.  Thus, in the context of a  TAP\_SCHEMA types and VOTable types.  Thus, in the context of a
1236  \xmlel{vs:CatalogService} resource description that supports a  \xmlel{vs:CatalogService} resource description that supports a
1237  TAP capability (perhaps in addition to other catalog services like  TAP capability (perhaps in addition to other catalog services like
1238  Simple Cone Search \citep{SCS}), use of the  Simple Cone Search \citep{SCS}), use of the
# Line 1244  Line 1250 
1250         generated using the \xmlel{vs:VOTableType} data types from         generated using the \xmlel{vs:VOTableType} data types from
1251         these interface's respective metadata queries.  Newer services         these interface's respective metadata queries.  Newer services
1252         supporting TAP could generate its description using its         supporting TAP could generate its description using its
1253         TAP_SCHEMA queries.         TAP\_SCHEMA queries.
1254    
1255                
1256         The motivation for specifying a column's data type using the         The motivation for specifying a column's data type using the
# Line 1259  Line 1265 
1265  \appendix  \appendix
1266    
1267  \section{Compatibility Issues with VODataService 1.0}  \section{Compatibility Issues with VODataService 1.0}
1268    \label{vods10-compat}
1269    
1270  The working draft version 1.0 of the VODataService schema has been in  The working draft version 1.0 of the VODataService schema has been in
1271  use in IVOA registries since about 2008\todo{Do we want to keep this?  use in IVOA registries since about 2008\todo{Do we want to keep this?
# Line 1338  Line 1345 
1345  \subsection{Changes since PR-20090903}  \subsection{Changes since PR-20090903}
1346    
1347  \begin{itemize}  \begin{itemize}
1348    \item <a href="#paramif">S3.4</a>:  added \xmlel{&lt:testQuery}    \item added \xmlel{testQuery}
1349         to \xmlel{vs:ParamHTTP}         to \xmlel{vs:ParamHTTP}
1350    \item <a href="#paramif">S3.1.1</a>:  in text, added explanation of    \item in text, added explanation of
1351         \xmlel{vs:Format}         \xmlel{vs:Format}
1352    \item grammatical clean-up    \item grammatical clean-up
1353  \end{itemize}  \end{itemize}
# Line 1348  Line 1355 
1355  \subsection{Changes since WD-20090508 (v1.10)}  \subsection{Changes since WD-20090508 (v1.10)}
1356    
1357  \begin{itemize}  \begin{itemize}
1358    \item corrected errors in example in <a href="#intro">Introduction</a>    \item corrected errors in example in Introduction
1359    \item added \xmlel{description} and    \item added \xmlel{description} and
1360         \xmlel{utype} elements to the         \xmlel{utype} elements to the
1361         \xmlel{vs:ForeignKey} type for consistency with TAP.         \xmlel{vs:ForeignKey} type for consistency with TAP.
# Line 1357  Line 1364 
1364         \xmlel{vs:VOTableType}.         \xmlel{vs:VOTableType}.
1365  \end{itemize}  \end{itemize}
1366    
1367  <h2><a id="References">References</a></h2>  \end{document}
   
 <dl>  
   <dt> <a name="Arch">[Arch]</a> </dt>  
   <dd> Arviset, Christophe and the IVOA Tehcnical Coordination Group  
        2010, <cite>The IVOA in 2010: Technical Assessment and  
        Roadmap</cite>, v1.0, IVOA Note, <i>in preparation.</i>  
     
   <dt> <a name="ADQL">[ADQL]</a> </dt>  
   <dd> Ortiz, I., Lusted, J., Dowler, P., Szalay, A., Shirasaki, Y.,  
        Nieto-Santisteban, M., Ohishi, M., O'Mullane, W., Osuna, P. 2008,<cite>  
        <a href="http://www.ivoa.net/Documents/latest/ADQL.html">  
        IVOA Astronomical Data Query Language</a></cite>, v2.00, IVOA  
        Recommendation,  
        \xmlel{http://www.ivoa.net/Documents/latest/ADQL.html}  
        </dd>  
         
   <dt> <a name="HTTP">[HTTP]</a> </dt>  
   <dd> Fielding, R., Gettys, J, Mogul, J., Frystyk, H., Masinter, L.,  
        Leach, P., Berners-Lee, T. 1999.  
        <cite><a href="http://www.ietf.org/rfc/rfc2616.txt">  
        Hypertext Transfer Protocol -- HTTP/1.1</a></cite>, IETF RFC 2616,  
        \xmlel{http://www.ietf.org/rfc/rfc2616.txt} </dd>  
   
   <dt> <a name="should">[RFC 2119]</a> </dt>  
   <dd> Bradner, S. 1997. <cite><a href="http://www.ietf.org/rfc/rfc2119.txt">  
        Key words for use in RFCs to Indicate Requirement  
        Levels</a></cite>, IETF RFC 2119,  
        \xmlel{http://www.ietf.org/rfc/rfc2119.txt} </dd>  
   
   <dt> <a name="RM">[RM]</a>  
   </dt><dd> Hanisch, Robert (ed.) 2004.  
        <cite><a href="http://www.ivoa.net/Documents/REC/ResMetadata/RM-20070302.html">  
        Resource Metadata for the Virtual Observatory, Version 1.12</a></cite>,  
        IVOA Recommendation,  
      \xmlel{http://www.ivoa.net/Documents/REC/ResMetadata/RM-20040426.htm}  
   
   <dt> <a name="RI">[RI]</a> </dt>  
   <dd> Benson, Kevin, Plante, Ray, Auden, Elizabeth, Graham, Matthew, Greene,  
        Gretchen, Hill, Martin, Linde, Tony, Morris, Dave, O'Mullane,  
        Wil, Rixon, Guy, Andrews, Kona 2008, <cite>  
        <a href="http://www.ivoa.net/Documents/RegistryInterface/20091104/">  
        IVOA Registry Interfaces</a></cite>, v1.0, IVOA  
        Recommendation,  
        \xmlel{http://www.ivoa.net/Documents/RegistryInterface/20091104/}  
        </dd>  
         
   </dd><dt> <a name="schema">[schema]</a>  
   </dt><dd> Fallside, David C., Walmsley, Priscilla (editors) 2004,  
        <cite><a href="http://www.w3.org/TR/xmlschema-0/">XML Schema  
        Part 0: Primer Second Edition</a></cite>, W3C Recommendation 28  
        October 2004, \xmlel{http://www.w3.org/TR/xmlschema-0/}  
   
   </dd><dt> <a name="SCS">[SCS]</a>  
   </dt><dd> Williams, Roy, Hanisch, Robert, Szalay, Alex and Plante, Ray 2008, <cite>  
        <a href="http://www.ivoa.net/Documents/REC/DAL/ConeSearch-20080222.html">  
        Simple Cone Search Version 1.03</a></cite>, IVOA Recommendation,  
        \xmlel{http://www.ivoa.net/Documents/REC/DAL/ConeSearch-20080222.html}.  
   
   </dd><dt> <a name="SIA">[SIA]</a>  
   </dt><dd> Tody, Doug, Plante, Ray, and Harrison, Paul 2009, <cite>  
        <a href="http://www.ivoa.net/Documents/SIA/20091116/">  
        Simple Image Access Specification Version 1.0</a></cite>, IVOA  
        Recommendation,  
        \xmlel{http://www.ivoa.net/Documents/SIA/20091116/}.  
   
   <dt> <a name="STC">[STC]</a> </dt>  
   <dd> Rots, Arnold 2007, <cite>  
        <a href="http://www.ivoa.net/Documents/REC/STC/STC-20071030.html">  
        Space-Time Coordinate Metadata for the Virtual Observatory</a></cite>,  
        v1.33, IVOA Recommendation,  
        \xmlel{href="http://www.ivoa.net/Documents/REC/STC/STC-20071030.html">}  
   <dt> <a name="SQLGuide">[SQLGuide]</a> </dt>  
   <dd> Date, C.J. and Darwin, Hugh 1997, <code>A Guide to the SQL  
        Standard</code>, Fourth Edition, (Addison-Wesley, Longman Inc.:  
        Reading), p 24. </dd>  
   
   <dt> <a name="TAP">[TAP]</a> </dt>  
   <dd> Dowler, P., Rixon, G., Tody, D. 2010, <cite>  
        <a href="http://www.ivoa.net/Documents/TAP/20100327/">Table Access  
        Protocol</a></cite>, v1.0, IVOA Recommendation,  
        \xmlel{http://www.ivoa.net/Documents/TAP/20100327/}  
        </dd>  
         
   <dt> <a name="UCD">[UCD]</a> </dt>  
   <dd> Martinez, A.P., Derriere, S., Delmotte, N., Gray, N., Mann, R.,  
        McGlynn, T., Ochsenbein, F., Osuna, P., Rixon, G., Williams, R.  
        2007, <cite>  
        <a href="http://www.ivoa.net/Documents/latest/UCDlist.html">  
        The UCD1+ Controlled Vocabulary</a></cite>,  
        v1.23, IVOA Recommendation,  
        \xmlel{http://www.ivoa.net/Documents/latest/UCDlist.html}  
        </dd>  
   
   <dt> <a name="VOR">[VOR]</a> </dt>  
   <dd> Plante, R., Benson, K., Graham, M., Greene,  
        G., Harrison, P., Lemson, G., Linde, T., Rixon,  
        G., St&eacute;b&eacute;, A. 2008, <cite>  
        <a href="http://www.ivoa.net/Documents/REC/ReR/VOResource-20080222.html">  
        VOResource: an XML Encoding Schema for Resource Metadata</a></cite>,  
        v1.03, IVOA Recommendation,  
        \xmlel{http://www.ivoa.net/Documents/REC/ReR/VOResource-20080222.html}  
        </dd>  
   
   <dt> <a name="VOSI">[VOSI]</a>  
   <dd> Graham, M. and Rixon, G. 2010, <cite>  
        <a href="http://www.ivoa.net/Documents/VOSI/20100311/PR-VOSI-1.0-20100311.html">  
        IVOA Support Interfaces</a></cite>, v1.00 20101129, IVOA Proposed  
        Recommendation,  
        \xmlel{http://www.ivoa.net/Documents/VOSI/20100311/PR-VOSI-1.0-20100311.html} </dd>  
   
   </dd><dt> <a name="VOTable">[VOTable]</a>  
   </dt><dd>  Ochsenbein, F., Williams, R., Davenhall, C., Durand, D.,  
        Fernique, P., Giaretta, D., Hanisch, R., McGlynn, T., Szalay, A.,  
        Taylor, M.B., Wicenec, A. 2008, <cite>  
        <a href="http://www.ivoa.net/Documents/VOTable/20091130/REC-VOTable-1.2.html">  
        VOTable Format Definition</a>, version 1.20, IVOA Recommendation,  
        \xmlel{http://www.ivoa.net/Documents/VOTable/20091130/}  
   
   </dd><dt> <a name="xml">[xml]</a>  
   </dt><dd> Bray, Tim, Paoli, Jean, Sperberg-McQueen, C. M., Maler, Eve,  
        Yergeau, Francois (editors) 2004,  
        <cite><a href="http://www.w3.org/TR/REC-xml">Extensible Markup  
        Language (XML) 1.0 (Third Edition)</a></cite>, W3C  
        Recommendation 04 February 2004,  
        \xmlel{http://www.w3.org/TR/REC-xml}  
   
   
 </dl>  
   
 </body>  
 </html>  
   

Legend:
Removed from v.5054  
changed lines
  Added in v.5055

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26