ISODataIdentification: ISODataIdentification
In eblondel/geometa: Tools for Reading and Writing ISO/OGC Geographic Metadata
ISODataIdentification R Documentation
ISODataIdentification
Description
ISODataIdentification
ISODataIdentification
Format
R6Class object.
Value
Object of R6Class for modelling an ISO DataIdentification
Super classes
geometa::geometaLogger -> geometa::ISOAbstractObject -> geometa::ISOIdentification -> ISODataIdentification
Public fields
spatialRepresentationTypespatialRepresentationType [0..*]: ISOSpatialRepresentationType
spatialResolutionspatialResolution [0..*]: ISOResolution
languagelanguage [1..*]: character
characterSetcharacterSet [0..*]: ISOCharacterSet
topicCategorytopicCategory [0..*]: ISOTopicCategory
extentextent [0..*]: ISOExtent
supplementalInformationsupplementalInformation
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
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()geometa::ISOIdentification$addAggregateInformation()geometa::ISOIdentification$addCredit()geometa::ISOIdentification$addFormat()geometa::ISOIdentification$addGraphicOverview()geometa::ISOIdentification$addKeywords()geometa::ISOIdentification$addPointOfContact()geometa::ISOIdentification$addResourceConstraints()geometa::ISOIdentification$addResourceMaintenance()geometa::ISOIdentification$addResourceSpecificUsage()geometa::ISOIdentification$addStatus()geometa::ISOIdentification$delAggregateInformation()geometa::ISOIdentification$delCredit()geometa::ISOIdentification$delFormat()geometa::ISOIdentification$delGraphicOverview()geometa::ISOIdentification$delKeywords()geometa::ISOIdentification$delPointOfContact()geometa::ISOIdentification$delResourceConstraints()geometa::ISOIdentification$delResourceMaintenance()geometa::ISOIdentification$delResourceSpecificUsage()geometa::ISOIdentification$delStatus()geometa::ISOIdentification$setAbstract()geometa::ISOIdentification$setCitation()geometa::ISOIdentification$setGraphicOverview()geometa::ISOIdentification$setKeywords()geometa::ISOIdentification$setPurpose()geometa::ISOIdentification$setResourceConstraints()geometa::ISOIdentification$setResourceMaintenance()
Method new()
Initializes object
Usage
ISODataIdentification$new(xml = NULL)
Arguments
xmlobject of class XMLInternalNode-class
Method addSpatialRepresentationType()
Adds spatial representation type
Usage
ISODataIdentification$addSpatialRepresentationType(spatialRepresentationType)
Arguments
spatialRepresentationTypeobject of class ISOSpatialRepresentationType or
any character among values returned by ISOSpatialRepresentationType$values()
Returns
TRUE if added, FALSE otherwise
Method setSpatialRepresentationType()
Sets spatial representation type
Usage
ISODataIdentification$setSpatialRepresentationType(spatialRepresentationType)
Arguments
spatialRepresentationTypeobject of class ISOSpatialRepresentationType or
any character among values returned by ISOSpatialRepresentationType$values()
Returns
TRUE if added, FALSE otherwise
Method delSpatialRepresentationType()
Deletes spatial representation type
Usage
ISODataIdentification$delSpatialRepresentationType(spatialRepresentationType)
Arguments
spatialRepresentationTypeobject of class ISOSpatialRepresentationType or
any character among values returned by ISOSpatialRepresentationType$values()
Returns
TRUE if deleted, FALSE otherwise
Method addSpatialResolution()
Adds spatial resolution
Usage
ISODataIdentification$addSpatialResolution(resolution)
Arguments
resolutionobject of class ISOResolution
Returns
TRUE if added, FALSE otherwise
Method delSpatialResolution()
Deletes spatial resolution
Usage
ISODataIdentification$delSpatialResolution(resolution)
Arguments
resolutionobject of class ISOResolution
Returns
TRUE if deleted, FALSE otherwise
Method addLanguage()
Adds language
Usage
ISODataIdentification$addLanguage(locale)
Arguments
localeobject of class ISOLanguage or any character
value among those returned by ISOLanguage$values()
Returns
TRUE if added, FALSE otherwise
Method setLanguage()
Sets language
Usage
ISODataIdentification$setLanguage(locale)
Arguments
localeobject of class ISOLanguage or any character
value among those returned by ISOLanguage$values()
Returns
TRUE if added, FALSE otherwise
Method delLanguage()
Deletes language
Usage
ISODataIdentification$delLanguage(locale)
Arguments
localeobject of class ISOLanguage or any character
value among those returned by ISOLanguage$values()
Returns
TRUE if deleted, FALSE otherwise
Method addCharacterSet()
Adds character set
Usage
ISODataIdentification$addCharacterSet(charset)
Arguments
charsetobject of class ISOCharacterSet or any character
value among those returned by ISOCharacterSet$values()
Returns
TRUE if added, FALSE otherwise
Method setCharacterSet()
Sets character set
Usage
ISODataIdentification$setCharacterSet(charset)
Arguments
charsetobject of class ISOCharacterSet or any character
value among those returned by ISOCharacterSet$values()
Returns
TRUE if added, FALSE otherwise
Method delCharacterSet()
Deletes character set
Usage
ISODataIdentification$delCharacterSet(charset)
Arguments
charsetobject of class ISOCharacterSet or any character
value among those returned by ISOCharacterSet$values()
Returns
TRUE if deleted, FALSE otherwise
Method addTopicCategory()
Adds topic category
Usage
ISODataIdentification$addTopicCategory(topicCategory)
Arguments
topicCategoryobject of class ISOTopicCategory or any character
value among those returned by ISOTopicCategory$values()
Returns
TRUE if added, FALSE otherwise
Method setTopicCategory()
Sets topic category
Usage
ISODataIdentification$setTopicCategory(topicCategory)
Arguments
topicCategoryobject of class ISOTopicCategory or any character
value topicCategory those returned by ISOTopicCategory$values()
Returns
TRUE if added, FALSE otherwise
Method delTopicCategory()
Deletes topic category
Usage
ISODataIdentification$delTopicCategory(topicCategory)
Arguments
topicCategoryobject of class ISOTopicCategory or any character
value among those returned by ISOTopicCategory$values()
Returns
TRUE if deleted, FALSE otherwise
Method addExtent()
Adds extent
Usage
ISODataIdentification$addExtent(extent)
Arguments
extentobject of class ISOExtent
Returns
TRUE if added, FALSE otherwise
Method setExtent()
Sets extent
Usage
ISODataIdentification$setExtent(extent)
Arguments
extentobject of class ISOExtent
Returns
TRUE if added, FALSE otherwise
Method delExtent()
Deletes extent
Usage
ISODataIdentification$delExtent(extent)
Arguments
extentobject of class ISOExtent
Returns
TRUE if deleted, FALSE otherwise
Method setSupplementalInformation()
Set supplemental information
Usage
ISODataIdentification$setSupplementalInformation(
supplementalInformation,
locales = NULL
)
Arguments
supplementalInformationsupplemental information
localesa list of localized information. Default is NULL
Method clone()
The objects of this class are cloneable with this method.
Usage
ISODataIdentification$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
References
- ISO 19139 https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_MD_DataIdentification
- ISO 19115-3 https://schemas.isotc211.org/19115/-3/mri/1.0/mri/#element_MD_DataIdentification
Examples
#create dataIdentification
md <- ISODataIdentification$new()
md$setAbstract("abstract")
md$setPurpose("purpose")
md$addLanguage("eng")
md$addCharacterSet("utf8")
md$addTopicCategory("biota")
md$addTopicCategory("oceans")
#adding a point of contact
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$addPointOfContact(rp)
#citation
ct <- ISOCitation$new()
ct$setTitle("sometitle")
d <- ISODate$new()
d$setDate(ISOdate(2015, 1, 1, 1))
d$setDateType("publication")
ct$addDate(d)
ct$setEdition("1.0")
ct$setEditionDate(ISOdate(2015, 1, 1, 1))
ct$addIdentifier(ISOMetaIdentifier$new(code = "identifier"))
ct$addPresentationForm("mapDigital")
ct$addCitedResponsibleParty(rp)
md$setCitation(ct)
#graphic overview
go <- ISOBrowseGraphic$new(
fileName = "http://wwww.somefile.org/png",
fileDescription = "Map Overview",
fileType = "image/png"
)
md$addGraphicOverview(go)
#maintenance information
mi <- ISOMaintenanceInformation$new()
mi$setMaintenanceFrequency("daily")
md$addResourceMaintenance(mi)
#adding legal constraints
lc <- ISOLegalConstraints$new()
lc$addUseLimitation("limitation1")
lc$addUseLimitation("limitation2")
lc$addUseLimitation("limitation3")
lc$addAccessConstraint("copyright")
lc$addAccessConstraint("license")
lc$addUseConstraint("copyright")
lc$addUseConstraint("license")
md$addResourceConstraints(lc)
#adding extent
extent <- ISOExtent$new()
bbox <- ISOGeographicBoundingBox$new(minx = -180, miny = -90, maxx = 180, maxy = 90)
extent$addGeographicElement(bbox)
md$addExtent(extent)
#add keywords
kwds <- ISOKeywords$new()
kwds$addKeyword("keyword1")
kwds$addKeyword("keyword2")
kwds$setKeywordType("theme")
th <- ISOCitation$new()
th$setTitle("General")
th$addDate(d)
kwds$setThesaurusName(th)
md$addKeywords(kwds)
#supplementalInformation
md$setSupplementalInformation("some additional information")
xml <- md$encode()
eblondel/geometa documentation built on Oct. 10, 2024, 4:46 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| ISODataIdentification | R Documentation |
ISODataIdentification
Description
ISODataIdentification
ISODataIdentification
Format
R6Class object.
Value
Object of R6Class for modelling an ISO DataIdentification
Super classes
geometa::geometaLogger -> geometa::ISOAbstractObject -> geometa::ISOIdentification -> ISODataIdentification
Public fields
spatialRepresentationTypespatialRepresentationType [0..*]: ISOSpatialRepresentationType
spatialResolutionspatialResolution [0..*]: ISOResolution
languagelanguage [1..*]: character
characterSetcharacterSet [0..*]: ISOCharacterSet
topicCategorytopicCategory [0..*]: ISOTopicCategory
extentextent [0..*]: ISOExtent
supplementalInformationsupplementalInformation
Methods
Public methods
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()geometa::ISOIdentification$addAggregateInformation()geometa::ISOIdentification$addCredit()geometa::ISOIdentification$addFormat()geometa::ISOIdentification$addGraphicOverview()geometa::ISOIdentification$addKeywords()geometa::ISOIdentification$addPointOfContact()geometa::ISOIdentification$addResourceConstraints()geometa::ISOIdentification$addResourceMaintenance()geometa::ISOIdentification$addResourceSpecificUsage()geometa::ISOIdentification$addStatus()geometa::ISOIdentification$delAggregateInformation()geometa::ISOIdentification$delCredit()geometa::ISOIdentification$delFormat()geometa::ISOIdentification$delGraphicOverview()geometa::ISOIdentification$delKeywords()geometa::ISOIdentification$delPointOfContact()geometa::ISOIdentification$delResourceConstraints()geometa::ISOIdentification$delResourceMaintenance()geometa::ISOIdentification$delResourceSpecificUsage()geometa::ISOIdentification$delStatus()geometa::ISOIdentification$setAbstract()geometa::ISOIdentification$setCitation()geometa::ISOIdentification$setGraphicOverview()geometa::ISOIdentification$setKeywords()geometa::ISOIdentification$setPurpose()geometa::ISOIdentification$setResourceConstraints()geometa::ISOIdentification$setResourceMaintenance()
Method new()
Initializes object
Usage
ISODataIdentification$new(xml = NULL)
Arguments
xmlobject of class XMLInternalNode-class
Method addSpatialRepresentationType()
Adds spatial representation type
Usage
ISODataIdentification$addSpatialRepresentationType(spatialRepresentationType)
Arguments
spatialRepresentationTypeobject of class ISOSpatialRepresentationType or any character among values returned by
ISOSpatialRepresentationType$values()
Returns
TRUE if added, FALSE otherwise
Method setSpatialRepresentationType()
Sets spatial representation type
Usage
ISODataIdentification$setSpatialRepresentationType(spatialRepresentationType)
Arguments
spatialRepresentationTypeobject of class ISOSpatialRepresentationType or any character among values returned by
ISOSpatialRepresentationType$values()
Returns
TRUE if added, FALSE otherwise
Method delSpatialRepresentationType()
Deletes spatial representation type
Usage
ISODataIdentification$delSpatialRepresentationType(spatialRepresentationType)
Arguments
spatialRepresentationTypeobject of class ISOSpatialRepresentationType or any character among values returned by
ISOSpatialRepresentationType$values()
Returns
TRUE if deleted, FALSE otherwise
Method addSpatialResolution()
Adds spatial resolution
Usage
ISODataIdentification$addSpatialResolution(resolution)
Arguments
resolutionobject of class ISOResolution
Returns
TRUE if added, FALSE otherwise
Method delSpatialResolution()
Deletes spatial resolution
Usage
ISODataIdentification$delSpatialResolution(resolution)
Arguments
resolutionobject of class ISOResolution
Returns
TRUE if deleted, FALSE otherwise
Method addLanguage()
Adds language
Usage
ISODataIdentification$addLanguage(locale)
Arguments
localeobject of class ISOLanguage or any character value among those returned by
ISOLanguage$values()
Returns
TRUE if added, FALSE otherwise
Method setLanguage()
Sets language
Usage
ISODataIdentification$setLanguage(locale)
Arguments
localeobject of class ISOLanguage or any character value among those returned by
ISOLanguage$values()
Returns
TRUE if added, FALSE otherwise
Method delLanguage()
Deletes language
Usage
ISODataIdentification$delLanguage(locale)
Arguments
localeobject of class ISOLanguage or any character value among those returned by
ISOLanguage$values()
Returns
TRUE if deleted, FALSE otherwise
Method addCharacterSet()
Adds character set
Usage
ISODataIdentification$addCharacterSet(charset)
Arguments
charsetobject of class ISOCharacterSet or any character value among those returned by
ISOCharacterSet$values()
Returns
TRUE if added, FALSE otherwise
Method setCharacterSet()
Sets character set
Usage
ISODataIdentification$setCharacterSet(charset)
Arguments
charsetobject of class ISOCharacterSet or any character value among those returned by
ISOCharacterSet$values()
Returns
TRUE if added, FALSE otherwise
Method delCharacterSet()
Deletes character set
Usage
ISODataIdentification$delCharacterSet(charset)
Arguments
charsetobject of class ISOCharacterSet or any character value among those returned by
ISOCharacterSet$values()
Returns
TRUE if deleted, FALSE otherwise
Method addTopicCategory()
Adds topic category
Usage
ISODataIdentification$addTopicCategory(topicCategory)
Arguments
topicCategoryobject of class ISOTopicCategory or any character value among those returned by
ISOTopicCategory$values()
Returns
TRUE if added, FALSE otherwise
Method setTopicCategory()
Sets topic category
Usage
ISODataIdentification$setTopicCategory(topicCategory)
Arguments
topicCategoryobject of class ISOTopicCategory or any character value topicCategory those returned by
ISOTopicCategory$values()
Returns
TRUE if added, FALSE otherwise
Method delTopicCategory()
Deletes topic category
Usage
ISODataIdentification$delTopicCategory(topicCategory)
Arguments
topicCategoryobject of class ISOTopicCategory or any character value among those returned by
ISOTopicCategory$values()
Returns
TRUE if deleted, FALSE otherwise
Method addExtent()
Adds extent
Usage
ISODataIdentification$addExtent(extent)
Arguments
extentobject of class ISOExtent
Returns
TRUE if added, FALSE otherwise
Method setExtent()
Sets extent
Usage
ISODataIdentification$setExtent(extent)
Arguments
extentobject of class ISOExtent
Returns
TRUE if added, FALSE otherwise
Method delExtent()
Deletes extent
Usage
ISODataIdentification$delExtent(extent)
Arguments
extentobject of class ISOExtent
Returns
TRUE if deleted, FALSE otherwise
Method setSupplementalInformation()
Set supplemental information
Usage
ISODataIdentification$setSupplementalInformation( supplementalInformation, locales = NULL )
Arguments
supplementalInformationsupplemental information
localesa list of localized information. Default is
NULL
Method clone()
The objects of this class are cloneable with this method.
Usage
ISODataIdentification$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
References
- ISO 19139 https://schemas.isotc211.org/19139/-/gmd/1.0/gmd/#element_MD_DataIdentification
- ISO 19115-3 https://schemas.isotc211.org/19115/-3/mri/1.0/mri/#element_MD_DataIdentification
Examples
#create dataIdentification
md <- ISODataIdentification$new()
md$setAbstract("abstract")
md$setPurpose("purpose")
md$addLanguage("eng")
md$addCharacterSet("utf8")
md$addTopicCategory("biota")
md$addTopicCategory("oceans")
#adding a point of contact
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$addPointOfContact(rp)
#citation
ct <- ISOCitation$new()
ct$setTitle("sometitle")
d <- ISODate$new()
d$setDate(ISOdate(2015, 1, 1, 1))
d$setDateType("publication")
ct$addDate(d)
ct$setEdition("1.0")
ct$setEditionDate(ISOdate(2015, 1, 1, 1))
ct$addIdentifier(ISOMetaIdentifier$new(code = "identifier"))
ct$addPresentationForm("mapDigital")
ct$addCitedResponsibleParty(rp)
md$setCitation(ct)
#graphic overview
go <- ISOBrowseGraphic$new(
fileName = "http://wwww.somefile.org/png",
fileDescription = "Map Overview",
fileType = "image/png"
)
md$addGraphicOverview(go)
#maintenance information
mi <- ISOMaintenanceInformation$new()
mi$setMaintenanceFrequency("daily")
md$addResourceMaintenance(mi)
#adding legal constraints
lc <- ISOLegalConstraints$new()
lc$addUseLimitation("limitation1")
lc$addUseLimitation("limitation2")
lc$addUseLimitation("limitation3")
lc$addAccessConstraint("copyright")
lc$addAccessConstraint("license")
lc$addUseConstraint("copyright")
lc$addUseConstraint("license")
md$addResourceConstraints(lc)
#adding extent
extent <- ISOExtent$new()
bbox <- ISOGeographicBoundingBox$new(minx = -180, miny = -90, maxx = 180, maxy = 90)
extent$addGeographicElement(bbox)
md$addExtent(extent)
#add keywords
kwds <- ISOKeywords$new()
kwds$addKeyword("keyword1")
kwds$addKeyword("keyword2")
kwds$setKeywordType("theme")
th <- ISOCitation$new()
th$setTitle("General")
th$addDate(d)
kwds$setThesaurusName(th)
md$addKeywords(kwds)
#supplementalInformation
md$setSupplementalInformation("some additional information")
xml <- md$encode()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.