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 76, Thu Nov 23 16:29:02 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)), stringsAsFactors = FALSE)
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(filename),
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            # The <TITLE></TITLE> tag is unfortunately NOT obligatory!
200            if (!is.null(node[["TEXT"]][["TITLE"]]))
201                heading <- xmlValue(node[["TEXT"]][["TITLE"]])
202            else
203                heading <- ""
204    
205      if (stripWhiteSpace)          topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(corpus)  
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"]])
234    
235            if (!lodsupport || (lodsupport && load)) {
236                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"]])      heading <- xmlValue(node[["title"]])
289    
290      new("textdocument", .Data = corpus, author = author, timestamp = timestamp,      new("PlainTextDocument", .Data = corpus, Cached = TRUE, URI = "", Author = "", DateTimeStamp = datetimestamp,
291          description = description, id = id, origin = origin, heading = heading)          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      origin <- "Not yet implemented"      datetimestamp <- xmlValue(node[["DATE"]])
303        description <- ""
304        id <- xmlAttrs(node)[["NEWID"]]
305    
306        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_update", function(object, origin, parser = plaintext_parser, ...) standardGeneric("tm_update"))
377    # Update is only supported for directories
378    # At the moment no other LoD devices are available anyway
379    setMethod("tm_update",
380              signature(object = "TextDocCol", origin = "DirSource"),
381              function(object, origin, parser = plaintext_parser, ...) {
382                  if (inherits(parser, "function_generator"))
383                      parser <- parser(...)
384    
385                  object.filelist <- unlist(lapply(object, function(x) {as.character(URI(x))[2]}))
386                  new.files <- setdiff(origin@FileList, object.filelist)
387    
388                  for (filename in new.files) {
389                      elem <- list(content = readLines(filename),
390                                   uri = substitute(file(filename)))
391                      object <- append_doc(object, parser(elem, TRUE, origin@Load, filename), NA)
392                  }
393    
394                  return(object)
395              })
396    
397    setGeneric("tm_transform", function(object, FUN, ...) standardGeneric("tm_transform"))
398    setMethod("tm_transform",
399              signature(object = "TextDocCol", FUN = "function"),
400              function(object, FUN, ...) {
401                  result <- object
402                  result@.Data <- lapply(object, FUN, ..., DMetaData = DMetaData(object))
403                  return(result)
404              })
405    
406    setGeneric("as.plaintext_doc", function(object, FUN, ...) standardGeneric("as.plaintext_doc"))
407    setMethod("as.plaintext_doc",
408              signature(object = "PlainTextDocument"),
409              function(object, FUN, ...) {
410                  return(object)
411              })
412    setMethod("as.plaintext_doc",
413              signature(object = "XMLTextDocument", FUN = "function"),
414              function(object, FUN, ...) {
415                  if (!Cached(object))
416                      object <- load_doc(object)
417    
418                  corpus <- Corpus(object)
419    
420                  # As XMLDocument is no native S4 class, restore valid information
421                  class(corpus) <- "XMLDocument"
422                  names(corpus) <- c("doc","dtd")
423    
424                  return(FUN(xmlRoot(corpus), ...))
425              })
426    
427    setGeneric("tm_tolower", function(object, ...) standardGeneric("tm_tolower"))
428    setMethod("tm_tolower",
429              signature(object = "PlainTextDocument"),
430              function(object, ...) {
431                  if (!Cached(object))
432                      object <- load_doc(object)
433    
434                  Corpus(object) <- tolower(object)
435                  return(object)
436              })
437    
438    setGeneric("strip_whitespace", function(object, ...) standardGeneric("strip_whitespace"))
439    setMethod("strip_whitespace",
440              signature(object = "PlainTextDocument"),
441              function(object, ...) {
442                  if (!Cached(object))
443                      object <- load_doc(object)
444    
445                  Corpus(object) <- gsub("[[:space:]]+", " ", object)
446                  return(object)
447              })
448    
449    setGeneric("stem_doc", function(object, ...) standardGeneric("stem_doc"))
450    setMethod("stem_doc",
451              signature(object = "PlainTextDocument"),
452              function(object, ...) {
453                  if (!Cached(object))
454                      object <- load_doc(object)
455    
456                  require(Rstem)
457                  splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))
458                  stemmedCorpus <- wordStem(splittedCorpus)
459                  Corpus(object) <- paste(stemmedCorpus, collapse = " ")
460                  return(object)
461              })
462    
463    setGeneric("remove_words", function(object, stopwords, ...) standardGeneric("remove_words"))
464    setMethod("remove_words",
465              signature(object = "PlainTextDocument", stopwords = "character"),
466              function(object, stopwords, ...) {
467                  if (!Cached(object))
468                      object <- load_doc(object)
469    
470                  require(Rstem)
471                  splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))
472                  noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]
473                  Corpus(object) <- paste(noStopwordsCorpus, collapse = " ")
474                  return(object)
475              })
476    
477    setGeneric("tm_filter", function(object, ..., FUN = s_filter, doclevel = FALSE) standardGeneric("tm_filter"))
478    setMethod("tm_filter",
479              signature(object = "TextDocCol"),
480              function(object, ..., FUN = s_filter, doclevel = FALSE) {
481                  if (doclevel)
482                      return(object[sapply(object, FUN, ..., DMetaData = DMetaData(object))])
483                  else
484                      return(object[FUN(object, ...)])
485              })
486    
487    setGeneric("tm_index", function(object, ..., FUN = s_filter, doclevel = FALSE) standardGeneric("tm_index"))
488    setMethod("tm_index",
489              signature(object = "TextDocCol"),
490              function(object, ..., FUN = s_filter, doclevel = FALSE) {
491                  if (doclevel)
492                      return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))
493                  else
494                      return(FUN(object, ...))
495              })
496    
497    s_filter <- function(object, s, ...) {
498        query.df <- DMetaData(object)
499        con <- textConnection(s)
500        tokens <- scan(con, "character")
501        close(con)
502        local.meta <- lapply(object, LocalMetaData)
503        local.used.meta <- lapply(local.meta, function(x) names(x) %in% tokens)
504        l.meta <- NULL
505        for (i in 1:length(object)) {
506            l.meta <- c(l.meta, list(local.meta[[i]][local.used.meta[[i]]]))
507        }
508        # Load local meta data from text documents into data frame
509        for (i in 1:length(l.meta)) {
510            l.meta[[i]] <- c(l.meta[[i]], list(author = Author(object[[i]])))
511            l.meta[[i]] <- c(l.meta[[i]], list(datetimestamp = DateTimeStamp(object[[i]])))
512            l.meta[[i]] <- c(l.meta[[i]], list(description = Description(object[[i]])))
513            l.meta[[i]] <- c(l.meta[[i]], list(identifier = ID(object[[i]])))
514            l.meta[[i]] <- c(l.meta[[i]], list(origin = Origin(object[[i]])))
515            l.meta[[i]] <- c(l.meta[[i]], list(heading = Heading(object[[i]])))
516        }
517        for (i in 1:length(l.meta)) {
518            for (j in 1:length(l.meta[[i]])) {
519                m <- l.meta[[i]][[j]]
520                m.name <- names(l.meta[[i]][j])
521                if (!(m.name %in% names(query.df))) {
522                    before <- rep(NA, i - 1)
523                    after <- rep(NA, length(l.meta) - i)
524                    if (length(m) > 1) {
525                        nl <- vector("list", length(l.meta))
526                        nl[1:(i-1)] <- before
527                        nl[i] <- list(m)
528                        nl[(i+1):length(l.meta)] <- after
529                        insert <- data.frame(I(nl), stringsAsFactors = FALSE)
530                    }
531                    else
532                        insert <- c(before, m, after)
533                    query.df <- cbind(query.df, insert, stringsAsFactors = FALSE)
534                    names(query.df)[length(query.df)] <- m.name
535                }
536                else {
537                    if (is.null(m))
538                        m <- NA
539                    if (length(m) > 1) {
540                        rl <- query.df[ , m.name]
541                        rl[i] <- list(m)
542                        query.df[ , m.name] <- data.frame(I(rl), stringsAsFactors = FALSE)
543                    }
544                    else
545                        query.df[i, m.name] <- m
546                }
547            }
548        }
549        attach(query.df)
550        try(result <- rownames(query.df) %in% row.names(query.df[eval(parse(text = s)), ]))
551        detach(query.df)
552        return(result)
553    }
554    
555    setGeneric("fulltext_search_filter", function(object, pattern, ...) standardGeneric("fulltext_search_filter"))
556    setMethod("fulltext_search_filter",
557              signature(object = "PlainTextDocument", pattern = "character"),
558              function(object, pattern, ...) {
559                  if (!Cached(object))
560                      object <- load_doc(object)
561    
562                  return(any(grep(pattern, Corpus(object))))
563              })
564    
565    setGeneric("attach_data", function(object, data) standardGeneric("attach_data"))
566    setGeneric("attach_metadata", function(object, name, metadata) standardGeneric("attach_metadata"))
567    
568    setGeneric("append_doc", function(object, data, meta = NULL) standardGeneric("append_doc"))
569    setMethod("append_doc",
570              signature(object = "TextDocCol", data = "TextDocument"),
571              function(object, data, meta = NULL) {
572                  object@.Data <- c(object@.Data, list(data))
573                  object@DMetaData <- rbind(object@DMetaData, c(MetaID = DCMetaData(object)@NodeID, meta))
574                  return(object)
575              })
576    
577    setGeneric("append_meta", function(object, dcmeta = list(), dmeta = NULL) standardGeneric("append_meta"))
578    setMethod("append_meta",
579              signature(object = "TextDocCol"),
580              function(object, dcmeta = list(), dmeta = NULL) {
581                  object@DCMetaData@MetaData <- c(object@DCMetaData@MetaData, dcmeta)
582                  if (length(dmeta) > 0)
583                      object@DMetaData <- cbind(object@DMetaData, dmeta)
584                  return(object)
585              })
586    
587    setGeneric("remove_metadata", function(object, name) standardGeneric("remove_metadata"))
588    #setMethod("remove_metadata",
589    #          signature(object = "TextDocCol"),
590    #          function(object, name) {
591    #              object@DMetaData <- DMetaData(object)[names(DMetaData(object)) != name]
592    #              return(object)
593    #          })
594    
595    setGeneric("modify_metadata", function(object, name, metadata) standardGeneric("modify_metadata"))
596    #setMethod("modify_metadata",
597    #          signature(object = "TextDocCol"),
598    #          function(object, name, metadata) {
599    #              object@DMetaData[[name]] <- metadata
600    #              return(object)
601    #          })
602    
603    setGeneric("prescind_meta", function(object, meta) standardGeneric("prescind_meta"))
604    setMethod("prescind_meta",
605              signature(object = "TextDocCol", meta = "character"),
606              function(object, meta) {
607                  for (m in meta) {
608                      if (m %in% c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading")) {
609                          local.m <- lapply(object, m)
610                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
611                          local.m <- unlist(local.m)
612                          object@DMetaData <- cbind(DMetaData(object), data.frame(m = local.m), stringsAsFactors = FALSE)
613                          names(object@DMetaData)[length(object@DMetaData)] <- m
614                      }
615                      else {
616                          local.meta <- lapply(object, LocalMetaData)
617                          local.m <- lapply(local.meta, "[[", m)
618                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
619                          if (length(local.m) == length(unlist(local.m)))
620                              local.m <- unlist(local.m)
621                          else
622                              local.m <- I(local.m)
623                          object@DMetaData <- cbind(DMetaData(object), data.frame(m = local.m), stringsAsFactors = FALSE)
624                          names(object@DMetaData)[length(object@DMetaData)] <- m
625  }  }
626                  }
627                  return(object)
628              })
629    
630    setMethod("[",
631              signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),
632              function(x, i, j, ... , drop) {
633                  if(missing(i))
634                      return(x)
635    
636                  object <- x
637                  object@.Data <- x@.Data[i, ..., drop = FALSE]
638                  df <- as.data.frame(DMetaData(object)[i, ])
639                  names(df) <- names(DMetaData(object))
640                  object@DMetaData <- df
641                  return(object)
642              })
643    
644    setMethod("[<-",
645              signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),
646              function(x, i, j, ... , value) {
647                  object <- x
648                  object@.Data[i, ...] <- value
649                  return(object)
650              })
651    
652    setMethod("[[",
653              signature(x = "TextDocCol", i = "ANY", j = "ANY"),
654              function(x, i, j, ...) {
655                  return(x@.Data[[i, ...]])
656              })
657    
658    setMethod("[[<-",
659              signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),
660              function(x, i, j, ..., value) {
661                  object <- x
662                  object@.Data[[i, ...]] <- value
663                  return(object)
664              })
665    
666    # Update \code{NodeID}s of a DCMetaData tree
667    # TODO: Avoid global variables outside of update_id function
668    update_id <- function(object) {
669        id <<- 0
670        mapping <<- left.mapping <<- NULL
671        level <<- 0
672        return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))
673    }
674    
675    # Traversal of (binary) DCMetaData tree with setup of \code{NodeID}s
676    set_id <- function(object) {
677        object@NodeID <- id
678        id <<- id + 1
679        level <<- level + 1
680    
681        if (length(object@children) > 0) {
682            mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))
683            left <- set_id(object@children[[1]])
684            if (level == 1) {
685                left.mapping <<- mapping
686                mapping <<- NULL
687            }
688            mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))
689            right <- set_id(object@children[[2]])
690    
691            object@children <- list(left, right)
692        }
693        level <<- level - 1
694    
695        return(object)
696    }
697    
698    setMethod("c",
699              signature(x = "TextDocCol"),
700              function(x, y, ..., meta = list(merge_date = date(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
701                  if (!inherits(y, "TextDocCol"))
702                      stop("invalid argument")
703    
704                  object <- x
705                  # Concatenate data slots
706                  object@.Data <- c(as(x, "list"), as(y, "list"))
707    
708                  # Update the DCMetaData tree
709                  dcmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(DCMetaData(x), DCMetaData(y)))
710                  update.struct <- update_id(dcmeta)
711                  object@DCMetaData <- update.struct$root
712    
713                  # Find indices to be updated for the left tree
714                  indices.mapping <- NULL
715                  for (m in levels(as.factor(DMetaData(x)$MetaID))) {
716                      indices <- (DMetaData(x)$MetaID == m)
717                      indices.mapping <- c(indices.mapping, list(m = indices))
718                      names(indices.mapping)[length(indices.mapping)] <- m
719                  }
720    
721                  # Update the DMetaData data frames for the left tree
722                  for (i in 1:ncol(update.struct$left.mapping)) {
723                      map <- update.struct$left.mapping[,i]
724                      x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
725                  }
726    
727                  # Find indices to be updated for the right tree
728                  indices.mapping <- NULL
729                  for (m in levels(as.factor(DMetaData(y)$MetaID))) {
730                      indices <- (DMetaData(y)$MetaID == m)
731                      indices.mapping <- c(indices.mapping, list(m = indices))
732                      names(indices.mapping)[length(indices.mapping)] <- m
733                  }
734    
735                  # Update the DMetaData data frames for the right tree
736                  for (i in 1:ncol(update.struct$right.mapping)) {
737                      map <- update.struct$right.mapping[,i]
738                      y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
739                  }
740    
741                  # Merge the DMetaData data frames
742                  labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))
743                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))
744                  x.dmeta.aug <- cbind(DMetaData(x), na.matrix)
745                  labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))
746                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))
747                  y.dmeta.aug <- cbind(DMetaData(y), na.matrix)
748                  object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)
749    
750                  return(object)
751              })
752    setMethod("c",
753              signature(x = "TextDocument"),
754              function(x, ..., recursive = TRUE){
755                  args <- list(...)
756                  if(length(args) == 0)
757                      return(x)
758    
759                  dmeta.df <- data.frame(MetaID = rep(0, length(list(x, ...))), stringsAsFactors = FALSE)
760                  dcmeta.node <- new("MetaDataNode",
761                                NodeID = 0,
762                                MetaData = list(create_date = date(), creator = Sys.getenv("LOGNAME")),
763                                children = list())
764    
765                  return(new("TextDocCol", .Data = list(x, ...), DMetaData = dmeta.df, DCMetaData = dcmeta.node))
766              })
767    
768    setMethod("length",
769              signature(x = "TextDocCol"),
770              function(x){
771                  return(length(as(x, "list")))
772        })
773    
774    setMethod("show",
775              signature(object = "TextDocCol"),
776              function(object){
777                  cat(sprintf(ngettext(length(object),
778                                       "A text document collection with %d text document\n",
779                                       "A text document collection with %d text documents\n"),
780                              length(object)))
781        })
782    
783    setMethod("summary",
784              signature(object = "TextDocCol"),
785              function(object){
786                  show(object)
787                  if (length(DMetaData(object)) > 0) {
788                      cat(sprintf(ngettext(length(DMetaData(object)),
789                                                  "\nThe global metadata consists of %d tag-value pair\n",
790                                                  "\nThe global metadata consists of %d tag-value pairs\n"),
791                                           length(DMetaData(object))))
792                      cat("Available tags are:\n")
793                      cat(names(DMetaData(object)), "\n")
794                  }
795        })
796    
797    setGeneric("inspect", function(object) standardGeneric("inspect"))
798    setMethod("inspect",
799              signature("TextDocCol"),
800              function(object) {
801                  summary(object)
802                  cat("\n")
803                  show(as(object, "list"))
804              })
805    
806    # No metadata is checked
807    setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))
808    setMethod("%IN%",
809              signature(x = "TextDocument", y = "TextDocCol"),
810              function(x, y) {
811                  x %in% y
812              })

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

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