SCM

SCM Repository

[tm] Diff of /pkg/R/corpus.R
ViewVC logotype

Diff of /pkg/R/corpus.R

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

trunk/R/textmin/R/textdoccol.R revision 52, Sat Aug 12 12:43:39 2006 UTC trunk/tm/R/textdoccol.R revision 744, Mon Apr 23 00:35:10 2007 UTC
# Line 1  Line 1 
1  # Author: Ingo Feinerer  # Author: Ingo Feinerer
2    
3  setGeneric("TextDocCol", function(object, inputType = "CSV", stripWhiteSpace = FALSE, toLower = FALSE) standardGeneric("TextDocCol"))  # The "..." are additional arguments for the FunctionGenerator reader
4    setGeneric("TextDocCol", function(object,
5                                      readerControl = list(reader = object@DefaultReader, language = "en_US", load = FALSE),
6                                      dbControl = list(useDb = FALSE, dbName = "", dbType = "DB1"),
7                                      ...) standardGeneric("TextDocCol"))
8  setMethod("TextDocCol",  setMethod("TextDocCol",
9            c("character"),            signature(object = "Source"),
10            function(object, inputType = "CSV", stripWhiteSpace = FALSE, toLower = FALSE) {            function(object,
11                # Add a new type for each unique input source format                     readerControl = list(reader = object@DefaultReader, language = "en_US", load = FALSE),
12                type <- match.arg(inputType,c("CSV", "RCV1", "REUT21578", "REUT21578_XML", "RIS"))                     dbControl = list(useDb = FALSE, dbName = "", dbType = "DB1"),
13                switch(type,                     ...) {
14                       # Text in a special CSV format                if (attr(readerControl$reader, "FunctionGenerator"))
15                       # For details on the file format see the R documentation file                    readerControl$reader <- readerControl$reader(...)
16                       # The first argument is a directory with .csv files  
17                       "CSV" = {                if (dbControl$useDb) {
18                           filelist <- dir(object, pattern = ".csv", full.names = TRUE)                    if (!dbCreate(dbControl$dbName, dbControl$dbType))
19                           tdl <- sapply(filelist,                        stop("error in creating database")
20                                         function(file) {                    db <- dbInit(dbControl$dbName, dbControl$dbType)
21                                             m <- as.matrix(read.csv(file, header = FALSE))                }
22                                             l <- vector("list", dim(m)[1])  
23                                             for (i in 1:dim(m)[1]) {                tdl <- list()
24                                                 author <- ""                counter <- 1
25                                                 datetimestamp <- date()                while (!eoi(object)) {
26                                                 description <- ""                    object <- stepNext(object)
27                                                 id <- as.integer(m[i,1])                    elem <- getElem(object)
28                                                 corpus <- as.character(m[i,2:dim(m)[2]])                    # If there is no Load on Demand support
29                                                 if (stripWhiteSpace)                    # we need to load the corpus into memory at startup
30                                                     corpus <- gsub("[[:space:]]+", " ", corpus)                    if (!object@LoDSupport)
31                                                 if (toLower)                        readerControl$load <- TRUE
32                                                     corpus <- tolower(corpus)                    doc <- readerControl$reader(elem, readerControl$load, readerControl$language, as.character(counter))
33                                                 origin <- "CSV"                    if (dbControl$useDb) {
34                                                 heading <- ""                        dbInsert(db, ID(doc), doc)
35                          tdl <- c(tdl, ID(doc))
36                                                 l[[i]] <- new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,                    }
37                                                               Description = description, ID = id, Origin = origin, Heading = heading)                    else
38                                             }                        tdl <- c(tdl, list(doc))
39                                             l                    counter <- counter + 1
40                                         })                }
41                           if (length(filelist) > 1)  
42                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))                df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)
43                           else                if (dbControl$useDb) {
44                               tdcl <- new("TextDocCol", .Data = tdl)                    dbInsert(db, "DMetaData", df)
45                       },                    dmeta.df <- data.frame(key = "DMetaData", subset = I(list(NA)))
46                       # Read in text documents in XML Reuters Corpus Volume 1 (RCV1) format                    dbDisconnect(db)
47                       # The first argument is a directory with the RCV1 XML files                }
48                       "RCV1" = {                else
49                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)                    dmeta.df <- df
50                           tdl <- sapply(filelist,  
51                                         function(file) {                cmeta.node <- new("MetaDataNode",
52                                             tree <- xmlTreeParse(file)                              NodeID = 0,
53                                             xmlApply(xmlRoot(tree), parseNewsItemPlain, stripWhiteSpace, toLower)                              MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
54                                         })                              children = list())
55                           if (length(filelist) > 1)  
56                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))                return(new("TextDocCol", .Data = tdl, DMetaData = dmeta.df, CMetaData = cmeta.node, DBControl = dbControl))
57                           else            })
58                               tdcl <- new("TextDocCol", .Data = tdl)  
59                       },  setGeneric("loadDoc", function(object, ...) standardGeneric("loadDoc"))
60                       # Read in text documents in Reuters-21578 XML (not SGML) format  setMethod("loadDoc",
61                       # Typically the first argument will be a directory where we can            signature(object = "PlainTextDocument"),
62                       # find the files reut2-000.xml ... reut2-021.xml            function(object, ...) {
63                       "REUT21578" = {                if (!Cached(object)) {
64                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)                    con <- eval(URI(object))
65                           tdl <- sapply(filelist,                    corpus <- readLines(con)
66                                         function(file) {                    close(con)
67                                             tree <- xmlTreeParse(file)                    Corpus(object) <- corpus
68                                             xmlApply(xmlRoot(tree), parseReutersPlain, stripWhiteSpace, toLower)                    Cached(object) <- TRUE
69                                         })                    return(object)
70                           if (length(filelist) > 1)                } else {
71                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))                    return(object)
72                           else                }
73                               tdcl <- new("TextDocCol", .Data = tdl)            })
74                       },  setMethod("loadDoc",
75                       "REUT21578_XML" = {            signature(object =  "XMLTextDocument"),
76                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)            function(object, ...) {
77                           tdl <- sapply(filelist,                if (!Cached(object)) {
78                                         function(file) {                    con <- eval(URI(object))
79                                             parseReutersXML(file)                    corpus <- paste(readLines(con), "\n", collapse = "")
80                                         })                    close(con)
81                           tdcl <- new("TextDocCol", .Data = tdl)                    doc <- xmlTreeParse(corpus, asText = TRUE)
                      },  
                      # Read in HTML documents as used by http://ris.bka.gv.at/vwgh  
                      "RIS" = {  
                          filelist <- dir(object, pattern = ".html", full.names = TRUE)  
                          tdl <- sapply(filelist,  
                                        function(file) {  
                                            # Ignore warnings from misformed HTML documents  
                                            suppressWarnings(RISDoc <- parseRISPlain(file, stripWhiteSpace, toLower))  
                                            if (!is.null(RISDoc)) {  
                                                l <- list()  
                                                l[[length(l) + 1]] <- RISDoc  
                                                l  
                                            }  
                                        })  
                          tdcl <- new("TextDocCol", .Data = tdl)  
                      })  
               tdcl  
           })  
   
 # Parse an Austrian RIS HTML document  
 parseRISPlain <- function(file, stripWhiteSpace = FALSE, toLower = FALSE) {  
     author <- ""  
     datetimestamp <- date()  
     description <- ""  
   
     tree <- htmlTreeParse(file)  
     htmlElem <- unlist(tree$children$html$children)  
   
     if (is.null(htmlElem))  
         stop(paste("Empty document", file, "cannot be processed."))  
   
     textElem <- htmlElem[which(regexpr("text.value", names(htmlElem)) > 0)]  
     names(textElem) <- NULL  
   
     corpus <- paste(textElem, collapse = " ")  
   
     year <- substring(corpus, regexpr("..../../", corpus), regexpr("..../../", corpus) + 3)  
     senat <- substring(corpus, regexpr("..../../", corpus) + 5, regexpr("..../../", corpus) + 6)  
     number <- substring(corpus, regexpr("..../../", corpus) + 8, regexpr("..../../", corpus) + 11)  
   
     id <- as.integer(paste(year, senat, number, sep = ""))  
   
     if (is.na(id))  
         stop(paste("Cannot extract 'Geschaeftszahl' out of malformed document", file))  
     origin <- ""  
   
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(corpus)  
   
     heading <- ""  
   
     new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading)  
 }  
   
 # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file  
 parseNewsItemPlain <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {  
     author <- "Not yet implemented"  
     datetimestamp <- xmlAttrs(node)[["date"]]  
     description <- "Not yet implemented"  
     id <- as.integer(xmlAttrs(node)[["itemid"]])  
     origin <- "Reuters Corpus Volume 1 XML"  
     corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)  
   
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(corpus)  
   
     heading <- xmlValue(node[["title"]])  
   
     new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading)  
 }  
   
 # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file  
 parseReutersPlain <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {  
     # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["AUTHOR"]]))  
         author <- xmlValue(node[["TEXT"]][["AUTHOR"]])  
     else  
         author <- ""  
   
     datetimestamp <- xmlValue(node[["DATE"]])  
     description <- ""  
     id <- as.integer(xmlAttrs(node)[["NEWID"]])  
   
     origin <- "Reuters-21578 XML"  
   
     # The <BODY></BODY> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["BODY"]]))  
         corpus <- xmlValue(node[["TEXT"]][["BODY"]])  
     else  
         corpus <- ""  
   
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(corpus)  
   
     # The <TITLE></TITLE> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["TITLE"]]))  
         heading <- xmlValue(node[["TEXT"]][["TITLE"]])  
     else  
         heading <- ""  
   
     topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)  
   
     new("PlainTextDocument", .Data = corpus, Cached = 1, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading, LocalMetaData = list(Topics = topics))  
 }  
   
 # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file  
 parseReutersXML<- function(file) {  
     new("XMLTextDocument", FileName = file, Cached = 0, Author = "REUTERS", DateTimeStamp = date(),  
         Description = "Reuters21578 file containing several news articles", ID = as.integer(0),  
         Origin = "Reuters-21578 XML", Heading = "Reuters21578 news articles")  
 }  
   
 setGeneric("loadFileIntoMem", function(object) standardGeneric("loadFileIntoMem"))  
 setMethod("loadFileIntoMem",  
           c("XMLTextDocument"),  
           function(object) {  
               if (object@Cached == 0) {  
                   file <- object@FileName  
                   doc <- xmlTreeParse(file)  
82                    class(doc) <- "list"                    class(doc) <- "list"
83                    object@.Data <- doc                    Corpus(object) <- doc
84                    object@Cached <- 1                    Cached(object) <- TRUE
85                    return(object)                    return(object)
86                } else {                } else {
87                    return(object)                    return(object)
88                }                }
89            })            })
90    setMethod("loadDoc",
91              signature(object = "NewsgroupDocument"),
92              function(object, ...) {
93                  if (!Cached(object)) {
94                      con <- eval(URI(object))
95                      mail <- readLines(con)
96                      close(con)
97                      Cached(object) <- TRUE
98                      for (index in seq_along(mail)) {
99                          if (mail[index] == "")
100                              break
101                      }
102                      Corpus(object) <- mail[(index + 1):length(mail)]
103                      return(object)
104                  } else {
105                      return(object)
106                  }
107              })
108    
109    setGeneric("tmUpdate", function(object,
110                                    origin,
111                                    readerControl = list(reader = origin@DefaultReader, language = "en_US", load = FALSE),
112                                    ...) standardGeneric("tmUpdate"))
113    # Update is only supported for directories
114    # At the moment no other LoD devices are available anyway
115    setMethod("tmUpdate",
116              signature(object = "TextDocCol", origin = "DirSource"),
117              function(object, origin,
118                       readerControl = list(reader = origin@DefaultReader, language = "en_US", load = FALSE),
119                       ...) {
120                  if (inherits(readerControl$reader, "FunctionGenerator"))
121                      readerControl$reader <- readerControl$reader(...)
122    
123                  object.filelist <- unlist(lapply(object, function(x) {as.character(URI(x))[2]}))
124                  new.files <- setdiff(origin@FileList, object.filelist)
125    
126                  for (filename in new.files) {
127                      elem <- list(content = readLines(filename),
128                                   uri = substitute(file(filename)))
129                      object <- appendElem(object, readerControl$reader(elem, readerControl$load, readerControl$language, filename))
130                  }
131    
132                  return(object)
133              })
134    
135  setGeneric("transformTextDocCol", function(object, FUN, ...) standardGeneric("transformTextDocCol"))  setGeneric("tmMap", function(object, FUN, ...) standardGeneric("tmMap"))
136  setMethod("transformTextDocCol",  setMethod("tmMap",
137            c("TextDocCol"),            signature(object = "TextDocCol", FUN = "function"),
138            function(object, FUN, ...) {            function(object, FUN, ...) {
139                lapply(object, FUN, ...)                result <- object
140                  # Note that text corpora are automatically loaded into memory via \code{[[}
141                  if (DBControl(object)[["useDb"]]) {
142                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
143                      i <- 1
144                      for (id in unlist(object)) {
145                          db[[id]] <- FUN(object[[i]], ..., DMetaData = DMetaData(object))
146                          i <- i + 1
147                      }
148                      dbDisconnect(db)
149                  }
150                  else
151                      result@.Data <- lapply(object, FUN, ..., DMetaData = DMetaData(object))
152                  return(result)
153            })            })
154    
155  setGeneric("toPlainTextDocument", function(object, FUN, ...) standardGeneric("toPlainTextDocument"))  setGeneric("asPlain", function(object, FUN, ...) standardGeneric("asPlain"))
156  setMethod("toPlainTextDocument",  setMethod("asPlain",
157            c("PlainTextDocument"),            signature(object = "PlainTextDocument"),
158            function(object, FUN, ...) {            function(object, FUN, ...) {
159                return(object)                return(object)
160            })            })
161  setMethod("toPlainTextDocument",  setMethod("asPlain",
162            c("XMLTextDocument"),            signature(object = "XMLTextDocument", FUN = "function"),
163            function(object, FUN, ...) {            function(object, FUN, ...) {
164                if (object@Cached == 0)                corpus <- Corpus(object)
                   object <- loadFileIntoMem(object)  
   
               corpus <- object@.Data  
165    
166                # As XMLDocument is no native S4 class, restore valid information                # As XMLDocument is no native S4 class, restore valid information
167                class(corpus) <- "XMLDocument"                class(corpus) <- "XMLDocument"
168                names(corpus) <- c("doc","dtd")                names(corpus) <- c("doc","dtd")
169    
170                return(xmlApply(xmlRoot(corpus), FUN, ...))                return(FUN(xmlRoot(corpus), ...))
171              })
172    setMethod("asPlain",
173              signature(object = "NewsgroupDocument"),
174              function(object, FUN, ...) {
175                  new("PlainTextDocument", .Data = Corpus(object), Cached = TRUE, URI = "", Author = Author(object),
176                      DateTimeStamp = DateTimeStamp(object), Description = Description(object), ID = ID(object),
177                      Origin = Origin(object), Heading = Heading(object), Language = Language(object))
178            })            })
179    
180  setGeneric("stemTextDocument", function(object) standardGeneric("stemTextDocument"))  setGeneric("tmTolower", function(object, ...) standardGeneric("tmTolower"))
181  setMethod("stemTextDocument",  setMethod("tmTolower",
182            c("PlainTextDocument"),            signature(object = "PlainTextDocument"),
183            function(object) {            function(object, ...) {
184                require(Rstem)                Corpus(object) <- tolower(object)
185                  return(object)
186              })
187    
188    setGeneric("stripWhitespace", function(object, ...) standardGeneric("stripWhitespace"))
189    setMethod("stripWhitespace",
190              signature(object = "PlainTextDocument"),
191              function(object, ...) {
192                  Corpus(object) <- gsub("[[:space:]]+", " ", object)
193                  return(object)
194              })
195    
196    setGeneric("stemDoc", function(object, language = "english", ...) standardGeneric("stemDoc"))
197    setMethod("stemDoc",
198              signature(object = "PlainTextDocument"),
199              function(object, language = "english", ...) {
200                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))
201                stemmedCorpus <- wordStem(splittedCorpus)                stemmedCorpus <- if (require("Rstem"))
202                object@.Data <- paste(stemmedCorpus, collapse = " ")                    Rstem::wordStem(splittedCorpus, language)
203                  else
204                      SnowballStemmer(splittedCorpus, Weka_control(S = language))
205                  Corpus(object) <- paste(stemmedCorpus, collapse = " ")
206                return (object)                return (object)
207            })            })
208    
209  setGeneric("removeStopWordsInTextDocument", function(object, stopwords) standardGeneric("removeStopWordsInTextDocument"))  setGeneric("removePunctuation", function(object, ...) standardGeneric("removePunctuation"))
210  setMethod("removeStopWordsInTextDocument",  setMethod("removePunctuation",
211            c("PlainTextDocument", "character"),            signature(object = "PlainTextDocument"),
212            function(object, stopwords) {            function(object, ...) {
213                require(Rstem)                Corpus(object) <- gsub("[[:punct:]]+", "", Corpus(object))
214                  return(object)
215              })
216    
217    setGeneric("removeWords", function(object, stopwords, ...) standardGeneric("removeWords"))
218    setMethod("removeWords",
219              signature(object = "PlainTextDocument", stopwords = "character"),
220              function(object, stopwords, ...) {
221                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))
222                noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]                noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]
223                object@.Data <- paste(noStopwordsCorpus, collapse = " ")                Corpus(object) <- paste(noStopwordsCorpus, collapse = " ")
224                return (object)                return (object)
225            })            })
226    
227  setGeneric("filterTextDocCol", function(object, FUN, ...) standardGeneric("filterTextDocCol"))  setGeneric("tmFilter", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmFilter"))
228  setMethod("filterTextDocCol",  setMethod("tmFilter",
229            c("TextDocCol"),            signature(object = "TextDocCol"),
230            function(object, FUN, ...) {            function(object, ..., FUN = sFilter, doclevel = FALSE) {
231                sapply(object, FUN, ...)                if (doclevel)
232                      return(object[sapply(object, FUN, ..., DMetaData = DMetaData(object))])
233                  else
234                      return(object[FUN(object, ...)])
235              })
236    
237    setGeneric("tmIndex", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmIndex"))
238    setMethod("tmIndex",
239              signature(object = "TextDocCol"),
240              function(object, ..., FUN = sFilter, doclevel = FALSE) {
241                  if (doclevel)
242                      return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))
243                  else
244                      return(FUN(object, ...))
245            })            })
246    
247  setGeneric("filterREUT21578Topics", function(object, topics, ...) standardGeneric("filterREUT21578Topics"))  sFilter <- function(object, s, ...) {
248  setMethod("filterREUT21578Topics",      con <- textConnection(s)
249            c("PlainTextDocument", "character"),      tokens <- scan(con, "character")
250            function(object, topics, ...) {      close(con)
251                if (object@Cached == 0)      localMetaNames <- unique(names(sapply(object, LocalMetaData)))
252                    object <- loadFileIntoMem(object)      localMetaTokens <- localMetaNames[localMetaNames %in% tokens]
253        n <- names(DMetaData(object))
254        tags <- c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language", localMetaTokens)
255        query.df <- DMetaData(prescindMeta(object, tags))
256        if (DBControl(object)[["useDb"]])
257            DMetaData(object) <- DMetaData(object)[, setdiff(n, tags), drop = FALSE]
258        # Rename to avoid name conflicts
259        names(query.df)[names(query.df) == "Author"] <- "author"
260        names(query.df)[names(query.df) == "DateTimeStamp"] <- "datetimestamp"
261        names(query.df)[names(query.df) == "Description"] <- "description"
262        names(query.df)[names(query.df) == "ID"] <- "identifier"
263        names(query.df)[names(query.df) == "Origin"] <- "origin"
264        names(query.df)[names(query.df) == "Heading"] <- "heading"
265        names(query.df)[names(query.df) == "Language"] <- "language"
266        attach(query.df)
267        try(result <- rownames(query.df) %in% row.names(query.df[eval(parse(text = s)), ]))
268        detach(query.df)
269        return(result)
270    }
271    
272                if (any(object@LocalMetaData$Topics %in% topics))  setGeneric("searchFullText", function(object, pattern, ...) standardGeneric("searchFullText"))
273                    return(TRUE)  setMethod("searchFullText",
274              signature(object = "PlainTextDocument", pattern = "character"),
275              function(object, pattern, ...) {
276                  return(any(grep(pattern, Corpus(object))))
277              })
278    
279    setGeneric("appendElem", function(object, data, meta = NULL) standardGeneric("appendElem"))
280    setMethod("appendElem",
281              signature(object = "TextDocCol", data = "TextDocument"),
282              function(object, data, meta = NULL) {
283                  if (DBControl(object)[["useDb"]]) {
284                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
285                      if (dbExists(db, ID(data)))
286                          warning("document with identical ID already exists")
287                      dbInsert(db, ID(data), data)
288                      dbDisconnect(db)
289                      object@.Data[[length(object)+1]] <- ID(data)
290                  }
291                else                else
292                    return(FALSE)                    object@.Data[[length(object)+1]] <- data
293                  DMetaData(object) <- rbind(DMetaData(object), c(MetaID = CMetaData(object)@NodeID, meta))
294                  return(object)
295              })
296    
297    setGeneric("appendMeta", function(object, cmeta = NULL, dmeta = NULL) standardGeneric("appendMeta"))
298    setMethod("appendMeta",
299              signature(object = "TextDocCol"),
300              function(object, cmeta = NULL, dmeta = NULL) {
301                  object@CMetaData@MetaData <- c(CMetaData(object)@MetaData, cmeta)
302                  if (!is.null(dmeta)) {
303                      DMetaData(object) <- cbind(DMetaData(object), eval(dmeta))
304                  }
305                  return(object)
306              })
307    
308    setGeneric("removeMeta", function(object, cname = NULL, dname = NULL) standardGeneric("removeMeta"))
309    setMethod("removeMeta",
310              signature(object = "TextDocCol"),
311              function(object, cname = NULL, dname = NULL) {
312                  if (!is.null(cname))
313                      object@CMetaData@MetaData <- CMetaData(object)@MetaData[names(CMetaData(object)@MetaData) != cname]
314                  if (!is.null(dname))
315                      DMetaData(object) <- DMetaData(object)[, names(DMetaData(object)) != dname, drop = FALSE]
316                  return(object)
317            })            })
318    
319  setGeneric("attachData", function(object, data) standardGeneric("attachData"))  setGeneric("prescindMeta", function(object, meta) standardGeneric("prescindMeta"))
320  setMethod("attachData",  setMethod("prescindMeta",
321            c("TextDocCol","TextDocument"),            signature(object = "TextDocCol", meta = "character"),
322            function(object, data) {            function(object, meta) {
323                data <- as(list(data), "TextDocCol")                for (m in meta) {
324                object@.Data <- as(c(object@.Data, data), "TextDocCol")                    if (m %in% c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language")) {
325                          local.m <- lapply(object, m)
326                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
327                          local.m <- unlist(local.m)
328                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
329                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
330                      }
331                      else {
332                          local.meta <- lapply(object, LocalMetaData)
333                          local.m <- lapply(local.meta, "[[", m)
334                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
335                          if (length(local.m) == length(unlist(local.m)))
336                              local.m <- unlist(local.m)
337                          else
338                              local.m <- I(local.m)
339                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
340                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
341                      }
342                  }
343                return(object)                return(object)
344            })            })
345    
346  setGeneric("attachMetaData", function(object, name, metadata) standardGeneric("attachMetaData"))  setMethod("[",
347  setMethod("attachMetaData",            signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),
348            c("TextDocCol"),            function(x, i, j, ... , drop) {
349            function(object, name, metadata) {                if(missing(i))
350                object@GlobalMetaData <- c(object@GlobalMetaData, new = list(metadata))                    return(x)
351                names(object@GlobalMetaData)[length(names(object@GlobalMetaData))] <- name  
352                  object <- x
353                  object@.Data <- x@.Data[i, ..., drop = FALSE]
354                  if (DBControl(object)[["useDb"]]) {
355                      index <- object@DMetaData[[1 , "subset"]]
356                      if (any(is.na(index)))
357                          object@DMetaData[[1 , "subset"]] <- i
358                      else
359                          object@DMetaData[[1 , "subset"]] <- index[i]
360                  }
361                  else
362                      DMetaData(object) <- DMetaData(x)[i, , drop = FALSE]
363                return(object)                return(object)
364            })            })
365    
366    setMethod("[<-",
367              signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),
368              function(x, i, j, ... , value) {
369                  object <- x
370                  if (DBControl(object)[["useDb"]]) {
371                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
372                      counter <- 1
373                      for (id in object@.Data[i, ...]) {
374                          if (length(value) == 1)
375                              db[[id]] <- value
376                          else {
377                              db[[id]] <- value[[counter]]
378                          }
379                          counter <- counter + 1
380                      }
381                      dbDisconnect(db)
382                  }
383                  else
384                      object@.Data[i, ...] <- value
385                  return(object)
386              })
387    
388    setMethod("[[",
389              signature(x = "TextDocCol", i = "ANY", j = "ANY"),
390              function(x, i, j, ...) {
391                  if (DBControl(x)[["useDb"]]) {
392                      db <- dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
393                      result <- dbFetch(db, x@.Data[[i]])
394                      dbDisconnect(db)
395                      return(loadDoc(result))
396                  }
397                  else
398                      return(loadDoc(x@.Data[[i]]))
399              })
400    
401    setMethod("[[<-",
402              signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),
403              function(x, i, j, ..., value) {
404                  object <- x
405                  if (DBControl(object)[["useDb"]]) {
406                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
407                      index <- object@.Data[[i]]
408                      db[[index]] <- value
409                      dbDisconnect(db)
410                  }
411                  else
412                      object@.Data[[i, ...]] <- value
413                  return(object)
414              })
415    
416    # Update \code{NodeID}s of a CMetaData tree
417    update_id <- function(object, id = 0, mapping = NULL, left.mapping = NULL, level = 0) {
418        # Traversal of (binary) CMetaData tree with setup of \code{NodeID}s
419        set_id <- function(object) {
420            object@NodeID <- id
421            id <<- id + 1
422            level <<- level + 1
423    
424            if (length(object@children) > 0) {
425                mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))
426                left <- set_id(object@children[[1]])
427                if (level == 1) {
428                    left.mapping <<- mapping
429                    mapping <<- NULL
430                }
431                mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))
432                right <- set_id(object@children[[2]])
433    
434                object@children <- list(left, right)
435            }
436            level <<- level - 1
437    
438            return(object)
439        }
440    
441        return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))
442    }
443    
444    setMethod("c",
445              signature(x = "TextDocCol"),
446              function(x, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
447                  args <- list(...)
448                  if (length(args) == 0)
449                      return(x)
450    
451                  if (!all(sapply(args, inherits, "TextDocCol")))
452                      stop("not all arguments are text document collections")
453                  if (DBControl(x)[["useDb"]] == TRUE || any(unlist(sapply(args, DBControl)["useDb", ])))
454                      stop("concatenating text document collections with activated database is not supported")
455    
456                  result <- x
457                  for (c in args) {
458                      result <- c2(result, c)
459                  }
460                  return(result)
461              })
462    
463    setGeneric("c2", function(x, y, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) standardGeneric("c2"))
464    setMethod("c2",
465              signature(x = "TextDocCol", y = "TextDocCol"),
466              function(x, y, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
467                  object <- x
468                  # Concatenate data slots
469                  object@.Data <- c(as(x, "list"), as(y, "list"))
470    
471                  # Set the DBControl slot
472                  object@DBControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")
473    
474                  # Update the CMetaData tree
475                  cmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(CMetaData(x), CMetaData(y)))
476                  update.struct <- update_id(cmeta)
477                  object@CMetaData <- update.struct$root
478    
479                  # Find indices to be updated for the left tree
480                  indices.mapping <- NULL
481                  for (m in levels(as.factor(DMetaData(x)$MetaID))) {
482                      indices <- (DMetaData(x)$MetaID == m)
483                      indices.mapping <- c(indices.mapping, list(m = indices))
484                      names(indices.mapping)[length(indices.mapping)] <- m
485                  }
486    
487                  # Update the DMetaData data frames for the left tree
488                  for (i in 1:ncol(update.struct$left.mapping)) {
489                      map <- update.struct$left.mapping[,i]
490                      x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
491                  }
492    
493                  # Find indices to be updated for the right tree
494                  indices.mapping <- NULL
495                  for (m in levels(as.factor(DMetaData(y)$MetaID))) {
496                      indices <- (DMetaData(y)$MetaID == m)
497                      indices.mapping <- c(indices.mapping, list(m = indices))
498                      names(indices.mapping)[length(indices.mapping)] <- m
499                  }
500    
501                  # Update the DMetaData data frames for the right tree
502                  for (i in 1:ncol(update.struct$right.mapping)) {
503                      map <- update.struct$right.mapping[,i]
504                      y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
505                  }
506    
507                  # Merge the DMetaData data frames
508                  labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))
509                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))
510                  x.dmeta.aug <- cbind(DMetaData(x), na.matrix)
511                  labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))
512                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))
513                  y.dmeta.aug <- cbind(DMetaData(y), na.matrix)
514                  object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)
515    
516                  return(object)
517              })
518    
519    setMethod("c",
520              signature(x = "TextDocument"),
521              function(x, ..., recursive = TRUE){
522                  args <- list(...)
523                  if(length(args) == 0)
524                      return(x)
525    
526                  dmeta.df <- data.frame(MetaID = rep(0, length(list(x, ...))), stringsAsFactors = FALSE)
527                  cmeta.node <- new("MetaDataNode",
528                                NodeID = 0,
529                                MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
530                                children = list())
531    
532                  return(new("TextDocCol",
533                             .Data = list(x, ...),
534                             DMetaData = dmeta.df,
535                             CMetaData = cmeta.node,
536                             DBControl = list(useDb = FALSE, dbName = "", dbType = "DB1")))
537              })
538    
539    setMethod("length",
540              signature(x = "TextDocCol"),
541              function(x){
542                  return(length(as(x, "list")))
543        })
544    
545    setMethod("show",
546              signature(object = "TextDocCol"),
547              function(object){
548                  cat(sprintf(ngettext(length(object),
549                                       "A text document collection with %d text document\n",
550                                       "A text document collection with %d text documents\n"),
551                              length(object)))
552        })
553    
554    setMethod("summary",
555              signature(object = "TextDocCol"),
556              function(object){
557                  show(object)
558                  if (length(DMetaData(object)) > 0) {
559                      cat(sprintf(ngettext(length(CMetaData(object)@MetaData),
560                                                  "\nThe metadata consists of %d tag-value pair and a data frame\n",
561                                                  "\nThe metadata consists of %d tag-value pairs and a data frame\n"),
562                                           length(CMetaData(object)@MetaData)))
563                      cat("Available tags are:\n")
564                      cat(strwrap(paste(names(CMetaData(object)@MetaData), collapse = " "), indent = 2, exdent = 2), "\n")
565                      cat("Available variables in the data frame are:\n")
566                      cat(strwrap(paste(names(DMetaData(object)), collapse = " "), indent = 2, exdent = 2), "\n")
567                  }
568        })
569    
570    setGeneric("inspect", function(object) standardGeneric("inspect"))
571    setMethod("inspect",
572              signature("TextDocCol"),
573              function(object) {
574                  summary(object)
575                  cat("\n")
576                  if (DBControl(object)[["useDb"]]) {
577                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
578                      show(dbMultiFetch(db, unlist(object)))
579                      dbDisconnect(db)
580                  }
581                  else
582                      show(object@.Data)
583              })
584    
585    # No metadata is checked
586    setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))
587    setMethod("%IN%",
588              signature(x = "TextDocument", y = "TextDocCol"),
589              function(x, y) {
590                  if (DBControl(y)[["useDb"]]) {
591                      db <- dbInit(DBControl(y)[["dbName"]], DBControl(y)[["dbType"]])
592                      result <- any(sapply(y, function(x, z) {x %in% Corpus(z)}, x))
593                      dbDisconnect(db)
594                  }
595                  else
596                      result <- x %in% y
597                  return(result)
598              })
599    
600    setMethod("lapply",
601              signature(X = "TextDocCol"),
602              function(X, FUN, ...) {
603                  if (DBControl(X)[["useDb"]]) {
604                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
605                      result <- lapply(dbMultiFetch(db, unlist(X)), FUN, ...)
606                      dbDisconnect(db)
607                  }
608                  else
609                      result <- base::lapply(X, FUN, ...)
610                  return(result)
611              })
612    
613    setMethod("sapply",
614              signature(X = "TextDocCol"),
615              function(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE) {
616                  if (DBControl(X)[["useDb"]]) {
617                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
618                      result <- sapply(dbMultiFetch(db, unlist(X)), FUN, ...)
619                      dbDisconnect(db)
620                  }
621                  else
622                      result <- base::sapply(X, FUN, ...)
623                  return(result)
624              })

Legend:
Removed from v.52  
changed lines
  Added in v.744

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge