ISOKeywords: ISOKeywords

In eblondel/geometa: Tools for Reading and Writing ISO/OGC Geographic Metadata

ISOKeywords

Description

ISOKeywords

ISOKeywords

Format

R6Class object.

Value

Object of R6Class for modelling a ISO set of keywords

Super classes

geometa::geometaLogger -> geometa::ISOAbstractObject -> ISOKeywords

Public fields

keyword

keyword

type

type

thesaurusName

thesaurus name

Methods

Public methods

• ISOKeywords$new()

• ISOKeywords$addKeyword()

• ISOKeywords$delKeyword()

• ISOKeywords$setKeywordType()

• ISOKeywords$setThesaurusName()

• ISOKeywords$clone()

Inherited methods

• geometa::geometaLogger$ERROR()
• geometa::geometaLogger$INFO()
• geometa::geometaLogger$WARN()
• geometa::ISOAbstractObject$addFieldAttrs()
• geometa::ISOAbstractObject$addListElement()
• geometa::ISOAbstractObject$checkMetadataStandardCompliance()
• geometa::ISOAbstractObject$contains()
• geometa::ISOAbstractObject$createLocalisedProperty()
• geometa::ISOAbstractObject$decode()
• geometa::ISOAbstractObject$delListElement()
• geometa::ISOAbstractObject$encode()
• geometa::ISOAbstractObject$getClass()
• geometa::ISOAbstractObject$getClassName()
• geometa::ISOAbstractObject$getNamespaceDefinition()
• geometa::ISOAbstractObject$isDocument()
• geometa::ISOAbstractObject$isFieldInheritedFrom()
• geometa::ISOAbstractObject$print()
• geometa::ISOAbstractObject$save()
• geometa::ISOAbstractObject$setAttr()
• geometa::ISOAbstractObject$setCodeList()
• geometa::ISOAbstractObject$setCodeListValue()
• geometa::ISOAbstractObject$setCodeSpace()
• geometa::ISOAbstractObject$setHref()
• geometa::ISOAbstractObject$setId()
• geometa::ISOAbstractObject$setIsNull()
• geometa::ISOAbstractObject$setValue()
• geometa::ISOAbstractObject$stopIfMetadataStandardIsNot()
• geometa::ISOAbstractObject$validate()
• geometa::ISOAbstractObject$wrapBaseElement()

---

Method new()

Initializes object

Usage

ISOKeywords$new(xml = NULL)

Arguments

xml

object of class XMLInternalNode-class

---

Method addKeyword()

Adds keyword

Usage

ISOKeywords$addKeyword(keyword, locales = NULL)

Arguments

keyword

keyword

locales

list of localized texts. Default is NULL

Returns

TRUE if added, FALSe otherwise

---

Method delKeyword()

Deletes keyword

Usage

ISOKeywords$delKeyword(keyword, locales = NULL)

Arguments

keyword

keyword

locales

list of localized texts. Default is NULL

Returns

TRUE if deleted, FALSe otherwise

---

Method setKeywordType()

Set keyword type

Usage

ISOKeywords$setKeywordType(keywordType)

Arguments

keywordType

object of class ISOKeywordType or any character among values returned by ISOKeywordType$values()

---

Method setThesaurusName()

Set thesaurus name

Usage

ISOKeywords$setThesaurusName(thesaurusName)

Arguments

thesaurusName

object of class ISOCitation

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ISOKeywords$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <[e-mail]>

References

- ISO 19139 https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_MD_Keywords

- ISO 19115-3 https://schemas.isotc211.org/19115/-3/mri/1.0/mri/#element_MD_Keywords

Examples

  #a basic keyword set
  md <- ISOKeywords$new()
  md$addKeyword("keyword1")
  md$addKeyword("keyword2")
  md$setKeywordType("theme")
  th <- ISOCitation$new()
  th$setTitle("General")
  md$setThesaurusName(th)
  xml <- md$encode()
  
  #a keyword set with anchors
  md <- ISOKeywords$new()
  kwd1 <- ISOAnchor$new(
    name = "keyword1",
    href = "http://myvocabulary.geometa/keyword1"
  )
  md$addKeyword(kwd1)
  kwd2 <- ISOAnchor$new(
    name = "keyword2",
    href = "http://myvocabulary.geometa/keyword2"
  )
  md$addKeyword(kwd2)
  md$setKeywordType("theme")
  xml <- md$encode()
  
  #Example for INSPIRE (GEMET Spatial Data Theme)
  inspire_kwd <- ISOKeywords$new()
  anc1 <- ISOAnchor$new(
    name = "Environmental monitoring facilities",
    href = "http://inspire.ec.europa.eu/theme/ef"
  )
  inspire_kwd$addKeyword(anc1)
  inspire_kwd$setKeywordType("theme")
  th <- ISOCitation$new()
  th$setTitle(
    ISOAnchor$new(
     name = "GEMET - INSPIRE themes, version 1.0",
     href="http://www.eionet.europa.eu/gemet/inspire_themes"
    )
  )
  inspire_date <- ISODate$new()
  inspire_date$setDate(as.Date("2008-06-01"))
  inspire_date$setDateType("publication")
  th$addDate(inspire_date)
  inspire_kwd$setThesaurusName(th)
  

eblondel/geometa documentation built on Oct. 10, 2024, 4:46 p.m.