← Back to branch summary

~ubuntu-branches/ubuntu/warty/ncbi-tools6/warty

« back to all changes in this revision

Viewing changes to network/entrez/client/netentr.asn

  • Committer: Bazaar Package Importer
  • Author(s): Aaron M. Ucko
  • Date: 2002-04-04 22:13:09 UTC
  • Revision ID: james.westby@ubuntu.com-20020404221309-vfze028rfnlrldct
Tags: upstream-6.1.20011220a
Import upstream version 6.1.20011220a

Show diffs side-by-side

added added

removed removed

Lines of Context:
network/entrez/client/netentr.asn
 
1
--$Revision: 6.0 $
 
2
--*********************************************************************
 
3
--
 
4
--  entrez.asn
 
5
--   Jim Ostell, 1993
 
6
--              revised from epstein/ostell 1992
 
7
--
 
8
--     messages for entrez functions
 
9
--
 
10
--*********************************************************************
 
11
 
 
12
NCBI-Entrez DEFINITIONS ::=
 
13
BEGIN
 
14
 
 
15
IMPORTS Seq-entry FROM NCBI-SeqSet
 
16
        Seq-id FROM NCBI-SeqLoc
 
17
        Medline-entry FROM NCBI-MedLine
 
18
        Link-set FROM NCBI-Access
 
19
        Biostruc, Biostruc-annot-set FROM MMDB
 
20
        Bioseq FROM NCBI-Sequence
 
21
        Date FROM NCBI-General
 
22
        Cdrom-inf,Docsum FROM NCBI-CdRom;
 
23
 
 
24
        --**********************************
 
25
        -- requests
 
26
        --
 
27
 
 
28
Entrez-request ::= CHOICE {
 
29
    init SEQUENCE {                -- EntrezInit
 
30
        version VisibleString OPTIONAL
 
31
    } ,
 
32
    maxlinks NULL ,                -- EntGetMaxLinks
 
33
    eval Entrez-termget ,          -- EntTLEval
 
34
    docsum Entrez-docget ,         -- DocSum
 
35
    linkuidlist Link-setget ,      -- LinkUidList
 
36
    uidlinks Link-setget ,         -- UidLinks
 
37
    byterm Entrez-term-by-term ,   -- TermListByTerm
 
38
    bypage Entrez-term-by-page ,   -- TermListByPage
 
39
    findterm Term-lookup ,         -- EntrezFindTerm
 
40
    fini NULL ,                    -- EntrezFini
 
41
    createnamed Entrez-named-list ,
 
42
    getmle Entrez-docget ,          -- get MedlineEntry
 
43
    getseq Entrez-seqget ,         -- get SeqEntry
 
44
    evalX Entrez-termget ,         -- EntTLEvalX
 
45
    createnamedX Entrez-named-listX ,
 
46
    seqidforgi INTEGER ,           -- EntrezSeqIdForGI
 
47
    findseqid Seq-id ,             -- EntrezFindSeqId
 
48
    canneighbortext NULL ,         -- EntrezCanNeighborText
 
49
    expanded-medline NULL ,
 
50
    get-hierarchy Term-lookup ,
 
51
    neighbortext Entrez-neighbor-text , -- EntrezNeighborText
 
52
    eval-count Entrez-termget ,         -- EntTLEvalCount
 
53
    initX SEQUENCE {                -- new EntrezInit
 
54
        version VisibleString OPTIONAL
 
55
    } ,
 
56
    getbiostr Entrez-docget ,       -- EntrezBiostrucGet (obselete)
 
57
    getbiostrX SEQUENCE {           -- EntrezBiostrucGet
 
58
        complexity INTEGER ,
 
59
        get Entrez-docget ,
 
60
        max-models INTEGER OPTIONAL } ,
 
61
    extrainfo INTEGER ,             -- obseletes maxlinks, canneighbortext, and expanded-medline
 
62
    blast Entrez-blastreq ,         -- BLAST request
 
63
    docsumX Entrez-docget ,         -- DocSum
 
64
    getgenome Entrez-docget ,          -- get Genome-based Seq-entry
 
65
    cluster-arts Cluster-articles ,
 
66
    getbiostrannot INTEGER ,
 
67
    getbiostr-feat-ids Get-feat-ids ,
 
68
    getbiostr-annot-by-fid Get-by-fid }
 
69
 
 
70
Get-by-fid ::= SEQUENCE {
 
71
        mmdbid INTEGER ,
 
72
        feature-id INTEGER ,
 
73
        feature-set-id INTEGER }
 
74
 
 
75
Get-feat-ids ::= SEQUENCE {
 
76
        mmdbid INTEGER ,
 
77
        feature-type INTEGER ,
 
78
        feature-set-id INTEGER }
 
