Skip to content

Class: SearchResults

URI: https://w3id.org/monarch/monarch-py/:SearchResults

 classDiagram
    class SearchResults
      Results <|-- SearchResults

      SearchResults : facet_fields

          SearchResults --|> FacetField : facet_fields

      SearchResults : facet_queries

          SearchResults --|> FacetValue : facet_queries

      SearchResults : items

          SearchResults --|> SearchResult : items

      SearchResults : limit

      SearchResults : offset

      SearchResults : total

Inheritance

Slots

Name Cardinality and Range Description Inheritance
items 1..*
SearchResult
A collection of items, with the type to be overriden by slot_usage direct
facet_fields 0..*
FacetField
Collection of facet field responses with the field values and counts direct
facet_queries 0..*
FacetValue
Collection of facet query responses with the query string values and counts direct
limit 1..1
Integer
number of items to return in a response Results
offset 1..1
Integer
offset into the total number of items Results
total 1..1
Integer
total number of items matching a query Results

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self https://w3id.org/monarch/monarch-py/:SearchResults
native https://w3id.org/monarch/monarch-py/:SearchResults

LinkML Source

Direct

name: SearchResults
from_schema: https://w3id.org/monarch/monarch-py
is_a: Results
slots:
- items
- facet_fields
- facet_queries
slot_usage:
  items:
    name: items
    domain_of:
    - AssociationCountList
    - AssociationResults
    - AssociationTableResults
    - EntityResults
    - HistoPheno
    - SearchResults
    range: SearchResult

Induced

name: SearchResults
from_schema: https://w3id.org/monarch/monarch-py
is_a: Results
slot_usage:
  items:
    name: items
    domain_of:
    - AssociationCountList
    - AssociationResults
    - AssociationTableResults
    - EntityResults
    - HistoPheno
    - SearchResults
    range: SearchResult
attributes:
  items:
    name: items
    description: A collection of items, with the type to be overriden by slot_usage
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    multivalued: true
    alias: items
    owner: SearchResults
    domain_of:
    - AssociationCountList
    - AssociationResults
    - AssociationTableResults
    - EntityResults
    - HistoPheno
    - SearchResults
    range: SearchResult
    required: true
    inlined: true
    inlined_as_list: true
  facet_fields:
    name: facet_fields
    description: Collection of facet field responses with the field values and counts
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    multivalued: true
    alias: facet_fields
    owner: SearchResults
    domain_of:
    - SearchResults
    range: FacetField
    inlined: true
    inlined_as_list: true
  facet_queries:
    name: facet_queries
    description: Collection of facet query responses with the query string values
      and counts
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    multivalued: true
    alias: facet_queries
    owner: SearchResults
    domain_of:
    - SearchResults
    range: FacetValue
    inlined: true
    inlined_as_list: true
  limit:
    name: limit
    description: number of items to return in a response
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    alias: limit
    owner: SearchResults
    domain_of:
    - Results
    range: integer
    required: true
  offset:
    name: offset
    description: offset into the total number of items
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    alias: offset
    owner: SearchResults
    domain_of:
    - Results
    range: integer
    required: true
  total:
    name: total
    description: total number of items matching a query
    from_schema: https://w3id.org/monarch/monarch-py
    rank: 1000
    alias: total
    owner: SearchResults
    domain_of:
    - Results
    range: integer
    required: true