Skip to content

omnipy.components.isa.models.ontology_source_reference_schema

ISA model representing an ontology source reference.

ISA means Investigation/Study/Assay, and these generated models represent ISA-JSON JSON-LD source metadata.

Returned by:
CLASS DESCRIPTION
FieldType

JSON-LD type labels used for ISA ontology-source entities.
IsaOntologySourceReferenceModel

Omnipy model wrapper for ISA ontology-source metadata.
IsaOntologySourceReferenceSchema

Schema for ontology source references in ISA metadata.

FieldType

Bases: Enum


              flowchart BT
              omnipy.components.isa.models.ontology_source_reference_schema.FieldType[FieldType]

              

              click omnipy.components.isa.models.ontology_source_reference_schema.FieldType href "" "omnipy.components.isa.models.ontology_source_reference_schema.FieldType"

JSON-LD type labels used for ISA ontology-source entities.

ATTRIBUTE DESCRIPTION
OntologySourceReference

Marks a JSON object as an ontology source.
Returned by:
Source code in src/omnipy/components/isa/models/ontology_source_reference_schema.py 
19
20
21
22
23
24
25
26
class FieldType(Enum):
    """JSON-LD type labels used for ISA ontology-source entities.

    Attributes:
        OntologySourceReference: Marks a JSON object as an ontology source.
    """

    OntologySourceReference = 'OntologySourceReference'

OntologySourceReference class-attribute instance-attribute 

OntologySourceReference = 'OntologySourceReference'

IsaOntologySourceReferenceModel

Bases: Model[IsaOntologySourceReferenceSchema]


              flowchart BT
              omnipy.components.isa.models.ontology_source_reference_schema.IsaOntologySourceReferenceModel[IsaOntologySourceReferenceModel]
              omnipy.data.model.Model[Model]
              omnipy.data._mixins.display.ModelDisplayMixin[ModelDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.model.Model --> omnipy.components.isa.models.ontology_source_reference_schema.IsaOntologySourceReferenceModel
                                omnipy.data._mixins.display.ModelDisplayMixin --> omnipy.data.model.Model
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.ModelDisplayMixin
                

                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.model.Model
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.model.Model
                



              click omnipy.components.isa.models.ontology_source_reference_schema.IsaOntologySourceReferenceModel href "" "omnipy.components.isa.models.ontology_source_reference_schema.IsaOntologySourceReferenceModel"
              click omnipy.data.model.Model href "" "omnipy.data.model.Model"
              click omnipy.data._mixins.display.ModelDisplayMixin href "" "omnipy.data._mixins.display.ModelDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"

Omnipy model wrapper for ISA ontology-source metadata.

Provides Omnipy Model behavior for values validated by :class:IsaOntologySourceReferenceSchema.

Returned by:
Source code in src/omnipy/components/isa/models/ontology_source_reference_schema.py 
59
60
61
62
63
64
65
66
class IsaOntologySourceReferenceModel(Model[IsaOntologySourceReferenceSchema]):
    """Omnipy model wrapper for ISA ontology-source metadata.

    Provides Omnipy ``Model`` behavior for values validated by
    :class:`IsaOntologySourceReferenceSchema`.
    """

    ...

IsaOntologySourceReferenceSchema

Bases: pyd.BaseModel


              flowchart BT
              omnipy.components.isa.models.ontology_source_reference_schema.IsaOntologySourceReferenceSchema[IsaOntologySourceReferenceSchema]

                              omnipy.util.pydantic.BaseModel --> omnipy.components.isa.models.ontology_source_reference_schema.IsaOntologySourceReferenceSchema
                


              click omnipy.components.isa.models.ontology_source_reference_schema.IsaOntologySourceReferenceSchema href "" "omnipy.components.isa.models.ontology_source_reference_schema.IsaOntologySourceReferenceSchema"

Schema for ontology source references in ISA metadata.

ATTRIBUTE DESCRIPTION
name

Short source name used by ontology term references.

TYPE: str | None

version

Version string for the ontology source.

TYPE: str | None

file

Optional URI or file reference for the ontology.

TYPE: str | None

description

Human-readable source description.

TYPE: str | None

Subclassed by:
CLASS DESCRIPTION
Config

Validation settings for ISA ontology-source schema parsing.
Source code in src/omnipy/components/isa/models/ontology_source_reference_schema.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class IsaOntologySourceReferenceSchema(pyd.BaseModel):
    """Schema for ontology source references in ISA metadata.

    Attributes:
        name: Short source name used by ontology term references.
        version: Version string for the ontology source.
        file: Optional URI or file reference for the ontology.
        description: Human-readable source description.
    """
    class Config:
        """Validation settings for ISA ontology-source schema parsing.

        Attributes:
            extra: Rejects undeclared keys in input payloads.
            use_enum_values: Serializes enum values as strings.
        """

        extra = pyd.Extra.forbid
        use_enum_values = True

    field_id: Optional[str] = pyd.Field(None, alias='@id')
    field_context: Optional[str] = pyd.Field(None, alias='@context')
    field_type: Optional[FieldType] = pyd.Field(None, alias='@type')
    comments: Optional[List[comment_schema.IsaCommentModel]] = None
    description: Optional[str] = None
    file: Optional[str] = None
    name: Optional[str] = None
    version: Optional[str] = None

comments class-attribute instance-attribute 

comments: list[comment_schema.IsaCommentModel] | None = None

description class-attribute instance-attribute 

description: str | None = None

field_context class-attribute instance-attribute 

field_context: str | None = pyd.Field(None, alias='@context')

field_id class-attribute instance-attribute 

field_id: str | None = pyd.Field(None, alias='@id')

field_type class-attribute instance-attribute 

field_type: FieldType | None = pyd.Field(None, alias='@type')

file class-attribute instance-attribute 

file: str | None = None

name class-attribute instance-attribute 

name: str | None = None

version class-attribute instance-attribute 

version: str | None = None

Config

Validation settings for ISA ontology-source schema parsing.

ATTRIBUTE DESCRIPTION
extra

Rejects undeclared keys in input payloads.
use_enum_values

Serializes enum values as strings.
Source code in src/omnipy/components/isa/models/ontology_source_reference_schema.py 
38
39
40
41
42
43
44
45
46
47
class Config:
    """Validation settings for ISA ontology-source schema parsing.

    Attributes:
        extra: Rejects undeclared keys in input payloads.
        use_enum_values: Serializes enum values as strings.
    """

    extra = pyd.Extra.forbid
    use_enum_values = True

extra class-attribute instance-attribute 

extra = pyd.Extra.forbid

use_enum_values class-attribute instance-attribute 

use_enum_values = True