LinkResource

Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py

@dataclass
class LinkResource:
    res_id: str
    label: str
    link_to: list[str]
    comments: list[str] = field(default_factory=list)
    permissions: Permissions = Permissions.PROJECT_SPECIFIC_PERMISSIONS
    migration_metadata: MigrationMetadata | None = None

    @staticmethod
    def create_new(
        res_id: str,
        label: str,
        link_to: Collection[str],
        permissions: Permissions = Permissions.PROJECT_SPECIFIC_PERMISSIONS,
    ) -> LinkResource:
        """
        Creates a new link resource.
        A link resource is like a container that groups together several other resources of different classes.

        [See XML documentation for details](https://docs.dasch.swiss/latest/DSP-TOOLS/file-formats/xml-data-file/#link)

        Args:
            res_id: ID of this link resource
            label: label of this link resource
            link_to: IDs of the resources that should be linked together (cardinality 1-n)
            permissions: permissions of this link resource

        Returns:
            A link resource

        Examples:
            ```python
            link_resource = xmllib.LinkResource.create_new(
                res_id="ID",
                label="label",
                link_to=["target_resource_id_1", "target_resource_id_2"],
            )
            ```
        """
        return LinkResource(
            res_id=res_id,
            label=label,
            link_to=list(link_to),
            permissions=permissions,
        )

    def add_comment(self, comment: str) -> LinkResource:
        """
        Add a comment to the resource

        Args:
            comment: text

        Returns:
            The original resource, with the added comment

        Examples:
            ```python
            link_resource = link_resource.add_comment("comment text")
            ```
        """
        self.comments.append(comment)
        return self

    def add_comment_multiple(self, comments: Collection[str]) -> LinkResource:
        """
        Add several comments to the resource

        Args:
            comments: list of texts

        Returns:
            The original resource, with the added comments

        Examples:
            ```python
            link_resource = link_resource.add_comment_multiple(["comment 1", "comment 2"])
            ```
        """
        self.comments.extend(comments)
        return self

    def add_comment_optional(self, comment: Any) -> LinkResource:
        """
        If the value is not empty, add it as comment, otherwise return the resource unchanged.

        Args:
            comment: text or empty value

        Returns:
            The original resource, with the added comment

        Examples:
            ```python
            link_resource = link_resource.add_comment_optional("comment text")
            ```

            ```python
            link_resource = link_resource.add_comment_optional(None)
            ```
        """
        if is_nonempty_value(comment):
            self.comments.append(comment)
        return self

    def add_migration_metadata(
        self, creation_date: str | None, iri: str | None = None, ark: str | None = None
    ) -> LinkResource:
        """
        Add metadata from a SALSAH migration.

        Args:
            creation_date: creation date of the resource in SALSAH
            iri: Original IRI in SALSAH
            ark: Original ARK in SALSAH

        Raises:
            InputError: if metadata already exists

        Returns:
            The original resource, with the added metadata

        Examples:
            ```python
            link_resource = link_resource.add_migration_metadata(
                iri="http://rdfh.ch/4123/DiAmYQzQSzC7cdTo6OJMYA",
                creation_date="1999-12-31T23:59:59.9999999+01:00"
            )
            ```
        """
        if self.migration_metadata:
            raise InputError(
                f"The resource with the ID '{self.res_id}' already contains migration metadata, "
                f"no new data can be added."
            )
        self.migration_metadata = MigrationMetadata(creation_date=creation_date, iri=iri, ark=ark, res_id=self.res_id)
        return self

    def serialise(self) -> etree._Element:
        self._check_for_and_convert_unexpected_input()
        res_ele = self._serialise_resource_element()
        if self.comments:
            res_ele.append(_serialise_has_comment(self.comments, self.res_id))
        else:
            msg = (
                f"The link object with the ID '{self.res_id}' does not have any comments. "
                f"At least one comment must be provided, please note that an xmlupload will fail."
            )
            warnings.warn(DspToolsUserWarning(msg))
        res_ele.append(self._serialise_links())
        return res_ele

    def _check_for_and_convert_unexpected_input(self) -> None:
        _check_strings(string_to_check=self.res_id, res_id=self.res_id, field_name="Resource ID")
        _check_strings(string_to_check=self.label, res_id=self.res_id, field_name="Label")
        self.comments = _transform_unexpected_input(self.comments, "comments", self.res_id)
        self.link_to = _transform_unexpected_input(self.link_to, "link_to", self.res_id)

    def _serialise_resource_element(self) -> etree._Element:
        attribs = {"label": self.label, "id": self.res_id}
        if self.permissions != Permissions.PROJECT_SPECIFIC_PERMISSIONS:
            attribs["permissions"] = self.permissions.value
        return etree.Element(f"{DASCH_SCHEMA}link", attrib=attribs, nsmap=XML_NAMESPACE_MAP)

    def _serialise_links(self) -> etree._Element:
        prop_ele = etree.Element(f"{DASCH_SCHEMA}resptr-prop", name="hasLinkTo", nsmap=XML_NAMESPACE_MAP)
        vals = [LinkValue(value=x, prop_name="hasLinkTo", resource_id=self.res_id) for x in self.link_to]
        prop_ele.extend([v.make_element() for v in vals])
        return prop_ele

create_new