79
 
 
80
Cluster-articles ::= SEQUENCE {
 
81
    ids Entrez-ids ,
 
82
    fld Entrez-field ,
 
83
    min-cluster INTEGER ,
 
84
    max-cluster INTEGER ,
 
85
    max-terms INTEGER }
 
86
 
 
87
Cluster-resp ::= SEQUENCE {
 
88
    count INTEGER ,
 
89
    terms SEQUENCE OF VisibleString ,
 
90
    term-counts SEQUENCE OF INTEGER }
 
91
 
 
92
Entrez-blastreq ::= SEQUENCE {
 
93
    bsp Bioseq ,                   -- the sequence to be BLASTed
 
94
    bsp-database Entrez-class ,
 
95
    program VisibleString OPTIONAL ,
 
96
    database VisibleString OPTIONAL ,
 
97
    options VisibleString OPTIONAL ,
 
98
    showprogress BOOLEAN OPTIONAL }
 
99
 
 
100
Entrez-docget ::= SEQUENCE {
 
101
    class Entrez-class ,
 
102
    mark-missing BOOLEAN OPTIONAL ,
 
103
    ids Entrez-ids ,
 
104
    defer-count INTEGER OPTIONAL }
 
105
 
 
106
Entrez-seqget ::= SEQUENCE {       -- SeqEntryGet
 
107
    retype ENUMERATED {
 
108
        fetch-from-id (-2) ,    -- fetch these entries from the ID service
 
109
        unmatched (-1) ,        -- an entry which for which SeqIds needn't match
 
110
        entry (0) ,             -- the "natural" entry for this (nuc-prot)
 
111
        bioseq (1) ,            -- only the bioseq identified
 
112
        bioseq-set (2) ,        -- any seg-set it may be part of
 
113
        nuc-prot (3) ,            -- any nuc-prot it may be part of
 
114
        pub-set (4) } DEFAULT entry ,
 
115
    mark-missing BOOLEAN OPTIONAL ,
 
116
    ids Entrez-ids }
 
117
 
 
118
Entrez-termget ::= SEQUENCE {        -- terms query
 
119
    max INTEGER OPTIONAL ,        -- maximum ids to return
 
120
    cls Entrez-class ,            -- class of data to query
 
121
    terms Entrez-term-list ,
 
122
    date-constraints Date-constraints OPTIONAL }
 
123
 
 
124
Date-constraints ::= SEQUENCE {
 
125
    count INTEGER ,
 
126
    date-vec SEQUENCE OF Date-vector
 
127
}
 
128
 
 
129
Date-vector ::= SEQUENCE {
 
130
    begin-date Date OPTIONAL ,
 
131
    end-date Date OPTIONAL ,
 
132
    field-abbr VisibleString 
 
133
}
 
134
 
 
135
Entrez-class ::= ENUMERATED {     -- class of document to query
 
136
    medline (0) ,
 
137
    aa (1) ,
 
138
    na (2) ,
 
139
    st (3) ,
 
140
    genome (4) }
 
141
 
 
142
Entrez-field ::= INTEGER {              -- type of field
 
143
    word (0) ,        -- words
 
144
    mesh (1) ,        -- meSH terms
 
145
    keyword (2) ,     -- keyword
 
146
    author (3) ,      -- author names
 
147
    journal (4) ,     -- journal title
 
148
    org (5) ,         -- organism name
 
149
    accn (6),         -- accession number
 
150
    gene (7) ,        -- gene symbol
 
151
    prot (8) ,        -- protein name
 
152
    ecno (9) ,        -- E.C. number
 
153
    hierarchy (10) ,  -- organism and MeSH hierarchies
 
154
    pubdate (11) ,    -- publication date
 
155
    fkey (12) ,       -- feature key
 
156
    prop (13) ,       -- properties
 
157
    subs (14) ,       -- substance
 
158
    mloc (15) }       -- map location
 
159
 
 
160
Entrez-operator ::= ENUMERATED {
 
161
    lparen (1) ,
 
162
    rparen (2) ,
 
163
    andsymbl (3) ,
 
164
    orsymbl (4) ,
 
165
    butnotsymbl (5) }
 
166
 
 
167
Special-operand ::= SEQUENCE {
 
168
    term     VisibleString ,
 
169
    fld      Entrez-field ,
 
170
    type     Entrez-class ,
 
171
    high-range VisibleString OPTIONAL }
 
172
 
 
173
Total-operand ::= SEQUENCE {
 
174
    term     VisibleString ,
 
175
    fld      Entrez-field ,
 
176
    type     Entrez-class ,
 
177
    high-range VisibleString OPTIONAL }
 
