1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Class-SDMXCodelist.R, R/SDMXCodelist-methods.R
\docType{class}
\name{SDMXCodelist}
\alias{SDMXCodelist}
\alias{SDMXCodelist-class}
\alias{SDMXCodelist,SDMXCodelist-method}
\title{Class "SDMXCodelist"}
\usage{
SDMXCodelist(xmlObj, namespaces)
}
\arguments{
\item{xmlObj}{object of class "XMLInternalDocument derived from XML package}
\item{namespaces}{object of class "data.frame" given the list of namespace URIs}
}
\value{
an object of class "SDMXCodelist"
}
\description{
A basic class to handle a SDMX Codelist
}
\section{Slots}{
\describe{
\item{\code{id}}{Object of class "character" giving the ID of the codelist (required)}
\item{\code{agencyID}}{Object of class "character" giving the AgencyID}
\item{\code{version}}{Object of class "character" giving the version}
\item{\code{uri}}{Object of class "character" giving the codelist uri}
\item{\code{urn}}{Object of class "character" giving the codelist urn}
\item{\code{isExternalReference}}{Object of class "logical" indicating if the codelist is an external reference}
\item{\code{isFinal}}{Object of class "logical" indicating if the codelist is final}
\item{\code{validFrom}}{Object of class "character" indicating the start validity period}
\item{\code{validTo}}{Object of class "character" indicating the end validity period}
\item{\code{Name}}{Object of class "list" giving the codelist (by language) - required}
\item{\code{Description}}{Object of class "list" giving the codelist description (by language)}
\item{\code{Code}}{Object of class "list" giving the list of "SDMXCode" objects included in the codelist (see \link{SDMXCode})}
}}
\section{Warning}{
This class is not useful in itself, but all SDMX non-abstract classes will
encapsulate it as slot, when parsing an SDMX-ML document (Codelists, or DataStructureDefinition)
}
\seealso{
\link{readSDMX}
}
\author{
Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com}
}
|
