Class: PageRef

A reference to a specific part of a document as indicated by a list of one or more page numbers, a range of page numbers, or a list of named destinations in the document (e.g. bookmarks).

  • NOTE: this is an abstract class and should not be instantiated directly

URI: ars:PageRef

 classDiagram
    class PageRef
      PageRef <|-- PageNumberListRef
      PageRef <|-- PageNumberRangeRef
      PageRef <|-- PageNameRef
      PageRef : refType        
        PageRef --|> PageRefTypeEnum : refType
        PageRef : label        
        PageRef : pageNames        
        PageRef : pageNumbers        
        PageRef : firstPage        
        PageRef : lastPage

Inheritance

Slots

Name Cardinality* and Range Description Inheritance
refType 1..1
PageRefTypeEnum		 The type of reference for page references direct
label 0..1
String		 Alternative label to provide a more specific and description to a page link direct
pageNames 0..*
String		 One or more named document references which each correspond with a page direct
pageNumbers 0..*
Integer		 One or more page numbers direct
firstPage 0..1
Integer		 The page number of the first page in a range of pages direct
lastPage 0..1
Integer		 The page number of the last page in a range of pages direct

* See LinkML documentation for cardinality definitions.

Usages

used by used in type used
DocumentReference pageRefs range PageRef

Comments

  • Each instance of this class should contain only one of the following page specifications:
    • pageNumbers
    • pageNames
    • firstPage AND lastPage

Identifier and Mapping Information

Schema Source

  • from schema: https://www.cdisc.org/ars/1-0

Mappings

Mapping Type Mapped Value
self ars:PageRef
native ars:PageRef

LinkML Source

Direct

name: PageRef
description: A reference to a specific part of a document as indicated by a list of
  one or more page numbers, a range of page numbers, or a list of named destinations
  in the document (e.g. bookmarks).
comments:
- "Each instance of this class should contain only one of the following page specifications:\n\
  \    * pageNumbers\n    * pageNames\n    * firstPage AND lastPage\n"
from_schema: https://www.cdisc.org/ars/1-0
rank: 1000
abstract: true
slots:
- refType
- label
- pageNames
- pageNumbers
- firstPage
- lastPage
slot_usage:
  label:
    name: label
    description: Alternative label to provide a more specific and description to a
      page link.
    domain_of:
    - NamedObject
    - AnalysisOutputCategorization
    - AnalysisOutputCategory
    - PageRef

Induced

name: PageRef
description: A reference to a specific part of a document as indicated by a list of
  one or more page numbers, a range of page numbers, or a list of named destinations
  in the document (e.g. bookmarks).
comments:
- "Each instance of this class should contain only one of the following page specifications:\n\
  \    * pageNumbers\n    * pageNames\n    * firstPage AND lastPage\n"
from_schema: https://www.cdisc.org/ars/1-0
rank: 1000
abstract: true
slot_usage:
  label:
    name: label
    description: Alternative label to provide a more specific and description to a
      page link.
    domain_of:
    - NamedObject
    - AnalysisOutputCategorization
    - AnalysisOutputCategory
    - PageRef
attributes:
  refType:
    name: refType
    description: The type of reference for page references.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: refType
    owner: PageRef
    domain_of:
    - PageRef
    range: PageRefTypeEnum
    required: true
  label:
    name: label
    description: Alternative label to provide a more specific and description to a
      page link.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: label
    owner: PageRef
    domain_of:
    - NamedObject
    - AnalysisOutputCategorization
    - AnalysisOutputCategory
    - PageRef
    range: string
  pageNames:
    name: pageNames
    description: One or more named document references which each correspond with
      a page.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    multivalued: true
    alias: pageNames
    owner: PageRef
    domain_of:
    - PageRef
    range: string
  pageNumbers:
    name: pageNumbers
    description: One or more page numbers.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    multivalued: true
    alias: pageNumbers
    owner: PageRef
    domain_of:
    - PageRef
    range: integer
  firstPage:
    name: firstPage
    description: The page number of the first page in a range of pages.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: firstPage
    owner: PageRef
    domain_of:
    - PageRef
    range: integer
  lastPage:
    name: lastPage
    description: The page number of the last page in a range of pages.
    from_schema: https://www.cdisc.org/ars/1-0
    rank: 1000
    alias: lastPage
    owner: PageRef
    domain_of:
    - PageRef
    range: integer