178
 
 
179
Entrez-term-list ::= SEQUENCE OF CHOICE {
 
180
    operator      Entrez-operator ,
 
181
    sp-operand    Special-operand ,
 
182
    tot-operand   Total-operand   }
 
183
 
 
184
Link-setget ::= SEQUENCE {
 
185
    max INTEGER OPTIONAL ,        -- maximum ids to return
 
186
    link-to-cls Entrez-class ,    -- class of data to return
 
187
    query-cls Entrez-class ,      -- class of query
 
188
    mark-missing BOOLEAN DEFAULT FALSE , -- need to know which IDs didn't match
 
189
    query-size INTEGER ,          -- size of query
 
190
    query SEQUENCE OF INTEGER }   -- ids of query
 
191
 
 
192
 
 
193
Entrez-neighbor-text ::= SEQUENCE {
 
194
    fld Entrez-field ,
 
195
    percent-terms-to-use INTEGER ,
 
196
    max-neighbors INTEGER ,
 
197
    min-score INTEGER ,
 
198
    normal-text VisibleString ,
 
199
    special-text VisibleString }
 
200
 
 
201
        --*********************************
 
202
        -- replies (back)
 
203
        --
 
204
 
 
205
Entrez-back ::= CHOICE {
 
206
    error INTEGER ,                -- Generic errors
 
207
    init SEQUENCE {                -- EntrezInit
 
208
        e-info Cdrom-inf OPTIONAL
 
209
    } ,
 
210
    maxlinks INTEGER ,             -- EntGetMaxLinks
 
211
    eval CHOICE {                  -- EntTLEval
 
212
      bad-count INTEGER ,             -- if too many UIDs to return set
 
213
      link-set Link-set } ,
 
214
    docsum CHOICE {                -- get summarys by term (DocSum)
 
215
      ml Ml-summary-list ,         -- medline summary list
 
216
      seq Seq-summary-list ,       -- sequence summary list
 
217
      str Seq-summary-list } ,     -- biostruc summary list
 
218
    linkuidlist Marked-link-set ,  -- LinkUidList
 
219
    uidlinks Marked-link-set ,     -- UidLinks
 
220
    byterm Entrez-term-resp ,      -- TermListByTerm
 
221
    bypage Entrez-term-resp ,      -- TermListByPage
 
222
    findterm Term-counts ,         -- EntrezFindTerm
 
223
    fini NULL ,                    -- EntrezFini
 
224
    createnamed NULL ,
 
225
    getmle Entrez-Medline-entry-list ,   -- get Medline Entry
 
226
    getseq Entrez-Seq-entry-list , -- get SeqEntry
 
227
    evalX OCTET STRING ,           -- EntTLEvalX
 
228
    createnamedX NULL ,
 
229
    seqidforgi Seq-id ,            -- EntrezSeqIdForGI
 
230
    findseqid INTEGER ,            -- EntrezFindSeqId
 
231
    canneighbortext BOOLEAN ,         -- EntrezCanNeighborText 
 
232
    expanded-medline BOOLEAN , 
 
233
    get-hierarchy Entrez-Tree,
 
234
    neighbortext Link-set ,
 
235
    eval-count INTEGER ,            -- EntTLEvalCount
 
236
    getbiostr Entrez-Biostruc-list ,-- EntrezBiostrucGet (obselete)
 
237
    getbiostrX Entrez-Biostruc-list ,-- EntrezBiostrucGet
 
238
    extrainfo Entrez-extra-info , 
 
239
    blast CHOICE {                  -- BLAST
 
240
      bad-count INTEGER ,             -- if too many UIDs to return set
 
241
      link-set Link-set ,
 
242
      job-start INTEGER ,
 
243
      job-progress INTEGER } ,
 
244
    docsumX New-summary-list ,
 
245
    getgenome Entrez-Seq-entry-list , -- get genome (UNUSED)
 
246
    cluster-arts Cluster-resp ,
 
247
    getbiostrannot Biostruc-annot-set ,
 
248
    getbiostr-feat-ids Link-set ,
 
249
    getbiostr-annot-by-fid Biostruc-annot-set }
 
250
 
 
251
Entrez-extra-info ::= SEQUENCE {
 
252
    maxlinks INTEGER ,
 
253
    canneighbortext BOOLEAN ,
 
254
    expanded-medline BOOLEAN ,
 
255
    canblast BOOLEAN }
 
256
 
 
257
New-summary-list ::= SEQUENCE {          
 
258
    num INTEGER ,
 
259
    type Entrez-class ,
 
260
    data SEQUENCE OF Docsum }
 
261
 
 
262
Ml-summary-list ::= SEQUENCE {
 
263
    num INTEGER ,
 
264
    data SEQUENCE OF Ml-summary }
 
