Project

General

Profile

metacat / lib / pathquery.dtd @ 173

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 173 2000-06-16 23:42:44Z 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*, querygroup)>
31

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

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

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

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

    
44
<!-- A group of related query terms -->
45
<!ELEMENT querygroup ( (queryterm|querygroup)+ )>
46

    
47
<!-- the boolean expression used to combine the query terms in this group -->
48
<!ATTLIST querygroup booleantype (AND|OR) #REQUIRED>
49

    
50
<!-- a query term is the atomic unit of a query that can be translated
51
     to a single SELECT statement -->
52
<!ELEMENT queryterm (value, pathexpr?)>
53

    
54
<!-- a boolean flag indicating whether matches should be case-sensitive or
55
     case-independent for this queryterm, one of: true|false
56
     and searchmode is the type of match to perform against the text value -->
57
<!ATTLIST queryterm casesensitive (true|false) #REQUIRED
58
                    searchmode 
59
        (contains|starts-with|ends-with|matches-exactly) #REQUIRED>
60

    
61
<!-- the text value for which we are searching -->
62
<!ELEMENT value (#PCDATA)>
63

    
64
<!-- the path to the TEXT node used to constrain the query -->
65
<!ELEMENT pathexpr (#PCDATA)>
66

    
67
<!-- End of file -->