Creates a new link resource. A link resource is like a container that groups together several other resources of different classes.

See XML documentation for details

Parameters:

Name	Type	Description	Default
res_id	str	ID of this link resource	required
label	str	label of this link resource	required
link_to	Collection[str]	IDs of the resources that should be linked together (cardinality 1-n)	required
permissions	Permissions	permissions of this link resource	PROJECT_SPECIFIC_PERMISSIONS

Returns:

Type	Description
LinkResource	A link resource

Examples:

link_resource = xmllib.LinkResource.create_new(
    res_id="ID",
    label="label",
    link_to=["target_resource_id_1", "target_resource_id_2"],
)

Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py

@staticmethod
def create_new(
    res_id: str,
    label: str,
    link_to: Collection[str],
    permissions: Permissions = Permissions.PROJECT_SPECIFIC_PERMISSIONS,
) -> LinkResource:
    """
    Creates a new link resource.
    A link resource is like a container that groups together several other resources of different classes.

    [See XML documentation for details](https://docs.dasch.swiss/latest/DSP-TOOLS/file-formats/xml-data-file/#link)

    Args:
        res_id: ID of this link resource
        label: label of this link resource
        link_to: IDs of the resources that should be linked together (cardinality 1-n)
        permissions: permissions of this link resource

    Returns:
        A link resource

    Examples:
        ```python
        link_resource = xmllib.LinkResource.create_new(
            res_id="ID",
            label="label",
            link_to=["target_resource_id_1", "target_resource_id_2"],
        )
        ```
    """
    return LinkResource(
        res_id=res_id,
        label=label,
        link_to=list(link_to),
        permissions=permissions,
    )

add_comment

Add a comment to the resource

Parameters:

Name	Type	Description	Default
comment	str	text	required

Returns:

Type	Description
LinkResource	The original resource, with the added comment

Examples:

link_resource = link_resource.add_comment("comment text")

Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py

def add_comment(self, comment: str) -> LinkResource:
    """
    Add a comment to the resource

    Args:
        comment: text

    Returns:
        The original resource, with the added comment

    Examples:
        ```python
        link_resource = link_resource.add_comment("comment text")
        ```
    """
    self.comments.append(comment)
    return self

add_comment_multiple

Add several comments to the resource

Parameters:

Name	Type	Description	Default
comments	Collection[str]	list of texts	required

Returns:

Type	Description
LinkResource	The original resource, with the added comments

Examples:

link_resource = link_resource.add_comment_multiple(["comment 1", "comment 2"])

Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py

def add_comment_multiple(self, comments: Collection[str]) -> LinkResource:
    """
    Add several comments to the resource

    Args:
        comments: list of texts

    Returns:
        The original resource, with the added comments

    Examples:
        ```python
        link_resource = link_resource.add_comment_multiple(["comment 1", "comment 2"])
        ```
    """
    self.comments.extend(comments)
    return self

add_comment_optional

If the value is not empty, add it as comment, otherwise return the resource unchanged.

Parameters:

Name	Type	Description	Default
comment	Any	text or empty value	required

Returns:

Type	Description
LinkResource	The original resource, with the added comment

Examples:

link_resource = link_resource.add_comment_optional("comment text")

link_resource = link_resource.add_comment_optional(None)

Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py

def add_comment_optional(self, comment: Any) -> LinkResource:
    """
    If the value is not empty, add it as comment, otherwise return the resource unchanged.

    Args:
        comment: text or empty value

    Returns:
        The original resource, with the added comment

    Examples:
        ```python
        link_resource = link_resource.add_comment_optional("comment text")
        ```

        ```python
        link_resource = link_resource.add_comment_optional(None)
        ```
    """
    if is_nonempty_value(comment):
        self.comments.append(comment)
    return self

add_migration_metadata

Add metadata from a SALSAH migration.

Parameters:

Name	Type	Description	Default
creation_date	str | None	creation date of the resource in SALSAH	required
iri	str | None	Original IRI in SALSAH	None
ark	str | None	Original ARK in SALSAH	None

Returns:

Type	Description
LinkResource	The original resource, with the added metadata

Examples:

link_resource = link_resource.add_migration_metadata(
    iri="http://rdfh.ch/4123/DiAmYQzQSzC7cdTo6OJMYA",
    creation_date="1999-12-31T23:59:59.9999999+01:00"
)

Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py

def add_migration_metadata(
    self, creation_date: str | None, iri: str | None = None, ark: str | None = None
) -> LinkResource:
    """
    Add metadata from a SALSAH migration.

    Args:
        creation_date: creation date of the resource in SALSAH
        iri: Original IRI in SALSAH
        ark: Original ARK in SALSAH

    Raises:
        InputError: if metadata already exists

    Returns:
        The original resource, with the added metadata

    Examples:
        ```python
        link_resource = link_resource.add_migration_metadata(
            iri="http://rdfh.ch/4123/DiAmYQzQSzC7cdTo6OJMYA",
            creation_date="1999-12-31T23:59:59.9999999+01:00"
        )
        ```
    """
    if self.migration_metadata:
        raise InputError(
            f"The resource with the ID '{self.res_id}' already contains migration metadata, "
            f"no new data can be added."
        )
    self.migration_metadata = MigrationMetadata(creation_date=creation_date, iri=iri, ark=ark, res_id=self.res_id)
    return self