/[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 5196 by msdemlei, Thu Oct 25 14:31:14 2018 UTC revision 5197 by msdemlei, Thu Oct 25 14:47:15 2018 UTC
# Line 1989  Line 1989 
1989  \begin{description}  \begin{description}
1990  \item[Type] string: \xmlel{xs:string}  \item[Type] string: \xmlel{xs:string}
1991  \item[Meaning]  \item[Meaning]
1992                       the string that is used to delimit elements of an array                       a string that is used to delimit elements of an array
1993                       value when arraysize is not “1”.                       value in InputParams.
1994                                        
1995  \item[Occurrence] optional  \item[Occurrence] optional
1996  \item[Comment]  \item[Comment]
# Line 2062  Line 2062 
2062  \xmlel{vs:DataType} attributes, defined below.  The  \xmlel{vs:DataType} attributes, defined below.  The
2063  \xmlel{arraysize} attribute indicates the parameter is an array  \xmlel{arraysize} attribute indicates the parameter is an array
2064  of values of the named type.  Its value describes the shape of the  of values of the named type.  Its value describes the shape of the
2065  array, and the \xmlel{delim} attribute may be used to indicate  array. When there is no natural serialisation defined through the type
2066  the delimiter that should appear between elements of an array value.  system, the \xmlel{delim} attribute may be used to indicate
2067  Depending on the application context, these attribute may not be  a delimiter that should appear between elements of an array value.  This
2068  enough to effectively parse the array values, in which case more  attribute must not be combined with VOTableDataType, which always
2069  information must be brought to bear either through assumptions about  uses VOTable serialisation rules.
 a particular derived \xmlel{vs:DataType} or through additional  
 attributes.    
2070    
2071    
2072    
# Line 2077  Line 2075 
2075  provide an alternate data type name.  It is expected that this name  provide an alternate data type name.  It is expected that this name
2076  will only be understood by a special subset of applications.  The name  will only be understood by a special subset of applications.  The name
2077  given in the element content, then, represents a more commonly  given in the element content, then, represents a more commonly
2078  understood "fall-back" type.   Arbitrary information can also be  understood “fall-back” type.   Arbitrary information can also be
2079  provided via any prefix-qualified, globally defined attribute drawn  provided via any prefix-qualified, globally defined attribute drawn
2080  from an XML Schema other than VODataService (by virtue of the  from an XML Schema other than VODataService (by virtue of the
2081  \xmlel{xs:anyAttribute} specification present  \xmlel{xs:anyAttribute} specification present
# Line 2219  Line 2217 
2217    
2218  By fixing the \xmlel{dataType} child element to that of the  By fixing the \xmlel{dataType} child element to that of the
2219  \xmlel{vs:SimpleDataType}, the possible types are restricted to  \xmlel{vs:SimpleDataType}, the possible types are restricted to
2220  predefined set appropriate for input parameters.  predefined set appropriate for input parameters.\todo{On the other hand,
2221    also allowing VOTable types here would help a lot with, e.g., SODA and
2222    friends.  Anyone objecting to opening up the type system here?}
2223    
2224    
2225    
# Line 2367  Line 2367 
2367  SQL reserved name, and a SIAP 1.0-compatible \verb|wcs_cdmatrix|  SQL reserved name, and a SIAP 1.0-compatible \verb|wcs_cdmatrix|
2368  column that shows how multidimensional arrays are declared:  column that shows how multidimensional arrays are declared:
2369    
2370  \begin{lstlisting}[language=XML]  \begin{lstlisting}[language=XML,basicstyle=\footnotesize]
2371  <column>  <column>
2372     <name> Dec </name>     <name> Dec </name>
2373     <description> the J2000 declination of the object </description>     <description> the J2000 declination of the object </description>
# Line 2481  Line 2481 
2481    
2482  % /GENERATED  % /GENERATED
2483    
 % GENERATED: !schemadoc VODataService-v1.2.xsd TAPType  
 \begin{generated}  
 \begingroup  
         \renewcommand*\descriptionlabel[1]{%  
         \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{vs:TAPType} Type Schema Documentation}  
   
 \noindent{\small  
             a data type supported explicitly by the Table Access  
             Protocol (v1.0).  This is deprecated in VODataService 1.2,  
             and even TAP 1.0 services are encouraged to declare  
             their columns using VOTableType.  
          \par}  
   
 \vspace{1ex}\noindent\textbf{\xmlel{vs:TAPType} Type Schema Definition}  
   
 \begin{lstlisting}[language=XML,basicstyle=\footnotesize]  
 <xs:complexType name="TAPType" >  
   <xs:simpleContent >  
     <xs:restriction base="vs:TAPDataType" >  
       <xs:enumeration value="BOOLEAN" />  
       <xs:enumeration value="SMALLINT" />  
       <xs:enumeration value="INTEGER" />  
       <xs:enumeration value="BIGINT" />  
       <xs:enumeration value="REAL" />  
       <xs:enumeration value="DOUBLE" />  
       <xs:enumeration value="TIMESTAMP" />  
       <xs:enumeration value="CHAR" />  
       <xs:enumeration value="VARCHAR" />  
       <xs:enumeration value="BINARY" />  
       <xs:enumeration value="VARBINARY" />  
       <xs:enumeration value="POINT" />  
       <xs:enumeration value="REGION" />  
       <xs:enumeration value="CLOB" />  
       <xs:enumeration value="BLOB" />  
       <xs:attribute name="arraysize" type="vs:ArrayShape" />  
       <xs:attribute name="delim" type="xs:string" default=" " />  
       <xs:attribute name="extendedType" type="xs:string" />  
       <xs:attribute name="extendedSchema" type="xs:anyURI" />  
       <xs:attribute name="size" type="xs:positiveInteger" />  
       <xs:anyAttribute namespace="##other" />  
     </xs:restriction>  
   </xs:simpleContent>  
 </xs:complexType>  
 \end{lstlisting}  
   
 \vspace{0.5ex}\noindent\textbf{\xmlel{vs:TAPType} Attributes}  
   
 \begingroup\small\begin{bigdescription}  
 \item[arraysize]  
 \begin{description}  
 \item[Type] string of the form: \emph{([0-9]+x)*[0-9]*[0-9*]}  
 \item[Meaning]  
 \item[Occurrence] optional  
   
 \end{description}  
 \item[delim]  
 \begin{description}  
 \item[Type] string: \xmlel{xs:string}  
 \item[Meaning]  
 \item[Occurrence] optional  
   
 \end{description}  
 \item[extendedType]  
 \begin{description}  
 \item[Type] string: \xmlel{xs:string}  
 \item[Meaning]  
 \item[Occurrence] optional  
 \end{description}  
 \item[extendedSchema]  
 \begin{description}  
 \item[Type] a URI: \xmlel{xs:anyURI}  
 \item[Meaning]  
 \item[Occurrence] optional  
 \end{description}  
 \item[size]  
 \begin{description}  
 \item[Type] \xmlel{xs:positiveInteger}  
 \item[Meaning]  
 \item[Occurrence] optional  
 \end{description}  
   
   
 \end{bigdescription}\endgroup  
   
 \endgroup  
 \end{generated}  
   
 % /GENERATED  
   
   
   
   
 Examples for column definitions:  
 A representation of a string type using the  
 \xmlel{vs:VOTableType} set of types:  
   
 \begin{lstlisting}  
 <column>  
    <name> id </name>  
    <description> the object identifier </description>  
    <ucd> meta.id </ucd>  
    <dataType xsi:type="vs:VOTableType" arraysize="*"> char </dataType>  
 </column>  
 \end{lstlisting}  
   
   
2484    
2485    
2486  In general, the \xmlel{vs:TableParam}'s \xmlel{dataType}  In general, the \xmlel{vs:TableParam}'s \xmlel{dataType}

Legend:
Removed from v.5196  
changed lines
  Added in v.5197

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