265
 
 
266
Ml-summary ::= SEQUENCE {          
 
267
    muid INTEGER ,
 
268
    no-abstract BOOLEAN DEFAULT FALSE ,
 
269
    translated-title BOOLEAN DEFAULT FALSE ,
 
270
    no-authors BOOLEAN DEFAULT FALSE ,
 
271
    caption VisibleString OPTIONAL ,
 
272
    title VisibleString OPTIONAL }
 
273
 
 
274
Seq-summary-list ::= SEQUENCE {
 
275
    num INTEGER ,
 
276
    data SEQUENCE OF Seq-summary }
 
277
 
 
278
Seq-summary ::= SEQUENCE {
 
279
    id INTEGER ,          -- Gi id
 
280
    caption VisibleString OPTIONAL ,
 
281
    title VisibleString OPTIONAL }
 
282
 
 
283
Marked-link-set ::= SEQUENCE {
 
284
    link-set Link-set ,
 
285
    uids-processed INTEGER ,
 
286
    marked-missing Entrez-ids OPTIONAL }
 
287
 
 
288
Entrez-ids ::= SEQUENCE {
 
289
    numid INTEGER ,                   -- number of ids to follow
 
290
    ids SEQUENCE OF INTEGER }         -- the ids
 
291
 
 
292
Entrez-term-by-page ::= SEQUENCE {
 
293
    type     Entrez-class ,           -- type of query
 
294
    fld      Entrez-field ,           -- 
 
295
    page     INTEGER ,                -- starting page number
 
296
    num-pages INTEGER }               -- # of pages desired
 
297
 
 
298
Entrez-term-by-term ::= SEQUENCE {
 
299
    type     Entrez-class ,           -- type of query
 
300
    fld      Entrez-field ,           -- 
 
301
    term     VisibleString ,          -- term on which to key
 
302
    num-terms INTEGER }               -- # of terms desired
 
303
 
 
304
Term-lookup ::= SEQUENCE {
 
305
    type     Entrez-class ,           -- type of query
 
306
    fld      Entrez-field ,           -- 
 
307
    term     VisibleString }
 
308
 
 
309
Term-page-info ::= SEQUENCE {
 
310
    term       VisibleString ,
 
311
    spec-count INTEGER ,
 
312
    tot-count  INTEGER }
 
313
 
 
314
Term-counts ::= SEQUENCE {
 
315
    found BOOLEAN ,                   -- was the term found ?
 
316
    spec-count INTEGER ,
 
317
    tot-count  INTEGER }
 
318
 
 
319
Entrez-term-resp ::= SEQUENCE {
 
320
    num-terms INTEGER ,
 
321
    first-page INTEGER OPTIONAL,
 
322
    pages-read INTEGER ,
 
323
    info SEQUENCE OF Term-page-info }
 
324
 
 
325
Entrez-named-list ::= SEQUENCE {
 
326
    term       VisibleString ,
 
327
    type       Entrez-class ,           -- type of query
 
328
    fld        Entrez-field ,           -- 
 
329
    uids       Entrez-ids }
 
330
 
 
331
Entrez-named-listX ::= SEQUENCE {
 
332
    term       VisibleString ,
 
333
    type       Entrez-class ,           -- type of query
 
334
    fld        Entrez-field ,           -- 
 
335
    uids       OCTET STRING }
 
336
 
 
337
Entrez-Seq-entry-list ::= SEQUENCE {
 
338
    num INTEGER ,
 
339
    data SEQUENCE OF Seq-entry ,
 
340
    marked-missing Entrez-ids OPTIONAL }
 
341
 
 
342
Entrez-Medline-entry-list ::= SEQUENCE {
 
343
    num INTEGER ,
 
344
    data SEQUENCE OF Medline-entry ,
 
345
    marked-missing Entrez-ids OPTIONAL }
 
346
 
 
347
Entrez-Biostruc-list ::= SEQUENCE {
 
348
    num INTEGER ,
 
349
    data SEQUENCE OF Biostruc ,
 
350
    marked-missing Entrez-ids OPTIONAL }
 
351
 
 
352
 
 
353
Entrez-Tree-Child ::= SEQUENCE {
 
354
    name VisibleString ,
 
355
    is-leaf-node BOOLEAN ,
 
356
    special INTEGER ,
 
357
    total INTEGER
 
358
}
 
359
 
 
360
Entrez-Tree ::= SEQUENCE {
 
361
    num-in-lineage INTEGER ,
 
362
    num-children INTEGER ,
 
363
    term VisibleString ,
 
364
    lineage SEQUENCE OF VisibleString ,
 
365
    children SEQUENCE OF Entrez-Tree-Child ,
 
366
    canonical-form VisibleString OPTIONAL
 
367
}
 
368
 
 
369
END