ISOExtendedElementInformation: ISOExtendedElementInformation

ISOExtendedElementInformationR Documentation

ISOExtendedElementInformation

Description

ISOExtendedElementInformation

ISOExtendedElementInformation

Format

R6Class object.

Value

Object of R6Class for modelling an ISO ExtendedElementInformation

Super classes

geometa::geometaLogger -> geometa::ISOAbstractObject -> ISOExtendedElementInformation

Public fields

name

name [1..1]: character

shortName

shortName [0..1]: character

domainCode

domainCode [0..1]: integer

definition

definition [1..1]: character

obligation

obligation [0..1]: ISOObligation

condition

condition [0..1]: character

dataType

dataType [1..1]: ISODatatype

maximumOccurrence

maximumOccurrence [0..1]: character

domainValue

domainValue [0..1]: character

parentEntity

parentEntity [1..*]: character

rule

rule [1..1]: character

rationale

rationale [0..*]: character

source

source [1..*]: ISOResponsibleParty

Methods

Public methods

Inherited methods

Method new()

Initializes object

Usage
ISOExtendedElementInformation$new(xml = NULL)
Arguments
xml

object of class XMLInternalNode-class


Method setName()

Set name

Usage
ISOExtendedElementInformation$setName(name, locales = NULL)
Arguments
name

name

locales

list of localized names. Default is NULL


Method setShortName()

Set short name

Usage
ISOExtendedElementInformation$setShortName(shortName, locales = NULL)
Arguments
shortName

short name

locales

list of localized short names. Default is NULL


Method setDomainCode()

Set domain code

Usage
ISOExtendedElementInformation$setDomainCode(domainCode)
Arguments
domainCode

domain code, object of class integer


Method setDefinition()

Set definition

Usage
ISOExtendedElementInformation$setDefinition(definition, locales = NULL)
Arguments
definition

definition

locales

list of localized definitions. Default is NULL


Method setObligation()

Set obligation

Usage
ISOExtendedElementInformation$setObligation(obligation)
Arguments
obligation

obligation, object of class ISOObligation or any character value among those returned by ISOObligation$values()


Method setCondition()

Set condition

Usage
ISOExtendedElementInformation$setCondition(condition, locales = NULL)
Arguments
condition

condition

locales

list of localized conditions. Default is NULL


Method setDatatype()

Set data type

Usage
ISOExtendedElementInformation$setDatatype(dataType)
Arguments
dataType

data type, object of class ISODatatype or any character value among those returned by ISODatatype$values()


Method setMaximumOccurrence()

Set maximum occurrence

Usage
ISOExtendedElementInformation$setMaximumOccurrence(maximumOccurrence)
Arguments
maximumOccurrence

max occurrence


Method setDomainValue()

Set domain value

Usage
ISOExtendedElementInformation$setDomainValue(domainValue)
Arguments
domainValue

domain value


Method addParentEntity()

Adds parent entity

Usage
ISOExtendedElementInformation$addParentEntity(entity)
Arguments
entity

parent entity

Returns

TRUE if added, FALSE otherwise


Method delParentEntity()

Deletes parent entity

Usage
ISOExtendedElementInformation$delParentEntity(entity)
Arguments
entity

parent entity

Returns

TRUE if deleted, FALSE otherwise


Method setRule()

Set rule

Usage
ISOExtendedElementInformation$setRule(rule, locales = NULL)
Arguments
rule

rule

locales

list of localized rules. Default is NULL


Method addRationale()

Adds rationale

Usage
ISOExtendedElementInformation$addRationale(rationale, locales = NULL)
Arguments
rationale

rationale

locales

list of localized rationales. Default is NULL

Returns

TRUE if added, FALSE otherwise


Method delRationale()

Deletes rationale

Usage
ISOExtendedElementInformation$delRationale(rationale, locales = NULL)
Arguments
rationale

rationale

locales

list of localized rationales. Default is NULL

Returns

TRUE if deleted, FALSE otherwise


Method addSource()

Adds source

Usage
ISOExtendedElementInformation$addSource(source)
Arguments
source

source, object of class ISOResponsibleParty

Returns

TRUE if added, FALSE otherwise


Method delSource()

Deletes source

Usage
ISOExtendedElementInformation$delSource(source)
Arguments
source

source, object of class ISOResponsibleParty

Returns

TRUE if deleted, FALSE otherwise


Method clone()

The objects of this class are cloneable with this method.

Usage
ISOExtendedElementInformation$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Emmanuel Blondel <emmanuel.blondel1@gmail.com>

References

ISO 19115:2003 - Geographic information – Metadata

Examples

  md <- ISOExtendedElementInformation$new()
  md$setName("name")
  md$setShortName("shortName")
  md$setDomainCode(1L)
  md$setDefinition("some definition")
  md$setObligation("mandatory")
  md$setCondition("no condition")
  md$setDatatype("characterString")
  md$setMaximumOccurrence("string")
  md$setDomainValue("value")
  md$addParentEntity("none")
  md$setRule("rule")
  md$addRationale("rationale")
  
  #adding a source
  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$addSource(rp)
  
  xml <- md$encode()
  

geometa documentation built on May 29, 2024, 10:31 a.m.