oc_ocdm.graph.entities.bibliographic.citation module
- class oc_ocdm.graph.entities.bibliographic.citation.Citation(g, g_set, res=None, res_type=None, resp_agent=None, source=None, count=None, label=None, short_name='', preexisting_graph=None)[source]
Bases:
oc_ocdm.graph.entities.bibliographic_entity.BibliographicEntity
Citation (short: ci): a permanent conceptual directional link from the citing bibliographic resource to a cited bibliographic resource. A citation is created by the performative act of an author citing a published work that is relevant to the current work by using a particular textual device. Typically, citations are made by including a bibliographic reference in the reference list of the citing work and by denoting such a bibliographic reference using one or more in-text reference pointers (e.g. ‘[1]’), or by the inclusion within the citing work of a link, in the form of an HTTP Uniform Resource Locator (URL), to the cited bibliographic resource on the World Wide Web.
Constructor of the
AbstractEntity
class.- Parameters
g (Graph) –
g_set (GraphSet) –
res (URIRef) –
res_type (URIRef) –
resp_agent (str) –
source (str) –
count (str) –
label (str) –
short_name (str) –
preexisting_graph (Graph) –
- Return type
None
- merge(other)[source]
The merge operation allows combining two
Citation
entities into a single one, by marking the second entity as to be deleted while also copying its data into the currentCitation
. Moreover, every triple from the containingGraphSet
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, whilerdf:type
is not.- Parameters
other (Citation) – The entity which will be marked as to be deleted and whose properties will be merged into the current entity.
- Raises
TypeError – if the parameter is of the wrong type
- Returns
None
- Return type
None
- get_citing_entity()[source]
Getter method corresponding to the
cito:hasCitingEntity
RDF predicate.- Returns
The requested value if found, None otherwise
- Return type
Optional[BibliographicResource]
- has_citing_entity(citing_res)[source]
Setter method corresponding to the
cito:hasCitingEntity
RDF predicate.WARNING: this is a functional property, hence any existing value will be overwritten!
The bibliographic resource which acts as the source for the citation.
- Parameters
citing_res (BibliographicResource) – The value that will be set as the object of the property related to this method
- Raises
TypeError – if the parameter is of the wrong type
- Returns
None
- Return type
None
- remove_citing_entity()[source]
Remover method corresponding to the
cito:hasCitingEntity
RDF predicate.- Returns
None
- Return type
None
- get_cited_entity()[source]
Getter method corresponding to the
cito:hasCitedEntity
RDF predicate.- Returns
The requested value if found, None otherwise
- Return type
Optional[BibliographicResource]
- has_cited_entity(cited_res)[source]
Setter method corresponding to the
cito:hasCitedEntity
RDF predicate.WARNING: this is a functional property, hence any existing value will be overwritten!
The bibliographic resource which acts as the target for the citation.
- Parameters
cited_res (BibliographicResource) – The value that will be set as the object of the property related to this method
- Raises
TypeError – if the parameter is of the wrong type
- Returns
None
- Return type
None
- remove_cited_entity()[source]
Remover method corresponding to the
c4o:hasCitedEntity
RDF predicate.- Returns
None
- Return type
None
- get_citation_creation_date()[source]
Getter method corresponding to the
cito:hasCitationCreationDate
RDF predicate.- Returns
The requested value if found, None otherwise
- Return type
Optional[str]
- has_citation_creation_date(string)[source]
Setter method corresponding to the
cito:hasCitationCreationDate
RDF predicate.WARNING: this is a functional property, hence any existing value will be overwritten!
The date on which the citation was created. This has the same numerical value as the publication date of the citing bibliographic resource, but is a property of the citation itself. When combined with the citation time span, it permits that citation to be located in history.
- Parameters
string (str) – The value that will be set as the object of the property related to this method. It must be a string compliant with the
ISO 8601
standard.- Raises
TypeError – if the parameter is of the wrong type
- Returns
None
- Return type
None
- remove_citation_creation_date()[source]
Remover method corresponding to the
c4o:hasCitationCreationDate
RDF predicate.- Returns
None
- Return type
None
- get_citation_time_span()[source]
Getter method corresponding to the
cito:hasCitationTimeSpan
RDF predicate.- Returns
The requested value if found, None otherwise
- Return type
Optional[str]
- has_citation_time_span(string)[source]
Setter method corresponding to the
cito:hasCitationTimeSpan
RDF predicate.WARNING: this is a functional property, hence any existing value will be overwritten!
The date interval between the publication date of the cited bibliographic resource and the publication date of the citing bibliographic resource.
- Parameters
string (str) – The value that will be set as the object of the property related to this method. It must be a string compliant with the
xsd:duration
datatype.- Raises
TypeError – if the parameter is of the wrong type
- Returns
None
- Return type
None
- remove_citation_time_span()[source]
Remover method corresponding to the
c4o:hasCitationTimeSpan
RDF predicate.- Returns
None
- Return type
None
- get_citation_characterization()[source]
Getter method corresponding to the
cito:hasCitationCharacterisation
RDF predicate.- Returns
The requested value if found, None otherwise
- Return type
Optional[URIRef]
- has_citation_characterization(thing_res)[source]
Setter method corresponding to the
cito:hasCitationCharacterisation
RDF predicate.WARNING: this is a functional property, hence any existing value will be overwritten!
The citation function characterizing the purpose of the citation.
- Parameters
thing_res (URIRef) – The value that will be set as the object of the property related to this method
- Raises
TypeError – if the parameter is of the wrong type
- Returns
None
- Return type
None
- remove_citation_characterization()[source]
Remover method corresponding to the
c4o:hasCitationCharacterisation
RDF predicate.- Returns
None
- Return type
None
- create_self_citation()[source]
Setter method corresponding to the
rdf:type
RDF predicate. It implicitly sets the object valuecito:SelfCitation
.WARNING: the OCDM specification admits at most two types for an entity. The main type cannot be edited or removed. Any existing secondary type will be overwritten!
- Returns
None
- Return type
None
- create_affiliation_self_citation()[source]
Setter method corresponding to the
rdf:type
RDF predicate. It implicitly sets the object valuecito:AffiliationSelfCitation
.WARNING: the OCDM specification admits at most two types for an entity. The main type cannot be edited or removed. Any existing secondary type will be overwritten!
- Returns
None
- Return type
None
- create_author_network_self_citation()[source]
Setter method corresponding to the
rdf:type
RDF predicate. It implicitly sets the object valuecito:AuthorNetworkSelfCitation
.WARNING: the OCDM specification admits at most two types for an entity. The main type cannot be edited or removed. Any existing secondary type will be overwritten!
- Returns
None
- Return type
None
- create_author_self_citation()[source]
Setter method corresponding to the
rdf:type
RDF predicate. It implicitly sets the object valuecito:AuthorSelfCitation
.WARNING: the OCDM specification admits at most two types for an entity. The main type cannot be edited or removed. Any existing secondary type will be overwritten!
- Returns
None
- Return type
None
- create_funder_self_citation()[source]
Setter method corresponding to the
rdf:type
RDF predicate. It implicitly sets the object valuecito:FunderSelfCitation
.WARNING: the OCDM specification admits at most two types for an entity. The main type cannot be edited or removed. Any existing secondary type will be overwritten!
- Returns
None
- Return type
None
- create_journal_self_citation()[source]
Setter method corresponding to the
rdf:type
RDF predicate. It implicitly sets the object valuecito:JournalSelfCitation
.WARNING: the OCDM specification admits at most two types for an entity. The main type cannot be edited or removed. Any existing secondary type will be overwritten!
- Returns
None
- Return type
None
- create_journal_cartel_citation()[source]
Setter method corresponding to the
rdf:type
RDF predicate. It implicitly sets the object valuecito:JournalCartelCitation
.WARNING: the OCDM specification admits at most two types for an entity. The main type cannot be edited or removed. Any existing secondary type will be overwritten!
- Returns
None
- Return type
None
- create_distant_citation()[source]
Setter method corresponding to the
rdf:type
RDF predicate. It implicitly sets the object valuecito:DistantCitation
.WARNING: the OCDM specification admits at most two types for an entity. The main type cannot be edited or removed. Any existing secondary type will be overwritten!
- Returns
None
- Return type
None