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

Legend:
Removed from v.32  
changed lines
  Added in v.831

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