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/R/textmin/R/textdoccol.R revision 71, Sun Nov 19 17:30:26 2006 UTC
# Line 1  Line 1 
1  # Author: Ingo Feinerer  # Author: Ingo Feinerer
2    
3  # S4 class definition  # The "..." are additional arguments for the function_generator parser
4  # Text document collection  setGeneric("TextDocCol", function(object, parser = plaintext_parser, ...) standardGeneric("TextDocCol"))
5  setClass("textdoccol",  setMethod("TextDocCol",
6           contains = c("list"))            signature(object = "Source"),
7              function(object, parser = plaintext_parser, ...) {
8  # Constructors                if (inherits(parser, "function_generator"))
9                      parser <- parser(...)
10  setGeneric("textdoccol", function(object, ...) standardGeneric("textdoccol"))  
11  setMethod("textdoccol",                tdl <- list()
12            c("character", "character", "logical", "logical"),                counter <- 1
13            function(object, inputType = "RCV1", stripWhiteSpace = FALSE, toLower = FALSE) {                while (!eoi(object)) {
14                      object <- step_next(object)
15                # Add a new type for each unique input source format                    elem <- get_elem(object)
16                type <- match.arg(inputType,c("RCV1","CSV","REUT21578"))                    # If there is no Load on Demand support
17                switch(type,                    # we need to load the corpus into memory at startup
18                       # Read in text documents in XML Reuters Corpus Volume 1 (RCV1) format                    if (object@LoDSupport)
19                       # For the moment the first argument is still a single file                        load <- object@Load
20                       # This will be changed to a directory as soon as we have the full RCV1 data set                    else
21                       "RCV1" = {                        load <- TRUE
22                           tree <- xmlTreeParse(object)                    tdl <- c(tdl, list(parser(elem, object@LoDSupport, load, as.character(counter))))
23                           tdcl <- new("textdoccol", .Data = xmlApply(xmlRoot(tree), parseNewsItem, stripWhiteSpace, toLower))                    counter <- counter + 1
24                       },                }
25                       # Text in a special CSV format (as e.g. exported from an Excel sheet)  
26                       # For details on the file format see data/Umfrage.csv                dmeta.df <- data.frame(MetaID = rep(0, length(tdl)))
27                       # The first argument has to be a single file                dcmeta.node <- new("MetaDataNode",
28                       "CSV" = {                              NodeID = 0,
29                           m <- as.matrix(read.csv(object))                              MetaData = list(create_date = date(), creator = Sys.getenv("LOGNAME")),
30                           l <- vector("list", dim(m)[1])                              children = list())
31                           for (i in 1:dim(m)[1]) {  
32                               author <- "Not yet implemented"                return(new("TextDocCol", .Data = tdl, DMetaData = dmeta.df, DCMetaData = dcmeta.node))
33                               timestamp <- date()            })
34                               description <- "Not yet implemented"  
35                               id <- i  setGeneric("DirSource", function(directory, load = FALSE) standardGeneric("DirSource"))
36                               corpus <- as.character(m[i,2:dim(m)[2]])  setMethod("DirSource",
37                               if (stripWhiteSpace)            signature(directory = "character"),
38                                   corpus <- gsub("[[:space:]]+", " ", corpus)            function(directory, load = FALSE) {
39                               if (toLower)                new("DirSource", LoDSupport = TRUE, FileList = dir(directory, full.names = TRUE),
40                                   corpus <- tolower(corpus)                    Position = 0, Load = load)
                              origin <- "Not yet implemented"  
                              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)  
41                                         })                                         })
42    
43                           tdcl <- new("textdoccol", .Data = tdl)  setGeneric("CSVSource", function(object) standardGeneric("CSVSource"))
44    setMethod("CSVSource",
45              signature(object = "character"),
46              function(object) {
47                  object <- substitute(file(object))
48                  con <- eval(object)
49                  content <- scan(con, what = "character")
50                  close(con)
51                  new("CSVSource", LoDSupport = FALSE, URI = object,
52                      Content = content, Position = 0)
53                       })                       })
54                tdcl  setMethod("CSVSource",
55              signature(object = "ANY"),
56              function(object) {
57                  object <- substitute(object)
58                  con <- eval(object)
59                  content <- scan(con, what = "character")
60                  close(con)
61                  new("CSVSource", LoDSupport = FALSE, URI = object,
62                      Content = content, Position = 0)
63            })            })
64    
65  # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file  setGeneric("ReutersSource", function(object) standardGeneric("ReutersSource"))
66  parseNewsItem <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {  setMethod("ReutersSource",
67      author <- "Not yet implemented"            signature(object = "character"),
68      timestamp <- xmlAttrs(node)[["date"]]            function(object) {
69      description <- "Not yet implemented"                object <- substitute(file(object))
70      id <- as.integer(xmlAttrs(node)[["itemid"]])                con <- eval(object)
71      origin <- "Not yet implemented"                corpus <- paste(readLines(con), "\n", collapse = "")
72      corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)                close(con)
73                  tree <- xmlTreeParse(corpus, asText = TRUE)
74                  content <- xmlRoot(tree)$children
75    
76                  new("ReutersSource", LoDSupport = FALSE, URI = object,
77                      Content = content, Position = 0)
78              })
79    setMethod("ReutersSource",
80              signature(object = "ANY"),
81              function(object) {
82                  object <- substitute(object)
83                  con <- eval(object)
84                  corpus <- paste(readLines(con), "\n", collapse = "")
85                  close(con)
86                  tree <- xmlTreeParse(corpus, asText = TRUE)
87                  content <- xmlRoot(tree)$children
88    
89                  new("ReutersSource", LoDSupport = FALSE, URI = object,
90                      Content = content, Position = 0)
91              })
92    
93    setGeneric("step_next", function(object) standardGeneric("step_next"))
94    setMethod("step_next",
95              signature(object = "DirSource"),
96              function(object) {
97                  object@Position <- object@Position + 1
98                  object
99              })
100    setMethod("step_next",
101              signature(object = "CSVSource"),
102              function(object) {
103                  object@Position <- object@Position + 1
104                  object
105              })
106    setMethod("step_next",
107              signature(object = "ReutersSource"),
108              function(object) {
109                  object@Position <- object@Position + 1
110                  object
111              })
112    
113    setGeneric("get_elem", function(object) standardGeneric("get_elem"))
114    setMethod("get_elem",
115              signature(object = "DirSource"),
116              function(object) {
117                  filename <- object@FileList[object@Position]
118                  list(content = readLines(object@FileList[object@Position]),
119                       uri = substitute(file(filename)))
120              })
121    setMethod("get_elem",
122              signature(object = "CSVSource"),
123              function(object) {
124                  list(content = object@Content[object@Position],
125                       uri = object@URI)
126              })
127    setMethod("get_elem",
128              signature(object = "ReutersSource"),
129              function(object) {
130                  # Construct a character representation from the XMLNode
131                  con <- textConnection("virtual.file", "w")
132                  saveXML(object@Content[[object@Position]], con)
133                  close(con)
134    
135                  list(content = virtual.file, uri = object@URI)
136              })
137    
138    setGeneric("eoi", function(object) standardGeneric("eoi"))
139    setMethod("eoi",
140              signature(object = "DirSource"),
141              function(object) {
142                  if (length(object@FileList) <= object@Position)
143                      return(TRUE)
144                  else
145                      return(FALSE)
146              })
147    setMethod("eoi",
148              signature(object = "CSVSource"),
149              function(object) {
150                  if (length(object@Content) <= object@Position)
151                      return(TRUE)
152                  else
153                      return(FALSE)
154              })
155    setMethod("eoi",
156              signature(object = "ReutersSource"),
157              function(object) {
158                  if (length(object@Content) <= object@Position)
159                      return(TRUE)
160                  else
161                      return(FALSE)
162              })
163    
164    plaintext_parser <- function(...) {
165        function(elem, lodsupport, load, id) {
166            if (!lodsupport || (lodsupport && load)) {
167                doc <- new("PlainTextDocument", .Data = elem$content, URI = elem$uri, Cached = TRUE,
168                           Author = "", DateTimeStamp = date(), Description = "", ID = id, Origin = "", Heading = "")
169            }
170            else {
171                doc <- new("PlainTextDocument", URI = elem$uri, Cached = FALSE,
172                           Author = "", DateTimeStamp = date(), Description = "", ID = id, Origin = "", Heading = "")
173            }
174    
175            return(doc)
176        }
177    }
178    class(plaintext_parser) <- "function_generator"
179    
180    reut21578xml_parser <- function(...) {
181        function(elem, lodsupport, load, id) {
182            corpus <- paste(elem$content, "\n", collapse = "")
183            tree <- xmlTreeParse(corpus, asText = TRUE)
184            node <- xmlRoot(tree)
185    
186            # Mask as list to bypass S4 checks
187            class(tree) <- "list"
188    
189            # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!
190            if (!is.null(node[["TEXT"]][["AUTHOR"]]))
191                author <- xmlValue(node[["TEXT"]][["AUTHOR"]])
192            else
193                author <- ""
194    
195            datetimestamp <- xmlValue(node[["DATE"]])
196            description <- ""
197            id <- xmlAttrs(node)[["NEWID"]]
198    
199      if (stripWhiteSpace)          # The <TITLE></TITLE> tag is unfortunately NOT obligatory!
200          corpus <- gsub("[[:space:]]+", " ", corpus)          if (!is.null(node[["TEXT"]][["TITLE"]]))
201      if (toLower)              heading <- xmlValue(node[["TEXT"]][["TITLE"]])
202          corpus <- tolower(corpus)          else
203                heading <- ""
204    
205            topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)
206    
207            if (!lodsupport || (lodsupport && load)) {
208                doc <- new("XMLTextDocument", .Data = tree, URI = elem$uri, Cached = TRUE, Author = author,
209                           DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters-21578 XML",
210                           Heading = heading, LocalMetaData = list(Topics = topics))
211            } else {
212                doc <- new("XMLTextDocument", URI = elem$uri, Cached = FALSE, Author = author,
213                           DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters-21578 XML",
214                           Heading = heading, LocalMetaData = list(Topics = topics))
215            }
216    
217            return(doc)
218        }
219    }
220    class(reut21578xml_parser) <- "function_generator"
221    
222    rcv1_parser <- function(...) {
223        function(elem, lodsupport, load, id) {
224            corpus <- paste(elem$content, "\n", collapse = "")
225            tree <- xmlTreeParse(corpus, asText = TRUE)
226            node <- xmlRoot(tree)
227    
228            # Mask as list to bypass S4 checks
229            class(tree) <- "list"
230    
231            datetimestamp <- xmlAttrs(node)[["date"]]
232            id <- xmlAttrs(node)[["itemid"]]
233      heading <- xmlValue(node[["title"]])      heading <- xmlValue(node[["title"]])
234    
235      new("textdocument", .Data = corpus, author = author, timestamp = timestamp,          if (!lodsupport || (lodsupport && load)) {
236          description = description, id = id, origin = origin, heading = heading)              doc <- new("XMLTextDocument", .Data = tree, URI = elem$uri, Cached = TRUE, Author = "",
237                           DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML",
238                           Heading = heading)
239            } else {
240                doc <- new("XMLTextDocument", URI = elem$uri, Cached = FALSE, Author = "",
241                           DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML",
242                           Heading = heading)
243            }
244    
245            return(doc)
246        }
247    }
248    class(rcv1_parser) <- "function_generator"
249    
250    newsgroup_parser <- function(...) {
251        function(elem, lodsupport, load, id) {
252            mail <- elem$content
253            author <- gsub("From: ", "", grep("^From:", mail, value = TRUE))
254            datetimestamp <- gsub("Date: ", "", grep("^Date:", mail, value = TRUE))
255            origin <- gsub("Path: ", "", grep("^Path:", mail, value = TRUE))
256            heading <- gsub("Subject: ", "", grep("^Subject:", mail, value = TRUE))
257            newsgroup <- gsub("Newsgroups: ", "", grep("^Newsgroups:", mail, value = TRUE))
258    
259            if (!lodsupport || (lodsupport && load)) {
260                # The header is separated from the body by a blank line.
261                # Reference: \url{http://en.wikipedia.org/wiki/E-mail#Internet_e-mail_format}
262                for (index in seq(along = mail)) {
263                    if (mail[index] == "")
264                        break
265                }
266                content <- mail[(index + 1):length(mail)]
267    
268                doc <- new("NewsgroupDocument", .Data = content, URI = elem$uri, Cached = TRUE,
269                           Author = author, DateTimeStamp = datetimestamp,
270                           Description = "", ID = id, Origin = origin,
271                           Heading = heading, Newsgroup = newsgroup)
272            } else {
273                doc <- new("NewsgroupDocument", URI = elem$uri, Cached = FALSE, Author = author, DateTimeStamp = datetimestamp,
274                           Description = "", ID = id, Origin = origin, Heading = heading, Newsgroup = newsgroup)
275            }
276    
277            return(doc)
278        }
279    }
280    class(newsgroup_parser) <- "function_generator"
281    
282    # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file
283    rcv1_to_plain <- function(node, ...) {
284        datetimestamp <- xmlAttrs(node)[["date"]]
285        id <- xmlAttrs(node)[["itemid"]]
286        origin <- "Reuters Corpus Volume 1 XML"
287        corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)
288        heading <- xmlValue(node[["title"]])
289    
290        new("PlainTextDocument", .Data = corpus, Cached = TRUE, URI = "", Author = "", DateTimeStamp = datetimestamp,
291            Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML", Heading = heading)
292  }  }
293    
294  # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file  # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file
295  parseReuters <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {  reut21578xml_to_plain <- function(node, ...) {
296      author <- "Not yet implemented"      # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!
297      timestamp <- xmlValue(node[["DATE"]])      if (!is.null(node[["TEXT"]][["AUTHOR"]]))
298      description <- "Not yet implemented"          author <- xmlValue(node[["TEXT"]][["AUTHOR"]])
299      id <- as.integer(xmlAttrs(node)[["NEWID"]])      else
300            author <- ""
301    
302        datetimestamp <- xmlValue(node[["DATE"]])
303        description <- ""
304        id <- xmlAttrs(node)[["NEWID"]]
305    
306      origin <- "Not yet implemented"      origin <- "Reuters-21578 XML"
307    
308      # The <BODY></BODY> tag is unfortunately NOT obligatory!      # The <BODY></BODY> tag is unfortunately NOT obligatory!
309      if (!is.null(node[["TEXT"]][["BODY"]]))      if (!is.null(node[["TEXT"]][["BODY"]]))
# Line 98  Line 311 
311      else      else
312          corpus <- ""          corpus <- ""
313    
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(corpus)  
   
314      # The <TITLE></TITLE> tag is unfortunately NOT obligatory!      # The <TITLE></TITLE> tag is unfortunately NOT obligatory!
315      if (!is.null(node[["TEXT"]][["TITLE"]]))      if (!is.null(node[["TEXT"]][["TITLE"]]))
316          heading <- xmlValue(node[["TEXT"]][["TITLE"]])          heading <- xmlValue(node[["TEXT"]][["TITLE"]])
317      else      else
318          heading <- ""          heading <- ""
319    
320      new("textdocument", .Data = corpus, author = author, timestamp = timestamp,      topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)
321          description = description, id = id, origin = origin, heading = heading)  
322        new("PlainTextDocument", .Data = corpus, Cached = TRUE, URI = "", Author = author, DateTimeStamp = datetimestamp,
323            Description = description, ID = id, Origin = origin, Heading = heading, LocalMetaData = list(Topics = topics))
324    }
325    
326    setGeneric("load_doc", function(object, ...) standardGeneric("load_doc"))
327    setMethod("load_doc",
328              signature(object = "PlainTextDocument"),
329              function(object, ...) {
330                  if (!Cached(object)) {
331                      con <- eval(URI(object))
332                      corpus <- readLines(con)
333                      close(con)
334                      Corpus(object) <- corpus
335                      Cached(object) <- TRUE
336                      return(object)
337                  } else {
338                      return(object)
339                  }
340              })
341    setMethod("load_doc",
342              signature(object =  "XMLTextDocument"),
343              function(object, ...) {
344                  if (!Cached(object)) {
345                      con <- eval(URI(object))
346                      corpus <- paste(readLines(con), "\n", collapse = "")
347                      close(con)
348                      doc <- xmlTreeParse(corpus, asText = TRUE)
349                      class(doc) <- "list"
350                      Corpus(object) <- doc
351                      Cached(object) <- TRUE
352                      return(object)
353                  } else {
354                      return(object)
355  }  }
356              })
357    setMethod("load_doc",
358              signature(object = "NewsgroupDocument"),
359              function(object, ...) {
360                  if (!Cached(object)) {
361                      con <- eval(URI(object))
362                      mail <- readLines(con)
363                      close(con)
364                      Cached(object) <- TRUE
365                      for (index in seq(along = mail)) {
366                          if (mail[index] == "")
367                              break
368                      }
369                      Corpus(object) <- mail[(index + 1):length(mail)]
370                      return(object)
371                  } else {
372                      return(object)
373                  }
374              })
375    
376    setGeneric("tm_transform", function(object, FUN, ...) standardGeneric("tm_transform"))
377    setMethod("tm_transform",
378              signature(object = "TextDocCol", FUN = "function"),
379              function(object, FUN, ...) {
380                  result <- as(lapply(object, FUN, ..., DMetaData = DMetaData(object)), "TextDocCol")
381                  result@DMetaData <- DMetaData(object)
382                  return(result)
383              })
384    
385    setGeneric("as.plaintext_doc", function(object, FUN, ...) standardGeneric("as.plaintext_doc"))
386    setMethod("as.plaintext_doc",
387              signature(object = "PlainTextDocument"),
388              function(object, FUN, ...) {
389                  return(object)
390              })
391    setMethod("as.plaintext_doc",
392              signature(object = "XMLTextDocument", FUN = "function"),
393              function(object, FUN, ...) {
394                  if (!Cached(object))
395                      object <- load_doc(object)
396    
397                  corpus <- Corpus(object)
398    
399                  # As XMLDocument is no native S4 class, restore valid information
400                  class(corpus) <- "XMLDocument"
401                  names(corpus) <- c("doc","dtd")
402    
403                  return(FUN(xmlRoot(corpus), ...))
404              })
405    
406    setGeneric("tm_tolower", function(object, ...) standardGeneric("tm_tolower"))
407    setMethod("tm_tolower",
408              signature(object = "PlainTextDocument"),
409              function(object, ...) {
410                  if (!Cached(object))
411                      object <- load_doc(object)
412    
413                  Corpus(object) <- tolower(object)
414                  return(object)
415              })
416    
417    setGeneric("strip_whitespace", function(object, ...) standardGeneric("strip_whitespace"))
418    setMethod("strip_whitespace",
419              signature(object = "PlainTextDocument"),
420              function(object, ...) {
421                  if (!Cached(object))
422                      object <- load_doc(object)
423    
424                  Corpus(object) <- gsub("[[:space:]]+", " ", object)
425                  return(object)
426              })
427    
428    setGeneric("stem_doc", function(object, ...) standardGeneric("stem_doc"))
429    setMethod("stem_doc",
430              signature(object = "PlainTextDocument"),
431              function(object, ...) {
432                  if (!Cached(object))
433                      object <- load_doc(object)
434    
435                  require(Rstem)
436                  splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))
437                  stemmedCorpus <- wordStem(splittedCorpus)
438                  Corpus(object) <- paste(stemmedCorpus, collapse = " ")
439                  return(object)
440              })
441    
442    setGeneric("remove_words", function(object, stopwords, ...) standardGeneric("remove_words"))
443    setMethod("remove_words",
444              signature(object = "PlainTextDocument", stopwords = "character"),
445              function(object, stopwords, ...) {
446                  if (!Cached(object))
447                      object <- load_doc(object)
448    
449                  require(Rstem)
450                  splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))
451                  noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]
452                  Corpus(object) <- paste(noStopwordsCorpus, collapse = " ")
453                  return(object)
454              })
455    
456    setGeneric("tm_filter", function(object, ..., FUN = s_filter) standardGeneric("tm_filter"))
457    setMethod("tm_filter",
458              signature(object = "TextDocCol"),
459              function(object, ..., FUN = s_filter) {
460                  indices <- sapply(object, FUN, ..., DMetaData = DMetaData(object))
461                  object[indices]
462              })
463    
464    setGeneric("tm_index", function(object, ..., FUN = s_filter) standardGeneric("tm_index"))
465    setMethod("tm_index",
466              signature(object = "TextDocCol"),
467              function(object, ..., FUN = s_filter) {
468                  sapply(object, FUN, ..., DMetaData = DMetaData(object))
469              })
470    
471    s_filter <- function(object, s, ..., DMetaData) {
472        b <- TRUE
473        for (tag in names(s)) {
474            if (tag %in% names(LocalMetaData(object))) {
475                b <- b && any(grep(s[[tag]], LocalMetaData(object)[[tag]]))
476            } else if (tag %in% names(DMetaData)){
477                b <- b && any(grep(s[[tag]], DMetaData[[tag]]))
478            } else {
479                b <- b && any(grep(s[[tag]], eval(call(tag, object))))
480            }
481        }
482        return(b)
483    }
484    
485    setGeneric("fulltext_search_filter", function(object, pattern, ...) standardGeneric("fulltext_search_filter"))
486    setMethod("fulltext_search_filter",
487              signature(object = "PlainTextDocument", pattern = "character"),
488              function(object, pattern, ...) {
489                  if (!Cached(object))
490                      object <- load_doc(object)
491    
492                  return(any(grep(pattern, Corpus(object))))
493              })
494    
495    setGeneric("attach_data", function(object, data) standardGeneric("attach_data"))
496    setGeneric("attach_metadata", function(object, name, metadata) standardGeneric("attach_metadata"))
497    
498    setGeneric("append_doc", function(object, data, meta) standardGeneric("append_doc"))
499    setMethod("append_doc",
500              signature(object = "TextDocCol", data = "TextDocument", meta = "list"),
501              function(object, data, meta) {
502                  object@.Data <- c(object@.Data, list(data))
503                  object@DMetaData <- rbind(object@DMetaData, c(MetaID = DCMetaData(object)@NodeID, meta))
504                  return(object)
505              })
506    
507    setGeneric("append_meta", function(object, dcmeta, dmeta) standardGeneric("append_meta"))
508    setMethod("append_meta",
509              signature(object = "TextDocCol", dcmeta = "list", dmeta = "list"),
510              function(object, dcmeta, dmeta) {
511                  object@DCMetaData@MetaData <- c(object@DCMetaData@MetaData, dcmeta)
512                  object@DMetaData <- cbind(object@DMetaData, dmeta)
513                  return(object)
514              })
515    
516    setGeneric("remove_metadata", function(object, name) standardGeneric("remove_metadata"))
517    #setMethod("remove_metadata",
518    #          signature(object = "TextDocCol"),
519    #          function(object, name) {
520    #              object@DMetaData <- DMetaData(object)[names(DMetaData(object)) != name]
521    #              return(object)
522    #          })
523    
524    setGeneric("modify_metadata", function(object, name, metadata) standardGeneric("modify_metadata"))
525    #setMethod("modify_metadata",
526    #          signature(object = "TextDocCol"),
527    #          function(object, name, metadata) {
528    #              object@DMetaData[[name]] <- metadata
529    #              return(object)
530    #          })
531    
532    setMethod("[",
533              signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),
534              function(x, i, j, ... , drop) {
535                  if(missing(i))
536                      return(x)
537    
538                  object <- x
539                  object@.Data <- x@.Data[i, ..., drop = FALSE]
540                  object@DMetaData <- DMetaData(object)[i, ]
541                  return(object)
542              })
543    
544    setMethod("[<-",
545              signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),
546              function(x, i, j, ... , value) {
547                  object <- x
548                  object@.Data[i, ...] <- value
549                  return(object)
550              })
551    
552    setMethod("[[",
553              signature(x = "TextDocCol", i = "ANY", j = "ANY"),
554              function(x, i, j, ...) {
555                  return(x@.Data[[i, ...]])
556              })
557    
558    setMethod("[[<-",
559              signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),
560              function(x, i, j, ..., value) {
561                  object <- x
562                  object@.Data[[i, ...]] <- value
563                  return(object)
564              })
565    
566    # Update \code{NodeID}s of a DCMetaData tree
567    # TODO: Avoid global variables outside of update_id function
568    update_id <- function(object) {
569        id <<- 0
570        mapping <<- left.mapping <<- NULL
571        level <<- 0
572        return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))
573    }
574    
575    # Traversal of (binary) DCMetaData tree with setup of \code{NodeID}s
576    set_id <- function(object) {
577        object@NodeID <- id
578        id <<- id + 1
579        level <<- level + 1
580    
581        if (length(object@children) > 0) {
582            mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))
583            left <- set_id(object@children[[1]])
584            if (level == 1) {
585                left.mapping <<- mapping
586                mapping <<- NULL
587            }
588            mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))
589            right <- set_id(object@children[[2]])
590    
591            object@children <- list(left, right)
592        }
593        level <<- level - 1
594    
595        return(object)
596    }
597    
598    setMethod("c",
599              signature(x = "TextDocCol"),
600              function(x, y, ..., meta = list(merge_date = date(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
601                  if (!inherits(y, "TextDocCol"))
602                      stop("invalid argument")
603    
604                  object <- x
605                  # Concatenate data slots
606                  object@.Data <- c(as(x, "list"), as(y, "list"))
607    
608                  # Update the DCMetaData tree
609                  dcmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(DCMetaData(x), DCMetaData(y)))
610                  update.struct <- update_id(dcmeta)
611                  object@DCMetaData <- update.struct$root
612    
613                  # Find indices to be updated for the left tree
614                  indices.mapping <- NULL
615                  for (m in levels(as.factor(DMetaData(x)$MetaID))) {
616                      indices <- (DMetaData(x)$MetaID == m)
617                      indices.mapping <- c(indices.mapping, list(m = indices))
618                      names(indices.mapping)[length(indices.mapping)] <- m
619                  }
620    
621                  # Update the DMetaData data frames for the left tree
622                  for (i in 1:ncol(update.struct$left.mapping)) {
623                      map <- update.struct$left.mapping[,i]
624                      x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
625                  }
626    
627                  # Find indices to be updated for the right tree
628                  indices.mapping <- NULL
629                  for (m in levels(as.factor(DMetaData(y)$MetaID))) {
630                      indices <- (DMetaData(y)$MetaID == m)
631                      indices.mapping <- c(indices.mapping, list(m = indices))
632                      names(indices.mapping)[length(indices.mapping)] <- m
633                  }
634    
635                  # Update the DMetaData data frames for the right tree
636                  for (i in 1:ncol(update.struct$right.mapping)) {
637                      map <- update.struct$right.mapping[,i]
638                      y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
639                  }
640    
641                  # Merge the DMetaData data frames
642                  labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))
643                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))
644                  x.dmeta.aug <- cbind(DMetaData(x), na.matrix)
645                  labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))
646                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))
647                  y.dmeta.aug <- cbind(DMetaData(y), na.matrix)
648                  object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)
649    
650                  return(object)
651        })
652    #setMethod("c",
653    #          signature(x = "TextDocument"),
654    #          function(x, ..., recursive = TRUE){
655    #              args <- list(...)
656    #              if(length(args) == 0)
657    #                  return(x)
658    #              return(new("TextDocCol", .Data = list(x, ...)))
659    #    })
660    
661    setMethod("length",
662              signature(x = "TextDocCol"),
663              function(x){
664                  return(length(as(x, "list")))
665        })
666    
667    setMethod("show",
668              signature(object = "TextDocCol"),
669              function(object){
670                  cat(sprintf(ngettext(length(object),
671                                       "A text document collection with %d text document\n",
672                                       "A text document collection with %d text documents\n"),
673                              length(object)))
674        })
675    
676    setMethod("summary",
677              signature(object = "TextDocCol"),
678              function(object){
679                  show(object)
680                  if (length(DMetaData(object)) > 0) {
681                      cat(sprintf(ngettext(length(DMetaData(object)),
682                                                  "\nThe global metadata consists of %d tag-value pair\n",
683                                                  "\nThe global metadata consists of %d tag-value pairs\n"),
684                                           length(DMetaData(object))))
685                      cat("Available tags are:\n")
686                      cat(names(DMetaData(object)), "\n")
687                  }
688        })
689    
690    setGeneric("inspect", function(object) standardGeneric("inspect"))
691    setMethod("inspect",
692              signature("TextDocCol"),
693              function(object) {
694                  summary(object)
695                  cat("\n")
696                  show(as(object, "list"))
697              })
698    
699    # No metadata is checked
700    setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))
701    setMethod("%IN%",
702              signature(x = "TextDocument", y = "TextDocCol"),
703              function(x, y) {
704                  x %in% y
705              })

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

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