NCBI C Toolkit Cross Reference

C/cdromlib/cdrom.asn


  1 --$Revision: 6.0 $
  2 --********************************************************************
  3 --
  4 --  CdRom Specific data structures
  5 --  James Ostell, 1991
  6 --
  7 --  Revised:  06-03-94  Schuler
  8 --  Revised:  07-14-94  Schuler
  9 --
 10 --********************************************************************
 11 
 12 NCBI-CdRom DEFINITIONS ::=
 13 BEGIN
 14 
 15 EXPORTS Cdrom-inf, Docsum;
 16 
 17 Cdrom-inf ::= SEQUENCE    -- MODIFIED
 18 {
 19         volume-label VisibleString,                      -- title of this resource: "Entrez"
 20         version INTEGER,                                 -- major release number
 21         issue INTEGER,                                   -- minor release number
 22         format INTEGER,                                  -- version of cdrom format used
 23         descr VisibleString,                             -- a brief summary of contents
 24         no-compression BOOLEAN OPTIONAL,                 -- (DEFUNCT)
 25         huff-count INTEGER OPTIONAL,                     -- (DEFUNCT)
 26         huff-left SEQUENCE OF INTEGER OPTIONAL,          -- (DEFUNCT)
 27         huff-right SEQUENCE OF INTEGER OPTIONAL,         -- (DEFUNCT)
 28         type-count INTEGER,                              -- number of document types
 29         type-names SEQUENCE OF VisibleString OPTIONAL,   -- names of document types
 30         type-bucket-size INTEGER OPTIONAL,               -- size of buckets for uid index
 31         field-count INTEGER,                             -- number of field types
 32         field-names SEQUENCE OF VisibleString OPTIONAL,  -- names of field types
 33         field-bucket-size INTEGER OPTIONAL,              -- size of buckets for term index
 34         types SEQUENCE OF Typedata OPTIONAL,             -- doc-type information
 35         -- - - - - - - - new stuff below this line (all optional) - - - - - --
 36         release-date Cd-date OPTIONAL,                    -- release date
 37         close-date Cd-date OPTIONAL,                      -- close-of-data date
 38         type-info SEQUENCE OF Type-info OPTIONAL,        -- more doc-type information
 39         field-info SEQUENCE OF Field-info OPTIONAL,      -- field information
 40         div-count INTEGER OPTIONAL,                      -- number of divisions
 41         div-info SEQUENCE OF Div-info OPTIONAL,           -- division information
 42         link-count INTEGER OPTIONAL,
 43         link-info SEQUENCE OF Link-info OPTIONAL        -- link information
 44 }
 45 
 46 Typedata ::= SEQUENCE 
 47 {
 48         num INTEGER,                       -- number of documents
 49         num-uids INTEGER,                  -- number of uids
 50         minuid INTEGER,                    -- minimum uid used
 51         maxuid INTEGER,                    -- maximum uid used
 52         num-bucket INTEGER,                -- number of index buckets
 53         fields SEQUENCE OF Fielddata       -- info by field within type
 54 }
 55 
 56 Fielddata ::= SEQUENCE
 57 {
 58         num-terms INTEGER,                 -- number of terms in this field
 59         num-bucket INTEGER                 -- number of buckets for this field
 60 }
 61 
 62 Post-type ::= ENUMERATED    -- NEW TYPE
 63 {
 64         sort (0),                          -- UIDs are sorted
 65         unsort (1),                        -- UIDs are not sorted
 66         hier (2) ,                         -- UIDs in hierarchical structure
 67         text (3) ,                         -- "postings" file contains ASCII text
 68         other (255)                        -- none of the above
 69 }
 70 
 71 Type-info ::= SEQUENCE   -- NEW TYPE
 72 {
 73         id INTEGER,                        -- id number to pass to APIs
 74         tag VisibleString,                 -- 2-letter tag (for CdEntrez internal use)
 75         name VisibleString,                -- short string to go on menu
 76         descr VisibleString OPTIONAL,      -- longer, descriptive string
 77         asntype VisibleString              -- ASN.1 type (e.g. "Medline-entry")
 78 }
 79 
 80 Field-info ::= SEQUENCE   -- NEW TYPE
 81 {
 82         id INTEGER,                        -- id number to pass to APIs
 83         tag VisibleString,                 -- 4-letter tag (for CdEntrez internal use)
 84         name VisibleString,                -- short string to go on menu
 85         descr VisibleString OPTIONAL,      -- longer, descriptive string
 86         single-token BOOLEAN DEFAULT FALSE, -- TRUE if terms are always a single token
 87         has-special BOOLEAN DEFAULT FALSE, -- TRUE if terms may have special postings
 88         hier-avail BOOLEAN DEFAULT FALSE,  -- TRUE if there is a hierarchical counterpart
 89         hier-id INTEGER OPTIONAL,          -- if hier-avail==TRUE, field id of hierarchy
 90         post-type Post-type DEFAULT sort   -- postings type
 91 }
 92 
 93 Link-info ::= SEQUENCE   -- NEW TYPE
 94 {
 95         id INTEGER,                        -- id number
 96         tag VisibleString,                 -- string identifier
 97         name VisibleString,                -- short string to go on menu
 98         descr VisibleString OPTIONAL,      -- longer, descriptive string
 99         dbfrom INTEGER,                    -- database link points from
100         dbto INTEGER,                      -- database link points to
101         datasize INTEGER,                  -- size of link-associated data
102         reciprocal INTEGER                 -- id of reciprocal link
103 }
104                                       
105 Div-info ::= SEQUENCE   -- NEW TYPE
106 {
107         tag VisibleString,                 -- 3-letter tag (for CdEntrez internal use)
108         descr VisibleString,               -- Description
109         reldate VisibleString OPTIONAL,    -- Release number and/or date string
110         date Cd-date OPTIONAL,             -- Structured release date     
111         docs SEQUENCE OF INTEGER OPTIONAL  -- Document counts for each type
112 }
113    
114 Cd-date ::= SEQUENCE    -- NEW TYPE  (Entrez date)
115 {
116         year INTEGER,                      -- includes century, e.g. 1994
117         month INTEGER DEFAULT 0,           -- 1..12, 0 if unknown
118         day INTEGER DEFAULT 0              -- 1..31, 0 if unknown
119 }
120 
121 Docsum-set ::= SEQUENCE OF Docsum
122 
123 Docsum ::= SEQUENCE  -- MODIFIED
124 {
125         no-abstract BOOLEAN DEFAULT FALSE,               -- record has no abstract (ml)
126         translated-title BOOLEAN DEFAULT FALSE,          -- translated title (ml)
127         no-authors BOOLEAN DEFAULT FALSE,                -- no authors (ml)
128         caption VisibleString OPTIONAL,                  -- short name
129         title VisibleString OPTIONAL,                    -- full title
130         -- - - - - - new stuff below this line (all optional) - - - - - --
131         extra VisibleString OPTIONAL ,                   -- citation (ml) / seq-id (aa,nt)
132         non-document BOOLEAN DEFAULT FALSE,              -- not an Entrez doc (aa,nt: seg part)
133         is-segmented BOOLEAN DEFAULT FALSE,              -- seg seq (aa,nt) / multi-chain (st)
134         is-partial BOOLEAN DEFAULT FALSE,                -- partial sequence (aa,nt)
135         create Cd-date OPTIONAL,                         -- create date
136         modify Cd-date OPTIONAL,                         -- modify date
137         link-count SEQUENCE OF INTEGER OPTIONAL,         -- link counts to each type
138         uid INTEGER OPTIONAL,                            -- UID of this document
139         secondaryUid INTEGER OPTIONAL,                    -- Secondary UID of this document
140         not-yet-neighbored BOOLEAN DEFAULT FALSE         -- this entry not yet neighbored
141 }
142 
143 END
144 

source navigation ]   [ diff markup ]   [ identifier search ]   [ freetext search ]   [ file search ]  

This page was automatically generated by the LXR engine.
Visit the LXR main site for more information.