R/Class-SDMXStructureType.R

In opensdmx/rsdmx: Tools for Reading SDMX Data and Metadata

#' @name SDMXStructureType
#' @docType class
#' @aliases SDMXStructureType-class
#' 
#' @title Class "SDMXStructureType"
#' @description A basic class to handle the type of a SDMX-ML Structure document
#' 
#' @section Warning:
#' This class is not useful in itself, but it will be used by \link{readSDMX} to
#' deal with SDMX-ML Structure documents.
#'    
#' @author Emmanuel Blondel, \email{emmanuel.blondel1@@gmail.com}
#'
setClassUnion("character_OR_NULL", c("character", "NULL"))
setClass("SDMXStructureType",
         contains = "SDMXType",
         representation(subtype = "character_OR_NULL"),
         prototype = list(),
         validity = function(object){
           
           #validation rules
           if(.rsdmx.options$validate){
             type <- getStructureType(object);
             #consider NULL type as valid in case of SDMXData with no structure embedded
             if(!is.null(type)){
               valid <- switch(type,
                               "DataflowsType" = TRUE,
                               "ConceptsType" = TRUE,
                               "CodelistsType" = TRUE,
                               "DataStructuresType" = TRUE,
                               "DataStructureDefinitionsType" = TRUE,
                               FALSE
               );
               if(valid == FALSE)
                 warning(paste0("Unknown SDMXStructureType '", type, "'"));
               
               return(valid);
             }
           }
           
           return(TRUE);
         }
)