#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2016, Silvio Peroni <essepuntato@gmail.com>
#
# Permission to use, copy, modify, and/or distribute this software for any purpose
# with or without fee is hereby granted, provided that the above copyright notice
# and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
# FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT,
# OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
# DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
# ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
# SOFTWARE.
from __future__ import annotations
from typing import TYPE_CHECKING
from oc_ocdm.decorators import accepts_only
if TYPE_CHECKING:
from typing import Optional, List
from rdflib import URIRef
from oc_ocdm.graph.entities.bibliographic.reference_pointer import ReferencePointer
from oc_ocdm.graph.graph_entity import GraphEntity
from oc_ocdm.graph.entities.bibliographic_entity import BibliographicEntity
[docs]class PointerList(BibliographicEntity):
"""Pointer list (short: pl): a textual device (e.g. '[1, 2, 3]' or '[4-9]') which includes a
number of reference pointers denoting the specific bibliographic references to which
the list pertains."""
[docs] @accepts_only('pl')
def merge(self, other: PointerList) -> None:
"""
The merge operation allows combining two ``PointerList`` entities into a single one,
by marking the second entity as to be deleted while also copying its data into the current
``PointerList``. Moreover, every triple from the containing ``GraphSet`` referring to the second
entity gets "redirected" to the current entity: **every other reference contained inside a
different source (e.g. a triplestore) must be manually handled by the user!**
In case of functional properties, values from the current entity get overwritten
by those coming from the second entity while, in all other cases, values from the
second entity are simply appended to those of the current entity. In this context,
``rdfs:label`` is considered as a functional property, while ``rdf:type`` is not.
:param other: The entity which will be marked as to be deleted and whose properties will
be merged into the current entity.
:type other: PointerList
:raises TypeError: if the parameter is of the wrong type
:return: None
"""
super(PointerList, self).merge(other)
content: Optional[str] = self.get_content()
if content is not None:
self.has_content(content)
rp_list: List[ReferencePointer] = other.get_contained_elements()
for cur_rp in rp_list:
self.contains_element(cur_rp)
# HAS POINTER LIST TEXT
[docs] def get_content(self) -> Optional[str]:
"""
Getter method corresponding to the ``c4o:hasContent`` RDF predicate.
:return: The requested value if found, None otherwise
"""
return self._get_literal(GraphEntity.iri_has_content)
[docs] @accepts_only('literal')
def has_content(self, string: str) -> None:
"""
Setter method corresponding to the ``c4o:hasContent`` RDF predicate.
**WARNING: this is a functional property, hence any existing value will be overwritten!**
:param string: The value that will be set as the object of the property related to this method
:type string: str
:raises TypeError: if the parameter is of the wrong type
:return: None
"""
self.remove_content()
self._create_literal(GraphEntity.iri_has_content, string)
[docs] def remove_content(self) -> None:
"""
Remover method corresponding to the ``c4o:hasContent`` RDF predicate.
:return: None
"""
self.g.remove((self.res, GraphEntity.iri_has_content, None))
# HAS ELEMENT (ReferencePointer)
[docs] def get_contained_elements(self) -> List[ReferencePointer]:
"""
Getter method corresponding to the ``co:element`` RDF predicate.
:return: A list containing the requested values if found, None otherwise
"""
uri_list: List[URIRef] = self._get_multiple_uri_references(GraphEntity.iri_has_element, 'rp')
result: List[ReferencePointer] = []
for uri in uri_list:
result.append(self.g_set.add_rp(self.resp_agent, self.source, uri))
return result
[docs] @accepts_only('rp')
def contains_element(self, rp_res: ReferencePointer) -> None:
"""
Setter method corresponding to the ``co:element`` RDF predicate.
`The in-text reference pointer that is part of the in-text reference pointer list present at
a particular location within the body of the citing work.`
:param rp_res: The value that will be set as the object of the property related to this method
:type rp_res: ReferencePointer
:raises TypeError: if the parameter is of the wrong type
:return: None
"""
self.g.add((self.res, GraphEntity.iri_has_element, rp_res.res))
[docs] @accepts_only('rp')
def remove_contained_element(self, rp_res: ReferencePointer = None) -> None:
"""
Remover method corresponding to the ``co:element`` RDF predicate.
**WARNING: this is a non-functional property, hence, if the parameter
is None, any existing value will be removed!**
:param rp_res: If not None, the specific object value that will be removed from the property
related to this method (defaults to None)
:type rp_res: ReferencePointer
:raises TypeError: if the parameter is of the wrong type
:return: None
"""
if rp_res is not None:
self.g.remove((self.res, GraphEntity.iri_has_element, rp_res.res))
else:
self.g.remove((self.res, GraphEntity.iri_has_element, None))