ssnolib.ssno.standard_name_table.StandardNameTable

class ssnolib.ssno.standard_name_table.StandardNameTable(*, id: ~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_id, json_schema_input_type=PydanticUndefined)] | None = <factory>, label: ~ontolutils.classes.thing.LangString | ~typing.List[~ontolutils.classes.thing.LangString] | None = None, altLabel: ~ontolutils.classes.thing.LangString | ~typing.List[~ontolutils.classes.thing.LangString] | None = None, broader: ~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)] | ~typing.List[~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)]] | None = None, comment: ~ontolutils.classes.thing.LangString | ~typing.List[~ontolutils.classes.thing.LangString] | None = None, about: str | ~pydantic.networks.HttpUrl | ~pydantic.networks.FileUrl | ~ontolutils.classes.thingmodel.ThingModel | ~typing.Annotated[str, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.__validate_blank_node, json_schema_input_type=PydanticUndefined)] | ~typing.List[~pydantic.networks.HttpUrl | ~pydantic.networks.FileUrl | ~ontolutils.classes.thingmodel.ThingModel | ~typing.Annotated[str, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.__validate_blank_node, json_schema_input_type=PydanticUndefined)]] | None = None, relation: ~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)] | ~typing.List[~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)]] | None = None, closeMatch: ~pydantic.networks.HttpUrl | ~pydantic.networks.FileUrl | ~typing.Annotated[str, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.__validate_blank_node, json_schema_input_type=PydanticUndefined)] | ~ontolutils.classes.thingmodel.ThingModel | None = None, exactMatch: ~pydantic.networks.HttpUrl | ~pydantic.networks.FileUrl | ~typing.Annotated[str, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.__validate_blank_node, json_schema_input_type=PydanticUndefined)] | ~ontolutils.classes.thingmodel.ThingModel | None = None, description: ~ontolutils.classes.thing.LangString | ~typing.List[~ontolutils.classes.thing.LangString] | None = None, isDefinedBy: ~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)] | ~typing.List[~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)]] | None = None, has_top_concept: ~ontolutils.ex.skos.concept.Concept | ~typing.List[~ontolutils.ex.skos.concept.Concept] | None = None, title: ~ontolutils.classes.thing.LangString | ~typing.List[~ontolutils.classes.thing.LangString] | None = None, version: str | None = None, has_version: ~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)] | ~typing.List[~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)]] | None = None, identifier: str | None = None, created: ~datetime.datetime | None = None, modified: ~datetime.datetime | None = None, qualified_attribution: ~ontolutils.ex.prov.attribution.Attribution | ~typing.List[~ontolutils.ex.prov.attribution.Attribution] | None = None, standard_names: ~typing.List[~ssnolib.ssno.standard_name.StandardName | ~ssnolib.ssno.standard_name.VectorStandardName | ~ssnolib.ssno.standard_name.ScalarStandardName] | None = <factory>, has_modifier: ~typing.List[~ssnolib.ssno.standard_name_table.Qualification | ~ssnolib.ssno.standard_name_table.VectorQualification | ~ssnolib.ssno.standard_name_table.Transformation] | None = None, has_domain_concept_set: ~typing.List[~ssnolib.ssno.standard_name_table.DomainConceptSet] = None, subject: str | ~pydantic.networks.HttpUrl | None = None, keywords: ~ontolutils.classes.thing.LangString | ~typing.List[~ontolutils.classes.thing.LangString] | None = None, dataset: ~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)] | ~ontolutils.ex.dcat.resource.Dataset | None = None, standard_name_table_used_by: ~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)] | ~typing.List[~typing.Annotated[object, ~pydantic.functional_validators.WrapValidator(func=~ontolutils.typing.validate_resource_type, json_schema_input_type=PydanticUndefined)]] | None = None, **extra_data: ~typing.Any)

Implementation of ssno:StandardNameTable

Parameters

title: str

Title of the Standard Name Table (dcterms:title)

version: str

Version (as string) of the Standard Name Table (schema:version)

