Project

General

Profile

metacat / lib / pathquery.dtd @ 681

1
<!--
2
  * pathquery.dtd
3
  *
4
  *      Authors: Matt Jones
5
  * Organization: National Center for Ecological Analysis and Synthesis
6
  *    Copyright: 2000 Regents of the University of California and the
7
  *               National Center for Ecological Analysis and Synthesis
8
  *  For Details: http://www.nceas.ucsb.edu/
9
  *      Created: 13 June 2000
10
  *    File Info: '$Id: pathquery.dtd 535 2000-11-14 01:04:48Z jones $'
11
  *
12
  * This DTD describes the structure and content of XML documents used
13
  * to represent, store, and exchange a simple path-based query expression.
14
  * This syntax represents a small subset of the capabilities of the XPath 
15
  * language (http://www.w3.org/TR/xpath), and is intended as a simple
16
  * query language for the metadata catalog database (mcdb).  It is 
17
  * intended that all expressions in this language can be mapped directly
18
  * into XPath syntax, but not all Xpath expressions can be mapped into this
19
  * syntax.
20
  *
21
  * Although ideally we would implement the query language as either the full
22
  * XPath language or as one of the emerging XML query languages (like
23
  * XML-QL or XQL), in practice this would be an involved undertaking that
24
  * doesn't necessarily have high payoffs.  But we will revisit this issue and
25
  * determine later whether these full-featured technologies are warranted
26
  * after we have some experience with a simpler implementation such as this.
27
-->
28

    
29
<!-- Overall query container -->
30
<!ELEMENT pathquery (meta_file_id*, querytitle*, returndoctype*, returnfield*, 
31
                     owner*, site*, querygroup)>
32

    
33
<!-- The version of this query specification -->
34
<!ATTLIST pathquery version CDATA #FIXED "1.1">
35

    
36
<!-- a unique identifier for this query document -->
37
<!ELEMENT meta_file_id (#PCDATA)>
38

    
39
<!-- a descriptive title for this query document -->
40
<!ELEMENT querytitle (#PCDATA)>
41

    
42
<!-- optional doctype filter - only documents with this type are returned -->
43
<!ELEMENT returndoctype (#PCDATA)>
44

    
45
<!-- optional name of an xml node to be returned in the resultset -->
46
<!ELEMENT returnfield (#PCDATA)>
47

    
48
<!-- optional name of the owner of the documents to be returned -->
49
<!-- multiple owner fields are ORed together in the query -->
50
<!ELEMENT owner (#PCDATA)>
51

    
52
<!-- optional name of the site/server of the documents to be returned -->
53
<!-- multiple site fields are ORed together in the query -->
54
<!ELEMENT site (#PCDATA)>
55

    
56
<!-- A group of related query terms -->
57
<!ELEMENT querygroup ( (queryterm|querygroup)+ )>
58

    
59
<!-- the boolean expression used to combine the query terms in this group -->
60
<!ATTLIST querygroup operator (INTERSECT|UNION) #REQUIRED>
61

    
62
<!-- a query term is the atomic unit of a query that can be translated
63
     to a single SELECT statement -->
64
<!ELEMENT queryterm (value, pathexpr?)>
65

    
66
<!-- a boolean flag indicating whether matches should be case-sensitive or
67
     case-independent for this queryterm, one of: true|false
68
     and searchmode is the type of match to perform against the text value -->
69
<!ATTLIST queryterm casesensitive (true|false) #REQUIRED
70
                    searchmode 
71
        (contains|starts-with|ends-with|matches-exactly) #REQUIRED>
72

    
73
<!-- the text value for which we are searching -->
74
<!ELEMENT value (#PCDATA)>
75

    
76
<!-- the path to the TEXT node used to constrain the query -->
77
<!ELEMENT pathexpr (#PCDATA)>
78

    
79
<!-- End of file -->