Skip to content

AudioSegmentResource

Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
@dataclass
class AudioSegmentResource:
    res_id: str
    label: str
    segment_of: str
    segment_bounds: SegmentBounds
    title: str | None = None
    comments: list[str] = field(default_factory=list)
    descriptions: list[str] = field(default_factory=list)
    keywords: list[str] = field(default_factory=list)
    relates_to: 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,
        segment_of: str,
        segment_start: float,
        segment_end: float,
        permissions: Permissions = Permissions.PROJECT_SPECIFIC_PERMISSIONS,
    ) -> AudioSegmentResource:
        """
        Creates a new audio segment resource, i.e. a time span of an AudioRepresentation.

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

        Args:
            res_id: ID of this audio segment resource
            label: label of this audio segment resource
            segment_of: ID of the audio resource that this segment refers to (cardinality 1)
            segment_start: start of the segment in seconds (cardinality 1)
            segment_end: end of the segment in seconds (cardinality 1)
            permissions: permissions of this resource

        Returns:
            An audio segment resource
        """
        return AudioSegmentResource(
            res_id=res_id,
            label=label,
            segment_of=segment_of,
            segment_bounds=SegmentBounds(segment_start, segment_end, res_id),
            permissions=permissions,
        )

    def add_title(self, title: str) -> AudioSegmentResource:
        """
        Add a title to the resource.

        Args:
            title: text

        Returns:
            The original resource, with the added title
        """
        if self.title:
            _warn_value_exists(old_value=self.title, new_value=title, value_field="title", res_id=self.res_id)
        self.title = title
        return self

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

        Args:
            title: text or empty value

        Returns:
            The original resource, with the added title
        """
        if is_nonempty_value(title):
            if self.title:
                _warn_value_exists(old_value=self.title, new_value=title, value_field="title", res_id=self.res_id)
            self.title = title
        return self

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

        Args:
            comment: text

        Returns:
            The original resource, with the added comment
        """
        self.comments.append(comment)
        return self

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

        Args:
            comments: list of texts

        Returns:
            The original resource, with the added comments
        """
        self.comments.extend(comments)
        return self

    def add_comment_optional(self, comment: Any) -> AudioSegmentResource:
        """
        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
        """
        if is_nonempty_value(comment):
            self.comments.append(comment)
        return self

    def add_description(self, description: str) -> AudioSegmentResource:
        """
        Add a description to the resource

        Args:
            description: text

        Returns:
            The original resource, with the added description
        """
        self.descriptions.append(description)
        return self

    def add_description_multiple(self, descriptions: Collection[str]) -> AudioSegmentResource:
        """
        Add several descriptions to the resource

        Args:
            descriptions: list of texts

        Returns:
            The original resource, with the added descriptions
        """
        self.descriptions.extend(descriptions)
        return self

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

        Args:
            description: text or empty value

        Returns:
            The original resource, with the added description
        """
        if is_nonempty_value(description):
            self.descriptions.append(description)
        return self

    def add_keyword(self, keyword: str) -> AudioSegmentResource:
        """
        Add a keyword to the resource

        Args:
            keyword: text

        Returns:
            The original resource, with the added keyword
        """
        self.keywords.append(keyword)
        return self

    def add_keyword_multiple(self, keywords: Collection[str]) -> AudioSegmentResource:
        """
        Add several keywords to the resource

        Args:
            keywords: list of texts

        Returns:
            The original resource, with the added keywords
        """
        self.keywords.extend(keywords)
        return self

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

        Args:
            keyword: text or empty value

        Returns:
            The original resource, with the added keyword
        """
        if is_nonempty_value(keyword):
            self.keywords.append(keyword)
        return self

    def add_relates_to(self, relates_to: str) -> AudioSegmentResource:
        """
        Add a link to a related resource

        Args:
            relates_to: ID of the related resource

        Returns:
            The original resource, with the added related resource
        """
        self.relates_to.append(relates_to)
        return self

    def add_relates_to_multiple(self, relates_to: Collection[str]) -> AudioSegmentResource:
        """
        Add several links to related resources

        Args:
            relates_to: list of IDs of the related resources

        Returns:
            The original resource, with the added related resources
        """
        self.relates_to.extend(relates_to)
        return self

    def add_relates_to_optional(self, relates_to: Any) -> AudioSegmentResource:
        """
        If the value is not empty, add it as related resource, otherwise return the resource unchanged.

        Args:
            relates_to: ID of the related resource or empty value

        Returns:
            The original resource, with the added related resources
        """
        if is_nonempty_value(relates_to):
            self.relates_to.append(relates_to)
        return self

    def add_migration_metadata(
        self, creation_date: str | None, iri: str | None = None, ark: str | None = None
    ) -> AudioSegmentResource:
        """
        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
        """
        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()
        res_ele.extend(_serialise_segment_children(self))
        return res_ele

    def _check_for_and_convert_unexpected_input(self) -> None:
        self.comments = _transform_unexpected_input(self.comments, "comments", self.res_id)
        self.descriptions = _transform_unexpected_input(self.descriptions, "descriptions", self.res_id)
        self.keywords = _transform_unexpected_input(self.keywords, "keywords", self.res_id)
        self.relates_to = _transform_unexpected_input(self.relates_to, "relates_to", self.res_id)
        _validate_segment(self)

    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}audio-segment", attrib=attribs, nsmap=XML_NAMESPACE_MAP)

create_new

Creates a new audio segment resource, i.e. a time span of an AudioRepresentation.

See XML documentation for details

Parameters:

Name Type Description Default
res_id str

ID of this audio segment resource

 required
label str

label of this audio segment resource

 required
segment_of str

ID of the audio resource that this segment refers to (cardinality 1)

 required
segment_start float

start of the segment in seconds (cardinality 1)

 required
segment_end float

end of the segment in seconds (cardinality 1)

 required
permissions Permissions

permissions of this resource

 PROJECT_SPECIFIC_PERMISSIONS

Returns:

Type Description
AudioSegmentResource

An audio segment resource
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
@staticmethod
def create_new(
    res_id: str,
    label: str,
    segment_of: str,
    segment_start: float,
    segment_end: float,
    permissions: Permissions = Permissions.PROJECT_SPECIFIC_PERMISSIONS,
) -> AudioSegmentResource:
    """
    Creates a new audio segment resource, i.e. a time span of an AudioRepresentation.

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

    Args:
        res_id: ID of this audio segment resource
        label: label of this audio segment resource
        segment_of: ID of the audio resource that this segment refers to (cardinality 1)
        segment_start: start of the segment in seconds (cardinality 1)
        segment_end: end of the segment in seconds (cardinality 1)
        permissions: permissions of this resource

    Returns:
        An audio segment resource
    """
    return AudioSegmentResource(
        res_id=res_id,
        label=label,
        segment_of=segment_of,
        segment_bounds=SegmentBounds(segment_start, segment_end, res_id),
        permissions=permissions,
    )

add_title

Add a title to the resource.

Parameters:

Name Type Description Default
title str

text

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added title
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
800
801
802
803
804
805
806
807
808
809
810
811
812
813
def add_title(self, title: str) -> AudioSegmentResource:
    """
    Add a title to the resource.

    Args:
        title: text

    Returns:
        The original resource, with the added title
    """
    if self.title:
        _warn_value_exists(old_value=self.title, new_value=title, value_field="title", res_id=self.res_id)
    self.title = title
    return self

add_title_optional

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

Parameters:

Name Type Description Default
title Any

text or empty value

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added title
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
def add_title_optional(self, title: Any) -> AudioSegmentResource:
    """
    If the value is not empty, add it as title, otherwise return the resource unchanged.

    Args:
        title: text or empty value

    Returns:
        The original resource, with the added title
    """
    if is_nonempty_value(title):
        if self.title:
            _warn_value_exists(old_value=self.title, new_value=title, value_field="title", res_id=self.res_id)
        self.title = title
    return self

add_comment

Add a comment to the resource

Parameters:

Name Type Description Default
comment str

text

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added comment
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
831
832
833
834
835
836
837
838
839
840
841
842
def add_comment(self, comment: str) -> AudioSegmentResource:
    """
    Add a comment to the resource

    Args:
        comment: text

    Returns:
        The original resource, with the added comment
    """
    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
AudioSegmentResource

The original resource, with the added comments
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
844
845
846
847
848
849
850
851
852
853
854
855
def add_comment_multiple(self, comments: Collection[str]) -> AudioSegmentResource:
    """
    Add several comments to the resource

    Args:
        comments: list of texts

    Returns:
        The original resource, with the added comments
    """
    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
AudioSegmentResource

The original resource, with the added comment
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
857
858
859
860
861
862
863
864
865
866
867
868
869
def add_comment_optional(self, comment: Any) -> AudioSegmentResource:
    """
    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
    """
    if is_nonempty_value(comment):
        self.comments.append(comment)
    return self

add_description

Add a description to the resource

Parameters:

Name Type Description Default
description str

text

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added description
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
871
872
873
874
875
876
877
878
879
880
881
882
def add_description(self, description: str) -> AudioSegmentResource:
    """
    Add a description to the resource

    Args:
        description: text

    Returns:
        The original resource, with the added description
    """
    self.descriptions.append(description)
    return self

add_description_multiple

Add several descriptions to the resource

Parameters:

Name Type Description Default
descriptions Collection[str]

list of texts

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added descriptions
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
884
885
886
887
888
889
890
891
892
893
894
895
def add_description_multiple(self, descriptions: Collection[str]) -> AudioSegmentResource:
    """
    Add several descriptions to the resource

    Args:
        descriptions: list of texts

    Returns:
        The original resource, with the added descriptions
    """
    self.descriptions.extend(descriptions)
    return self

add_description_optional

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

Parameters:

Name Type Description Default
description Any

text or empty value

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added description
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
897
898
899
900
901
902
903
904
905
906
907
908
909
def add_description_optional(self, description: Any) -> AudioSegmentResource:
    """
    If the value is not empty, add it as description, otherwise return the resource unchanged.

    Args:
        description: text or empty value

    Returns:
        The original resource, with the added description
    """
    if is_nonempty_value(description):
        self.descriptions.append(description)
    return self

add_keyword

Add a keyword to the resource

Parameters:

Name Type Description Default
keyword str

text

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added keyword
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
911
912
913
914
915
916
917
918
919
920
921
922
def add_keyword(self, keyword: str) -> AudioSegmentResource:
    """
    Add a keyword to the resource

    Args:
        keyword: text

    Returns:
        The original resource, with the added keyword
    """
    self.keywords.append(keyword)
    return self

add_keyword_multiple

Add several keywords to the resource

Parameters:

Name Type Description Default
keywords Collection[str]

list of texts

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added keywords
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
924
925
926
927
928
929
930
931
932
933
934
935
def add_keyword_multiple(self, keywords: Collection[str]) -> AudioSegmentResource:
    """
    Add several keywords to the resource

    Args:
        keywords: list of texts

    Returns:
        The original resource, with the added keywords
    """
    self.keywords.extend(keywords)
    return self

add_keyword_optional

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

Parameters:

Name Type Description Default
keyword Any

text or empty value

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added keyword
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
937
938
939
940
941
942
943
944
945
946
947
948
949
def add_keyword_optional(self, keyword: Any) -> AudioSegmentResource:
    """
    If the value is not empty, add it as keyword, otherwise return the resource unchanged.

    Args:
        keyword: text or empty value

    Returns:
        The original resource, with the added keyword
    """
    if is_nonempty_value(keyword):
        self.keywords.append(keyword)
    return self

add_relates_to

Add a link to a related resource

Parameters:

Name Type Description Default
relates_to str

ID of the related resource

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added related resource
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
951
952
953
954
955
956
957
958
959
960
961
962
def add_relates_to(self, relates_to: str) -> AudioSegmentResource:
    """
    Add a link to a related resource

    Args:
        relates_to: ID of the related resource

    Returns:
        The original resource, with the added related resource
    """
    self.relates_to.append(relates_to)
    return self

add_relates_to_multiple

Add several links to related resources

Parameters:

Name Type Description Default
relates_to Collection[str]

list of IDs of the related resources

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added related resources
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
964
965
966
967
968
969
970
971
972
973
974
975
def add_relates_to_multiple(self, relates_to: Collection[str]) -> AudioSegmentResource:
    """
    Add several links to related resources

    Args:
        relates_to: list of IDs of the related resources

    Returns:
        The original resource, with the added related resources
    """
    self.relates_to.extend(relates_to)
    return self

add_relates_to_optional

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

Parameters:

Name Type Description Default
relates_to Any

ID of the related resource or empty value

 required

Returns:

Type Description
AudioSegmentResource

The original resource, with the added related resources
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
977
978
979
980
981
982
983
984
985
986
987
988
989
def add_relates_to_optional(self, relates_to: Any) -> AudioSegmentResource:
    """
    If the value is not empty, add it as related resource, otherwise return the resource unchanged.

    Args:
        relates_to: ID of the related resource or empty value

    Returns:
        The original resource, with the added related resources
    """
    if is_nonempty_value(relates_to):
        self.relates_to.append(relates_to)
    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
AudioSegmentResource

The original resource, with the added metadata
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/dsp_base_resources.py 
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
def add_migration_metadata(
    self, creation_date: str | None, iri: str | None = None, ark: str | None = None
) -> AudioSegmentResource:
    """
    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
    """
    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