The BoaC Programming Guide - Domain-Specific Types
Custom domain-specific types for BoaC are described in this section. Note that
when a type is shown for an attribute, the type might contain a question mark
("?"). This indicates that field may or may not be defined. When accessing
these fields, be sure to first check if the given attr exists for
a given object o: if (def(o.attr))
| Paper A research paper | ||
| Attribute | Type | Description |
|---|---|---|
| abstract | array of Paragraph | A list of paragraphs in the abstract |
| bib_entries | array of Reference | A list of paper refereneces in the paper |
| body_text | array of Section | A list of sections in the body text |
| id | string | The 40-character sha1 of the paper |
| metadata | Metadata? | The metatdata of the paper |
| ref_entries | array of Reference | A list of figure/table references in the paper |
| Metadata A metadata of a research paper | ||
| Attribute | Type | Description |
|---|---|---|
| authors | array of Author | A list of authors of the paper |
| doi_url | string? | The DOI (Digital Object Identifier) URL of the paper |
| journal | string? | The journal where the paper was published |
| license_type | string? | The license type of the paper |
| publish_time | int? | The time when the paper was published |
| pubmed_id | string? | The PubMed identifier of the paper |
| source | string? | The source of the paper |
| title | string? | The title of the paper |
| Author An author of a research paper | ||
| Attribute | Type | Description |
|---|---|---|
| affiliation | Affiliation? | The affiliation of the author |
| string? | The email of the author | |
| first | string? | The first name of the author |
| last | string? | The last name of the author |
| middle | array of string | The middle name of the author |
| suffix | string? | The suffix of the author |
| Affiliation A Affiliation of an author | ||
| Attribute | Type | Description |
|---|---|---|
| institution | string? | Institution name |
| laboratory | string? | Laboratory name |
| location | Location? | Location information |
| Section A section inside a body text | ||
| Attribute | Type | Description |
|---|---|---|
| body | array of Paragraph | A list of paragraphs in the section |
| title | string? | The title of the section |
| Paragraph A paragraph inside a research paper | ||
| Attribute | Type | Description |
|---|---|---|
| cite_spans | array of Citation | A list of paper citations in the paragraph |
| ref_spans | array of Citation | A list of figure/table citations in the paragraph |
| text | string? | The text of the paragraph |
| Citation A citation inside a paragraph | ||
| Attribute | Type | Description |
|---|---|---|
| ref_id | string? | The id of the reference the citation, e.g. linked to Reference BIBREF0 |
| text | string? | The character repesentation of the citation, e.g. citation "[7]" |
| Location A location of an affiliation | ||
| Attribute | Type | Description |
|---|---|---|
| addrLine | string? | The address of the location |
| country | string? | The country of the location |
| postCode | string? | The postcode of the location |
| region | string? | The region of the location |
| settlement | string? | The settlement of the location |
| Reference A reference of a reaserch paper | ||
| Attribute | Type | Description |
|---|---|---|
| authors | array of Author | A list of authors of the refered paper |
| issn | string? | The ISSN (International Standard Serial Number) of the refered paper |
| pages | string? | The pages of the refered paper |
| ref_id | string | The id of the reference for all kinds |
| text | string? | The caption text of the figure/table |
| title | string? | The title of the refered paper |
| kind | ReferenceKind? | The kind of the reference |
| venue | string? | The venue of the refered paper |
| volume | string? | The volume of the refered paper |
| year | string? | The publish year of the referd paper |
| enum ReferenceKind Describes the kind of Reference | |
| Attribute | Description |
|---|---|
| BIB | For paper reference |
| FIGURE | For figure reference |
| TABLE | For table reference |
