complexType "vs:ForeignKey"
Namespace:
http://www.ivoa.net/xml/VODataService/v1.1
Content:
complex, 4 elements
Defined:
globally in VODataService.xsd; see XML source
Includes:
definitions of 4 elements
Used:
never
XML Representation Summary
<...>
   
Content: 
 targetTable, fkColumn+, description?, utype?
</...>
Content Model Elements (4):
description (type xs:token),
fkColumn (type vs:FKColumn),
targetTable (type xs:token),
utype (type xs:token)
Annotation
Annotation 1 [src]:
A description of the mapping a foreign key -- a set of columns from one table -- to columns in another table.
Annotation 2 [src]:
When foreign keys are declared in this way, clients can expect that joins constrained with the foreign keys are preformed efficiently (e.g., using an index).
XML Source (see within schema source)
<xs:complexType name="ForeignKey">
<xs:annotation>
<xs:documentation>
A description of the mapping a foreign key -- a set of
columns from one table -- to columns in another table.
</xs:documentation>
<xs:documentation>
When foreign keys are declared in this way, clients can expect
that joins constrained with the foreign keys are preformed
efficiently (e.g., using an index).
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="targetTable" type="xs:token">
<xs:annotation>
<xs:documentation>
The fully qualified name (including catalogue and schema, as
applicable) of the table that can be joined with the
table containing this foreign key.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="1" name="fkColumn" type="vs:FKColumn">
<xs:annotation>
<xs:documentation>
A pair of column names, one from this table and one
from the target table that should be used to join the
tables in a query.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="description" type="xs:token">
<xs:annotation>
<xs:documentation>
A free-text description of what this key points to
and what the relationship means.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="utype" type="xs:token">
<xs:annotation>
<xs:documentation>
An identifier for a concept in a data model that
the association enabled by this key represents.
</xs:documentation>
<xs:documentation>
The form of the utype string depends on the data
model; common forms are sequences of dotted identifiers
(e.g., in SSA) or URIs (e.g., in RegTAP).
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations; 4)
description
Type:
xs:token, simple content
Defined:
locally within (this) vs:ForeignKey complexType
A free-text description of what this key points to and what the relationship means.
XML Source (see within schema source)
<xs:element minOccurs="0" name="description" type="xs:token">
<xs:annotation>
<xs:documentation>
A free-text description of what this key points to
and what the relationship means.
</xs:documentation>
</xs:annotation>
</xs:element>
fkColumn
Type:
vs:FKColumn, complex content
Defined:
locally within (this) vs:ForeignKey complexType
A pair of column names, one from this table and one from the target table that should be used to join the tables in a query.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="1" name="fkColumn" type="vs:FKColumn">
<xs:annotation>
<xs:documentation>
A pair of column names, one from this table and one
from the target table that should be used to join the
tables in a query.
</xs:documentation>
</xs:annotation>
</xs:element>
targetTable
Type:
xs:token, simple content
Defined:
locally within (this) vs:ForeignKey complexType
The fully qualified name (including catalogue and schema, as applicable) of the table that can be joined with the table containing this foreign key.
XML Source (see within schema source)
<xs:element name="targetTable" type="xs:token">
<xs:annotation>
<xs:documentation>
The fully qualified name (including catalogue and schema, as
applicable) of the table that can be joined with the
table containing this foreign key.
</xs:documentation>
</xs:annotation>
</xs:element>
utype
Type:
xs:token, simple content
Defined:
locally within (this) vs:ForeignKey complexType
Annotation 1 [src]:
An identifier for a concept in a data model that the association enabled by this key represents.
Annotation 2 [src]:
The form of the utype string depends on the data model; common forms are sequences of dotted identifiers (e.g., in SSA) or URIs (e.g., in RegTAP).
XML Source (see within schema source)
<xs:element minOccurs="0" name="utype" type="xs:token">
<xs:annotation>
<xs:documentation>
An identifier for a concept in a data model that
the association enabled by this key represents.
</xs:documentation>
<xs:documentation>
The form of the utype string depends on the data
model; common forms are sequences of dotted identifiers
(e.g., in SSA) or URIs (e.g., in RegTAP).
</xs:documentation>
</xs:annotation>
</xs:element>
This XML schema documentation has been generated with DocFlex/XML RE 1.8.0 using DocFlex/XML XSDDoc 2.2.0 template set.
DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
  • To document local element components both globally and locally (similar to attributes).
  • To enable/disable reproducing of namespace prefixes.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
  • To use the same template to generate the incredible quality RTF documentation.
  • To document only selected XML schema components specified by name.
  • To remove this very advertisement text
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To buy a license, please follow this link: http://www.filigris.com/shop/