ISOCitation function

ISOCitation

ISOCitation

ISOCitation

ISOCitation class

Format

R6Class object.

Returns

Object of R6Class for modelling an ISO Citation

Examples

#create ISOCitation md <- ISOCitation$new() md$setTitle("sometitle") md$setEdition("1.0") md$setEditionDate(ISOdate(2015,1,1)) md$addIdentifier(ISOMetaIdentifier$new(code = "identifier")) md$addPresentationForm("mapDigital") #add a cited responsible party rp <- ISOResponsibleParty$new() rp$setIndividualName("someone") rp$setOrganisationName("somewhere") rp$setPositionName("someposition") rp$setRole("pointOfContact") contact <- ISOContact$new() phone <- ISOTelephone$new() phone$setVoice("myphonenumber") phone$setFacsimile("myfacsimile") contact$setPhone(phone) address <- ISOAddress$new() address$setDeliveryPoint("theaddress") address$setCity("thecity") address$setPostalCode("111") address$setCountry("France") address$setEmail("someone@theorg.org") contact$setAddress(address) res <- ISOOnlineResource$new() res$setLinkage("http://www.somewhereovertheweb.org") res$setName("somename") contact$setOnlineResource(res) rp$setContactInfo(contact) md$addCitedResponsibleParty(rp) xml <- md$encode()

References

Author(s)

Emmanuel Blondel emmanuel.blondel1@gmail.com

Super classes

geometa::geometaLogger -> geometa::ISOAbstractObject -> geometa::ISOAbstractCitation -> ISOCitation

Public fields

  • title: title

  • alternateTitle: alternate title

  • date: date list

  • edition: edition

  • editionDate: edition date

  • identifier: identifier list

  • citedResponsibleParty: list of cited responsible parties

  • presentationForm: list of presentation forms

  • series: series

  • otherCitationDetails: other citation details

  • collectiveTitle: collective title (for ISO 19139)

  • ISBN: ISBN

  • ISSN: ISSN

  • onlineResource: online resource (for ISO 19115-3)

  • graphic: graphic (for ISO 19115-3)

Methods

Public methods

Method new()

Initializes object

Usage

ISOCitation$new(xml = NULL)

Arguments

  • xml: object of class XMLInternalNode-class

Method setTitle()

Set title

Usage

ISOCitation$setTitle(title, locales = NULL)

Arguments

  • title: title

  • locales: list of localized names. Default is NULL

Method addAlternateTitle()

Adds alternate title

Usage

ISOCitation$addAlternateTitle(alternateTitle, locales = NULL)

Arguments

  • alternateTitle: alternate title

  • locales: list of localized titles. Default is NULL

Returns

TRUE if added, FALSE otherwise

Method delAlternateTitle()

Deletes alternate title

Usage

ISOCitation$delAlternateTitle(alternateTitle, locales = NULL)

Arguments

  • alternateTitle: alternate title

  • locales: list of localized titles. Default is NULL

Returns

TRUE if deleted, FALSE otherwise

Method addDate()

Adds date

Usage

ISOCitation$addDate(date)

Arguments

  • date: date

Returns

TRUE if added, FALSE otherwise

Method setEdition()

Set edition

Usage

ISOCitation$setEdition(edition, locales = NULL)

Arguments

  • edition: edition

  • locales: list of localized editions. Default is NULL

Method setEditionDate()

Sets the edition date, either an ISODate object containing date and dateType or a simple R date "POSIXct"/"POSIXt" object. For thesaurus citations, an ISODate should be used while for the general citation of ISODataIdentification, a simple R date should be used.

Usage

ISOCitation$setEditionDate(editionDate)

Arguments

  • editionDate: object of class Date or POSIXct

Method addIdentifier()

Adds identifier

Usage

ISOCitation$addIdentifier(identifier)

Arguments

  • identifier: identifier, object of class ISOMetaIdentifier

  • locales: list of localized identifiers. Default is NULL

Returns

TRUE if added, FALSE otherwise

Method delIdentifier()

Deletes identifier

Usage

ISOCitation$delIdentifier(identifier)

Arguments

  • identifier: identifier, object of class ISOMetaIdentifier

  • locales: list of localized identifiers. Default is NULL

Returns

TRUE if deleted, FALSE otherwise

Method addCitedResponsibleParty()

Adds cited responsible party

Usage

ISOCitation$addCitedResponsibleParty(rp)

Arguments

  • rp: cited responsible party, object of class ISOResponsibleParty (in ISO 19139) or ISOResponsibility (in ISO 19115-3)

  • locales: list of localized responsible parties. Default is NULL

Returns

TRUE if added, FALSE otherwise

Method delCitedResponsibleParty()

Deletes cited responsible party

Usage

ISOCitation$delCitedResponsibleParty(rp)

Arguments

  • rp: cited responsible party, object of class ISOResponsibleParty (in ISO 19139) or ISOResponsibility (in ISO 19115-3)

  • locales: list of localized responsible parties. Default is NULL

Returns

TRUE if deleted, FALSE otherwise

Method addPresentationForm()

Adds presentation form

Usage

ISOCitation$addPresentationForm(presentationForm)

Arguments

  • presentationForm: presentation form, object of class ISOPresentationForm or character among values returned by ISOPresentationForm$values()

Returns

TRUE if added, FALSE otherwise

Method delPresentationForm()

Deletes presentation form

Usage

ISOCitation$delPresentationForm(presentationForm)

Arguments

  • presentationForm: presentation form, object of class ISOPresentationForm or character among values returned by ISOPresentationForm$values()

Returns

TRUE if deleted, FALSE otherwise

Method setSeries()

Set series

Usage

ISOCitation$setSeries(series)

Arguments

  • series: object of class ISOCitationSeries

Method setOtherCitationDetails()

Set other citation details

Usage

ISOCitation$setOtherCitationDetails(otherCitationDetails, locales = NULL)

Arguments

  • otherCitationDetails: other citation details

  • locales: list of localized other citation details. Default is NULL

Method setCollectiveTitle()

Set collective title

Usage

ISOCitation$setCollectiveTitle(collectiveTitle, locales = NULL)

Arguments

  • collectiveTitle: collective title

  • locales: list of localized titles. Default is NULL

Method setISBN()

Set ISBN

Usage

ISOCitation$setISBN(isbn)

Arguments

  • isbn: isbn

Method setISSN()

Set ISSN

Usage

ISOCitation$setISSN(issn)

Arguments

  • issn: issn

Method addOnlineResource()

Adds online resource

Usage

ISOCitation$addOnlineResource(onlineResource)

Arguments

  • onlineResource: object of class ISOOnlineResource

Returns

TRUE if added, FALSE otherwise

Method delOnlineResource()

Deletes online resource

Usage

ISOCitation$delOnlineResource(onlineResource)

Arguments

  • onlineResource: object of class ISOOnlineResource

Returns

TRUE if added, FALSE otherwise

Method addGraphic()

Adds graphic

Usage

ISOCitation$addGraphic(graphic)

Arguments

  • graphic: object of class ISOBrowseGraphic

Returns

TRUE if added, FALSE otherwise

Method delGraphic()

Adds graphic

Usage

ISOCitation$delGraphic(graphic)

Arguments

  • graphic: object of class ISOBrowseGraphic

Returns

TRUE if deleted, FALSE otherwise

Method clone()

The objects of this class are cloneable with this method.

Usage

ISOCitation$clone(deep = FALSE)

Arguments

  • deep: Whether to make a deep clone.

  • Maintainer: Emmanuel Blondel
  • License: MIT + file LICENSE
  • Last published: 2025-01-29