refactor ISOCodeListValue -> ISOCodeListItem to resolve Roxygen2 conf…

…lict with new class ISOCodelistValue
eblondel · Dec 31, 2024 · b453715 · b453715
1 parent 2952623
commit b453715
Show file tree

Hide file tree

Showing 108 changed files with 249 additions and 342 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -166,7 +166,7 @@ export(ISOCitationSeries)
 export(ISOClassification)
 export(ISOCodeDefinition)
 export(ISOCodeListDictionary)
-export(ISOCodeListValue)
+export(ISOCodeListItem)
 export(ISOCodelist)
 export(ISOCodelistCatalogue)
 export(ISOCodelistValue)

diff --git a/R/ISOAbstractObject.R b/R/ISOAbstractObject.R
@@ -302,7 +302,7 @@ ISOAbstractObject <- R6Class("ISOAbstractObject",
       })]
 
       if(!inherits(self, "GMLElement") && !inherits(self, "SWEElement")) cat(crayon::white(paste0("<", crayon::underline(self$getClassName()), ">")))
-      if(is(self, "ISOCodeListValue")){
+      if(is(self, "ISOCodeListItem")){
         clVal <- self$printAttrs$codeListValue
         if("value" %in% names(clVal)) clVal = clVal$value
         clDes <- self$codelistId$codeEntry[sapply(self$codelistId$codeEntry, function(ce){
@@ -361,7 +361,7 @@ ISOAbstractObject <- R6Class("ISOAbstractObject",
                 }
                 cat(paste0("\n", paste(rep(shift, depth), collapse=""),"|-- ", crayon::italic(field), " ", attrs_str))
                 item$print(depth = depth+1, add_codelist_description = add_codelist_description)
-                if(is(item, "ISOCodeListValue")){
+                if(is(item, "ISOCodeListItem")){
                   clVal <- item$printAttrs$codeListValue
                   clDes <- item$codelistId$entries[item$codelistId$entries$value == clVal,"description"]
                   cat(paste0(": ", clVal, if(add_codelist_description) crayon::cyan(paste0(" {",clDes,"}")) else ""))
@@ -1512,7 +1512,7 @@ ISOAbstractObject$getISOClasses = function(extended = FALSE, pretty = FALSE){
     if(r6Predicate){
       if(!is.null(clazz$classname)){
         includePredicate <- !(clazz$classname %in% c("geometaLogger", "INSPIREMetadataValidator",
-          "ISOCodelist", "ISOCodeListValue", "ISOMetadataNamespace", "ISOTimePeriod","ISOAttributes",
+          "ISOCodelist", "ISOCodeListItem", "ISOMetadataNamespace", "ISOTimePeriod","ISOAttributes",
           "pivot_format"))
       }
     }

diff --git a/R/ISOAssociationType.R b/R/ISOAssociationType.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOAssociationType <- R6Class("ISOAssociationType",
-    inherit = ISOCodeListValue,
+    inherit = ISOCodeListItem,
     private = list(
       xmlElement = "DS_AssociationTypeCode",
       xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISOAssociationType <- R6Class("ISOAssociationType",
 )
 
 ISOAssociationType$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOAssociationType, labels))
+  return(ISOCodeListItem$values(ISOAssociationType, labels))
 }
diff --git a/R/ISOCellGeometry.R b/R/ISOCellGeometry.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOCellGeometry <- R6Class("ISOCellGeometry",
-    inherit = ISOCodeListValue,
+    inherit = ISOCodeListItem,
     private = list(
       xmlElement = "MD_CellGeometryCode",
       xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISOCellGeometry <- R6Class("ISOCellGeometry",
 )
 
 ISOCellGeometry$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOCellGeometry, labels))
+  return(ISOCodeListItem$values(ISOCellGeometry, labels))
 }
diff --git a/R/ISOCharacterSet.R b/R/ISOCharacterSet.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOCharacterSet <- R6Class("ISOCharacterSet",
- inherit = ISOCodeListValue,
+ inherit = ISOCodeListItem,
  private = list(
    xmlElement = "MD_CharacterSetCode",
    xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISOCharacterSet <- R6Class("ISOCharacterSet",
 )
 
 ISOCharacterSet$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOCharacterSet, labels))
+  return(ISOCodeListItem$values(ISOCharacterSet, labels))
 }
diff --git a/R/ISOClassification.R b/R/ISOClassification.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOClassification <- R6Class("ISOClassification",
-   inherit = ISOCodeListValue,
+   inherit = ISOCodeListItem,
    private = list(
      xmlElement = "MD_ClassificationCode",
      xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISOClassification <- R6Class("ISOClassification",
 )
 
 ISOClassification$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOClassification, labels))
+  return(ISOCodeListItem$values(ISOClassification, labels))
 }
diff --git a/R/ISOCodeListValue.R → R/ISOCodeListItem.R b/R/ISOCodeListValue.R → R/ISOCodeListItem.R
@@ -1,10 +1,10 @@
-#' ISOCodeListValue
+#' @name ISOCodeListItem
 #'
 #' @docType class
 #' @importFrom R6 R6Class
 #' @export
-#' @keywords ISO code element
-#' @return Object of \code{\link[R6]{R6Class}} for modelling an ISO Metadata codelist element
+#' @keywords ISO code list item
+#' @return Object of \code{\link[R6]{R6Class}} for modelling an ISO Metadata codelist item
 #' @format \code{\link[R6]{R6Class}} object.
 #' 
 #' @note Abstract ISO codelist class used internally by geometa
@@ -14,11 +14,11 @@
 #' 
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
-ISOCodeListValue <- R6Class("ISOCodeListValue",
+ISOCodeListItem <- R6Class("ISOCodeListItem",
    inherit = ISOAbstractObject,
    private = list(
       printAttrs = list(),
-      xmlElement = "CodeListValue",
+      xmlElement = "CodeListItem",
       xmlNamespacePrefix = "GCO"
    ),
    public = list(
@@ -31,7 +31,7 @@ ISOCodeListValue <- R6Class("ISOCodeListValue",
      #'@field valueDescription value description
      valueDescription = NULL,
 
-     #'@description Method used to instantiate an \link{ISOCodeListValue}. By default,
+     #'@description Method used to instantiate an \link{ISOCodeListItem}. By default,
      #'    \code{addCodeListAttrs = TRUE}, to add codelist atributes to root XML. The 
      #'    parameter \code{addCodeSpaceAttr = TRUE} by default, and ignored if the valueof
      #'    \code{addCodeLisAttrs} is set to \code{FALSE}. The argument \code{setValue}
@@ -154,7 +154,7 @@ ISOCodeListValue <- R6Class("ISOCodeListValue",
    )                        
 )
 
-ISOCodeListValue$values = function(class, labels = FALSE){
+ISOCodeListItem$values = function(class, labels = FALSE){
   fields <- "value"
   if(labels) fields <- c(fields, "name", "description")
   element <- class$private_fields$xmlElement

diff --git a/R/ISOCodelist.R b/R/ISOCodelist.R
@@ -172,8 +172,22 @@ ISOCodelist <- R6Class("ISOCodelist",
    )                      
 )
 
-#' setISOCodelists
+#' @name setISOCodelists
+#' @aliases setISOCodelists
+#' @title setISOCodelists
 #' @export
+#' @description \code{setISOCodelists} allows to set the list of ISO codelists
+#' registered in \pkg{geometa}
+#' 
+#' @usage setISOCodelists(version)
+#' 
+#' @param version the version of the metadata standard
+#' 
+#' @examples             
+#'   setISOCodelists(version = "19139")
+#' 
+#' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
+#
 setISOCodelists <- function(version = "19139"){
   langCL <- system.file("extdata/codelists", "ISO-639-2_utf-8.txt", package = "geometa", mustWork = TRUE) #from http://www.loc.gov/standards/iso639-2/
   ML_gmxCL <- system.file("extdata/codelists", "ML_gmxCodelists.xml", package = "geometa", mustWork = TRUE)
@@ -253,7 +267,7 @@ getISOCodelists <- function(){
     clazz <- eval(parse(text=classname))
     if(is(clazz, "R6ClassGenerator")){
       if(!is.null(clazz$inherit)){
-        if(clazz$inherit == "ISOCodeListValue"){
+        if(clazz$inherit == "ISOCodeListItem"){
           cl_classes <- c(cl_classes, clazz)
         }
       }

diff --git a/R/ISOCodelistValueNew.R b/R/ISOCodelistValueNew.R
@@ -1,4 +1,4 @@
-#' ISOCodelistValue
+#' @name ISOCodelistValue
 #'
 #' @docType class
 #' @importFrom R6 R6Class

diff --git a/R/ISOCountry.R b/R/ISOCountry.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOCountry <- R6Class("ISOCountry",
-   inherit = ISOCodeListValue,
+   inherit = ISOCodeListItem,
    private = list(
      xmlElement = list(
        "19139" = "Country",
@@ -47,5 +47,5 @@ ISOCountry <- R6Class("ISOCountry",
 )
 
 ISOCountry$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOCountry, labels))
+  return(ISOCodeListItem$values(ISOCountry, labels))
 }
diff --git a/R/ISOCouplingType.R b/R/ISOCouplingType.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOCouplingType <- R6Class("ISOCouplingType",
-   inherit = ISOCodeListValue,
+   inherit = ISOCodeListItem,
    private = list(
      xmlElement = "SV_CouplingType",
      xmlNamespacePrefix = "SRV"
@@ -41,5 +41,5 @@ ISOCouplingType <- R6Class("ISOCouplingType",
 )
 
 ISOCouplingType$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOCouplingType, labels))
+  return(ISOCodeListItem$values(ISOCouplingType, labels))
 }
diff --git a/R/ISOCoverageContentType.R b/R/ISOCoverageContentType.R
@@ -29,7 +29,7 @@
 #'   - 19115-3 \url{https://schemas.isotc211.org/19115/-3/mrc/1.0/mrc/#element_MD_CoverageContentTypeCode}
 #'
 ISOCoverageContentType <- R6Class("ISOCoverageContentType",
-    inherit = ISOCodeListValue,
+    inherit = ISOCodeListItem,
     private = list(
       xmlElement = "MD_CoverageContentTypeCode",
       xmlNamespacePrefix = list(
@@ -51,5 +51,5 @@ ISOCoverageContentType <- R6Class("ISOCoverageContentType",
 )
 
 ISOCoverageContentType$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOCoverageContentType, labels))
+  return(ISOCodeListItem$values(ISOCoverageContentType, labels))
 }
diff --git a/R/ISODCPList.R b/R/ISODCPList.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISODCPList <- R6Class("ISODCPList",
-   inherit = ISOCodeListValue,
+   inherit = ISOCodeListItem,
    private = list(
      xmlElement = "DCPList",
      xmlNamespacePrefix = "SRV"
@@ -41,5 +41,5 @@ ISODCPList <- R6Class("ISODCPList",
 )
 
 ISODCPList$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISODCPList, labels))
+  return(ISOCodeListItem$values(ISODCPList, labels))
 }
diff --git a/R/ISODatatype.R b/R/ISODatatype.R
@@ -20,7 +20,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISODatatype <- R6Class("ISODatatype",
-   inherit = ISOCodeListValue,
+   inherit = ISOCodeListItem,
    private = list(
      xmlElement = "MD_DatatypeCode",
      xmlNamespacePrefix = "GMD"
@@ -39,5 +39,5 @@ ISODatatype <- R6Class("ISODatatype",
 )
 
 ISODatatype$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISODatatype, labels))
+  return(ISOCodeListItem$values(ISODatatype, labels))
 }
diff --git a/R/ISODateType.R b/R/ISODateType.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISODateType <- R6Class("ISODateType",
-   inherit = ISOCodeListValue,
+   inherit = ISOCodeListItem,
    private = list(
      xmlElement = "CI_DateTypeCode",
      xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISODateType <- R6Class("ISODateType",
 )
 
 ISODateType$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISODateType, labels))
+  return(ISOCodeListItem$values(ISODateType, labels))
 }
diff --git a/R/ISODimensionNameType.R b/R/ISODimensionNameType.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISODimensionNameType <- R6Class("ISODimensionNameType",
-    inherit = ISOCodeListValue,
+    inherit = ISOCodeListItem,
     private = list(
       xmlElement = "MD_DimensionNameTypeCode",
       xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISODimensionNameType <- R6Class("ISODimensionNameType",
 )
 
 ISODimensionNameType$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISODimensionNameType, labels))
+  return(ISOCodeListItem$values(ISODimensionNameType, labels))
 }
diff --git a/R/ISODistributionUnits.R b/R/ISODistributionUnits.R
@@ -16,7 +16,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISODistributionUnits <- R6Class("ISODistributionUnits",
-  inherit = ISOCodeListValue,
+  inherit = ISOCodeListItem,
   private = list(
     xmlElement = "MD_DistributionUnits",
     xmlNamespacePrefix = "GMD"

diff --git a/R/ISOEvaluationMethodType.R b/R/ISOEvaluationMethodType.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOEvaluationMethodType <- R6Class("ISOEvaluationMethodType",
-  inherit = ISOCodeListValue,
+  inherit = ISOCodeListItem,
   private = list(
     xmlElement = "DQ_EvaluationMethodTypeCode",
     xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISOEvaluationMethodType <- R6Class("ISOEvaluationMethodType",
 )
 
 ISOEvaluationMethodType$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOEvaluationMethodType, labels))
+  return(ISOCodeListItem$values(ISOEvaluationMethodType, labels))
 }
diff --git a/R/ISOGeometricObjectType.R b/R/ISOGeometricObjectType.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOGeometricObjectType <- R6Class("ISOGeometricObjectType",
-  inherit = ISOCodeListValue,
+  inherit = ISOCodeListItem,
   private = list(
     xmlElement = "MD_GeometricObjectTypeCode",
     xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISOGeometricObjectType <- R6Class("ISOGeometricObjectType",
 )
 
 ISOGeometricObjectType$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOGeometricObjectType, labels))
+  return(ISOCodeListItem$values(ISOGeometricObjectType, labels))
 }
diff --git a/R/ISOImageryBandDefinition.R b/R/ISOImageryBandDefinition.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOImageryBandDefinition <- R6Class("ISOImageryBandDefinition",
-    inherit = ISOCodeListValue,
+    inherit = ISOCodeListItem,
     private = list(
       xmlElement = "MI_BandDefinition",
       xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISOImageryBandDefinition <- R6Class("ISOImageryBandDefinition",
 )
 
 ISOImageryBandDefinition$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOImageryBandDefinition, labels))
+  return(ISOCodeListItem$values(ISOImageryBandDefinition, labels))
 }
diff --git a/R/ISOImageryContext.R b/R/ISOImageryContext.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOImageryContext <- R6Class("ISOImageryContext",
-  inherit = ISOCodeListValue,
+  inherit = ISOCodeListItem,
   private = list(
     xmlElement = "MI_ContextCode",
     xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISOImageryContext <- R6Class("ISOImageryContext",
 )
 
 ISOImageryContext$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOImageryContext, labels))
+  return(ISOCodeListItem$values(ISOImageryContext, labels))
 }
diff --git a/R/ISOImageryGeometryType.R b/R/ISOImageryGeometryType.R
@@ -22,7 +22,7 @@
 #' @author Emmanuel Blondel <emmanuel.blondel1@@gmail.com>
 #'
 ISOImageryGeometryType <- R6Class("ISOImageryGeometryType",
-   inherit = ISOCodeListValue,
+   inherit = ISOCodeListItem,
    private = list(
      xmlElement = "MI_GeometryTypeCode",
      xmlNamespacePrefix = list(
@@ -44,5 +44,5 @@ ISOImageryGeometryType <- R6Class("ISOImageryGeometryType",
 )
 
 ISOImageryGeometryType$values <- function(labels = FALSE){
-  return(ISOCodeListValue$values(ISOImageryGeometryType, labels))
+  return(ISOCodeListItem$values(ISOImageryGeometryType, labels))
 }