Versino 5.0.21
[yaz-moved-to-github.git] / etc / pqf.properties
1 # Properties file to drive org.z3950.zing.cql.CQLNode's toPQF()
2 # back-end and the YAZ CQL-to-PQF converter.  This specifies the
3 # interpretation of various CQL indexes, relations, etc. in terms
4 # of Type-1 query attributes.
5 #
6 # This configuration file generates queries using BIB-1 attributes.
7 # See http://www.loc.gov/z3950/agency/zing/cql/dc-indexes.html
8 # for the Maintenance Agency's work-in-progress mapping of Dublin Core
9 # indexes to Attribute Architecture (util, XD and BIB-2)
10 # attributes.
11
12 # Identifiers for prefixes used in this file. (index.*)
13 set.cql         = info:srw/cql-context-set/1/cql-v1.2
14 set.rec         = info:srw/cql-context-set/2/rec-1.1
15 set.dc          = info:srw/cql-context-set/1/dc-v1.1
16 set.bath        = http://zing.z3950.org/cql/bath/2.0/
17
18 # The default set when an index doesn't specify one: Dublin Core
19 set             = info:srw/cql-context-set/1/dc-v1.1
20
21 # The default index when none is specified by the query
22 index.cql.serverChoice                  = 1=1016
23         # srw.serverChoice is deprecated in favour of cql.serverChoice
24         # BIB-1 "any"
25 index.cql.allRecords                    = 1=_ALLRECORDS 2=103
26
27 index.rec.id                            = 1=12
28
29 index.dc.title                          = 1=4
30 index.dc.subject                        = 1=21
31 index.dc.creator                        = 1=1003
32 index.dc.author                         = 1=1003
33         ### Unofficial synonym for "creator"
34 index.dc.editor                         = 1=1020
35 index.dc.publisher                      = 1=1018
36 index.dc.description                    = 1=62
37         # "abstract"
38 index.dc.date                           = 1=30
39 index.dc.resourceType                   = 1=1031
40         # guesswork: "Material-type"
41 index.dc.format                         = 1=1034
42         # guesswork: "Content-type"
43 index.dc.resourceIdentifier             = 1=12
44         # "Local number"
45 index.dc.source                         = 1=1019
46         # "Record-source"
47 index.dc.language                       = 1=54
48         # "Code--language"
49 index.dc.relation                       = 1=?
50         ### No idea how to represent this
51 index.dc.coverage                       = 1=?
52         ### No idea how to represent this
53 index.dc.rights                         = 1=?
54         ### No idea how to represent this
55
56 # Relation attributes are selected according to the CQL relation by
57 # looking up the "relation.<relation>" property:
58 #
59 relation.<                              = 2=1
60 relation.le                             = 2=2
61 relation.eq                             = 2=3
62 relation.exact                          = 2=3
63 relation.ge                             = 2=4
64 relation.>                              = 2=5
65 relation.<>                             = 2=6
66
67 # These two are what Zebra uses -- may not work on other servers
68 relation.all                            = 4=6
69 relation.any                            = 4=105
70
71 # BIB-1 doesn't have a server choice relation, so we just make the
72 # choice here, and use equality (which is clearly correct).
73 relation.scr                            = 2=3
74
75 # Relation modifiers.
76 #
77 relationModifier.relevant               = 2=102
78 relationModifier.fuzzy                  = 5=103
79         ### truncation=regExpr-2 (5=103) in Zebra is "fuzzy matching"
80 relationModifier.stem                   = 2=101
81 relationModifier.phonetic               = 2=100
82 relationModifier.regexp                 = 5=102
83 relationModifier.unmasked               = 5=100
84 relationModifier.masked                 =
85
86 # Non-standard extensions to provoke Zebra's inline sorting
87 relationModifier.sort                   = 7=1
88 relationModifier.sort-desc              = 7=2
89 relationModifier.numeric                = 4=109
90
91 # Position attributes may be specified for anchored terms (those
92 # beginning with "^", which is stripped) and unanchored (those not
93 # beginning with "^").  This may change when we get a BIB-1 truncation
94 # attribute that says "do what CQL does".
95 #
96 position.first                          = 3=1 6=1
97         # "first in field"
98 position.any                            = 3=3 6=1
99         # "any position in field"
100 position.last                           = 3=4 6=1
101         # not a standard BIB-1 attribute
102 position.firstAndLast                   = 3=3 6=3
103         # search term is anchored to be complete field
104
105 # Structure attributes may be specified for individual relations; a
106 # default structure attribute my be specified by the pseudo-relation
107 # "*", to be used whenever a relation not listed here occurs.
108 #
109 structure.exact                         = 4=108
110         # string
111 structure.all                           = 4=2
112 structure.any                           = 4=2
113 structure.*                             = 4=1
114         # phrase
115
116 # Truncation attributes used to implement CQL wildcard patterns.  The
117 # simpler forms, left, right- and both-truncation will be used for the
118 # simplest patterns, so that we produce PQF queries that conform more
119 # closely to the Bath Profile.  However, when a more complex pattern
120 # such as "foo*bar" is used, we fall back on Z39.58-style masking.
121 #
122 truncation.right                        = 5=1
123 truncation.left                         = 5=2
124 truncation.both                         = 5=3
125 truncation.none                         = 5=100
126 truncation.regexp                       = 5=102
127 truncation.z3958                        = 5=104
128
129 # Finally, any additional attributes that should always be included
130 # with each term can be specified in the "always" property.
131 #
132 always                                  = 6=1
133 # 6=1: completeness = incomplete subfield
134
135
136 # Bath Profile support, added Thu Dec 18 13:06:20 GMT 2003
137 # See the Bath Profile for SRW at
138 #       http://zing.z3950.org/cql/bath.html
139 # including the Bath Context Set defined within that document.
140 #
141 # In this file, we only map index-names to BIB-1 use attributes, doing
142 # so in accordance with the specifications of the Z39.50 Bath Profile,
143 # and leaving the relations, wildcards, etc. to fend for themselves.
144
145 index.bath.keyTitle                     = 1=33
146 index.bath.possessingInstitution        = 1=1044
147 index.bath.name                         = 1=1002
148 index.bath.personalName                 = 1=1
149 index.bath.corporateName                = 1=2
150 index.bath.conferenceName               = 1=3
151 index.bath.uniformTitle                 = 1=6
152 index.bath.isbn                         = 1=7
153 index.bath.issn                         = 1=8
154 index.bath.geographicName               = 1=58
155 index.bath.notes                        = 1=63
156 index.bath.topicalSubject               = 1=1079
157 index.bath.genreForm                    = 1=1075
158