hasVersion: str

Version (as resource) of the Standard Name Table (dcterms:hasVersion)

created: datetime

Creation date of the Standard Name Table (dcterms:created)

modified: datetime

Last modification date of the Standard Name Table (dcterms:modified)

description: str

Description of the Standard Name Table (dcterms:description)

qualifiedAttribution: Optional[Union[Attribution, List[Attribution]]]

An Attribution holds a prov:Person (and its role) or a prov:Organization

standardNames: List[StandardName]

List of Standard Names (ssno:standardNames)

hasModifier: Optional[List[Union[Qualification, Transformation]]]

List of Qualifications and Transformations

subject: Optional[str, HttpUrl] relation: Relation to another Resource

__init__(**data: Any) → None

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
add_author(author[, role])
add_new_standard_name(name[, verify])	Add a new standard name to the Standard Name Table.
append(field_name, field)
build(namespace, namespace_prefix, ...)	Build a Thing object
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])
download(url, fmt, **kwargs)	Download a Standard Name Table from a URL.
fetch()	Download the Standard Name Table and parse it
from_file([source, format, limit, context])	Initialize the class from a file
from_jsonld([source, data, limit, context])	Initialize the class from a JSON-LD source
from_orm(obj)
from_ttl([source, data, limit, context])	Initialize the class from a Turtle source
get_context()	Return the context of the class
get_jsonld_dict([base_uri, context, ...])	Return the JSON-LD dictionary of the object.
get_qualification_regex()
get_qualification_rule_as_string()	Returns the qualification rule similar to the CF standard name table documentation (https://cfconventions.org/Data/cf-standard-names/docs/guidelines.html#process).
get_standard_name(standard_name)
get_standard_name_dict()
get_standard_names_as_frozen_dataclass()	Returns a frozen dataclass with the standard names as attributes.
iri([key, compact])	Return the IRI of the class or the key
json(*[, include, exclude, by_alias, ...])
map(other)	Return the class as another class.
model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])	Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#model_copy
model_dump(*[, mode, include, exclude, ...])	Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump
model_dump_json(*[, indent, include, ...])	Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump_json
model_dump_jsonld([context, exclude_none, ...])	Dump the Standard Name Table to a JSON-LD string and enforce the use of base URI.
model_dump_ttl([context, exclude_none, ...])	Dump the Standard Name Table to a Turtle string and enforce the use of base URI.
model_json_schema([by_alias, ref_template, ...])	Generates a JSON schema for a model class.
model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
model_post_init(_BaseModel__context)	Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, ...])	Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])	Usage docs: https://docs.pydantic.dev/2.10/concepts/json/#json-parsing
model_validate_strings(obj, *[, strict, context])	Validate the given object with string data against the Pydantic model.
parse(source[, fmt, qudt_lookup])	Call the reader plugin for the given format.
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
serialize(format[, context, exclude_none, ...])	Serialize the Standard Name Table to a string in the given format.
to_html(*[, folder, filename])	Generates an HTML page for the standard name table.
to_jsonld(filename, base_uri[, overwrite, ...])	Dump the Standard Name Table to a JSON-LD file.
to_markdown([filename])	Export the Standard Name Table to a markdown file.
to_ttl(filename, base_uri[, overwrite, context])
to_xml(filename, base_uri[, overwrite, context])
to_yaml(filename[, overwrite, exists_ok])	Dump the Standard Name Table to a file.
update_forward_refs(**localns)
validate(value)
verify(standard_name)	Verifies a string standard name.
verify_name(standard_name)	Verifies a string standard name.

Attributes

model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
namespace
namespaces	Return the namespaces of the class
uri
urirefs	Return the urirefs of the class
title
version
hasVersion
description
identifier
created
modified
qualifiedAttribution
standardNames
hasModifier
hasDomainConceptSet
subject
keywords
relation
dataset
standardNameTableUsedBy
hasTopConcept
id
label
altLabel
broader
comment
about
closeMatch
exactMatch
isDefinedBy