SCM

SCM Repository

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

Diff of /pkg/R/corpus.R

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

trunk/R/textmin/R/textdoccol.R revision 76, Thu Nov 23 16:29:02 2006 UTC pkg/R/corpus.R revision 1333, Fri Apr 18 10:38:46 2014 UTC
# Line 1  Line 1 
1  # Author: Ingo Feinerer  # Author: Ingo Feinerer
2    
3  # The "..." are additional arguments for the function_generator parser  PCorpus <-
4  setGeneric("TextDocCol", function(object, parser = plaintext_parser, ...) standardGeneric("TextDocCol"))  function(x,
5  setMethod("TextDocCol",           readerControl = list(reader = x$defaultreader, language = "en"),
6            signature(object = "Source"),           dbControl = list(dbName = "", dbType = "DB1"))
7            function(object, parser = plaintext_parser, ...) {  {
8                if (inherits(parser, "function_generator"))      stopifnot(inherits(x, "Source"))
9                    parser <- parser(...)  
10        readerControl <- prepareReader(readerControl, x$defaultreader)
11    
12        if (is.function(readerControl$init))
13            readerControl$init()
14    
15        if (is.function(readerControl$exit))
16            on.exit(readerControl$exit())
17    
18        if (!filehash::dbCreate(dbControl$dbName, dbControl$dbType))
19            stop("error in creating database")
20        db <- filehash::dbInit(dbControl$dbName, dbControl$dbType)
21    
22        # Allocate memory in advance if length is known
23        tdl <- if (x$length > 0) vector("list", as.integer(x$length)) else list()
24    
               tdl <- list()  
25                counter <- 1                counter <- 1
26                while (!eoi(object)) {      while (!eoi(x)) {
27                    object <- step_next(object)          x <- stepNext(x)
28                    elem <- get_elem(object)          elem <- getElem(x)
29                    # If there is no Load on Demand support          id <- if (is.null(x$names) || is.na(x$names))
30                    # we need to load the corpus into memory at startup              as.character(counter)
31                    if (object@LoDSupport)          else
32                        load <- object@Load              x$names[counter]
33                    else          doc <- readerControl$reader(elem, readerControl$language, id)
34                        load <- TRUE          filehash::dbInsert(db, meta(doc, "id"), doc)
35                    tdl <- c(tdl, list(parser(elem, object@LoDSupport, load, as.character(counter))))          if (x$length > 0) tdl[[counter]] <- meta(doc, "id")
36            else tdl <- c(tdl, meta(doc, "id"))
37                    counter <- counter + 1                    counter <- counter + 1
38                }                }
39        if (!is.null(x$names) && !is.na(x$names))
40            names(tdl) <- x$names
41    
42                dmeta.df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)      structure(list(content = tdl,
43                dcmeta.node <- new("MetaDataNode",                     meta = CorpusMeta(),
44                              NodeID = 0,                     dmeta = data.frame(row.names = seq_along(tdl)),
45                              MetaData = list(create_date = date(), creator = Sys.getenv("LOGNAME")),                     dbcontrol = dbControl),
46                              children = list())                class = c("PCorpus", "Corpus"))
47    }
48                return(new("TextDocCol", .Data = tdl, DMetaData = dmeta.df, DCMetaData = dcmeta.node))  
49            })  VCorpus <-
50    function(x, readerControl = list(reader = x$defaultreader, language = "en"))
51  setGeneric("DirSource", function(directory, load = FALSE) standardGeneric("DirSource"))  {
52  setMethod("DirSource",      stopifnot(inherits(x, "Source"))
53            signature(directory = "character"),  
54            function(directory, load = FALSE) {      readerControl <- prepareReader(readerControl, x$defaultreader)
55                new("DirSource", LoDSupport = TRUE, FileList = dir(directory, full.names = TRUE),  
56                    Position = 0, Load = load)      if (is.function(readerControl$init))
57            })          readerControl$init()
58    
59  setGeneric("CSVSource", function(object) standardGeneric("CSVSource"))      if (is.function(readerControl$exit))
60  setMethod("CSVSource",          on.exit(readerControl$exit())
61            signature(object = "character"),  
62            function(object) {      # Allocate memory in advance if length is known
63                object <- substitute(file(object))      tdl <- if (x$length > 0) vector("list", as.integer(x$length)) else list()
64                con <- eval(object)  
65                content <- scan(con, what = "character")      if (x$vectorized)
66                close(con)          tdl <- mapply(function(elem, id)
67                new("CSVSource", LoDSupport = FALSE, URI = object,                            readerControl$reader(elem, readerControl$language, id),
68                    Content = content, Position = 0)                        pGetElem(x),
69            })                        id = if (is.null(x$names) || is.na(x$names))
70  setMethod("CSVSource",                            as.character(seq_len(x$length))
71            signature(object = "ANY"),                        else x$names,
72            function(object) {                        SIMPLIFY = FALSE)
               object <- substitute(object)  
               con <- eval(object)  
               content <- scan(con, what = "character")  
               close(con)  
               new("CSVSource", LoDSupport = FALSE, URI = object,  
                   Content = content, Position = 0)  
           })  
   
 setGeneric("ReutersSource", function(object) standardGeneric("ReutersSource"))  
 setMethod("ReutersSource",  
           signature(object = "character"),  
           function(object) {  
               object <- substitute(file(object))  
               con <- eval(object)  
               corpus <- paste(readLines(con), "\n", collapse = "")  
               close(con)  
               tree <- xmlTreeParse(corpus, asText = TRUE)  
               content <- xmlRoot(tree)$children  
   
               new("ReutersSource", LoDSupport = FALSE, URI = object,  
                   Content = content, Position = 0)  
           })  
 setMethod("ReutersSource",  
           signature(object = "ANY"),  
           function(object) {  
               object <- substitute(object)  
               con <- eval(object)  
               corpus <- paste(readLines(con), "\n", collapse = "")  
               close(con)  
               tree <- xmlTreeParse(corpus, asText = TRUE)  
               content <- xmlRoot(tree)$children  
   
               new("ReutersSource", LoDSupport = FALSE, URI = object,  
                   Content = content, Position = 0)  
           })  
   
 setGeneric("step_next", function(object) standardGeneric("step_next"))  
 setMethod("step_next",  
           signature(object = "DirSource"),  
           function(object) {  
               object@Position <- object@Position + 1  
               object  
           })  
 setMethod("step_next",  
           signature(object = "CSVSource"),  
           function(object) {  
               object@Position <- object@Position + 1  
               object  
           })  
 setMethod("step_next",  
           signature(object = "ReutersSource"),  
           function(object) {  
               object@Position <- object@Position + 1  
               object  
           })  
   
 setGeneric("get_elem", function(object) standardGeneric("get_elem"))  
 setMethod("get_elem",  
           signature(object = "DirSource"),  
           function(object) {  
               filename <- object@FileList[object@Position]  
               list(content = readLines(filename),  
                    uri = substitute(file(filename)))  
           })  
 setMethod("get_elem",  
           signature(object = "CSVSource"),  
           function(object) {  
               list(content = object@Content[object@Position],  
                    uri = object@URI)  
           })  
 setMethod("get_elem",  
           signature(object = "ReutersSource"),  
           function(object) {  
               # Construct a character representation from the XMLNode  
               con <- textConnection("virtual.file", "w")  
               saveXML(object@Content[[object@Position]], con)  
               close(con)  
   
               list(content = virtual.file, uri = object@URI)  
           })  
   
 setGeneric("eoi", function(object) standardGeneric("eoi"))  
 setMethod("eoi",  
           signature(object = "DirSource"),  
           function(object) {  
               if (length(object@FileList) <= object@Position)  
                   return(TRUE)  
               else  
                   return(FALSE)  
           })  
 setMethod("eoi",  
           signature(object = "CSVSource"),  
           function(object) {  
               if (length(object@Content) <= object@Position)  
                   return(TRUE)  
               else  
                   return(FALSE)  
           })  
 setMethod("eoi",  
           signature(object = "ReutersSource"),  
           function(object) {  
               if (length(object@Content) <= object@Position)  
                   return(TRUE)  
               else  
                   return(FALSE)  
           })  
   
 plaintext_parser <- function(...) {  
     function(elem, lodsupport, load, id) {  
         if (!lodsupport || (lodsupport && load)) {  
             doc <- new("PlainTextDocument", .Data = elem$content, URI = elem$uri, Cached = TRUE,  
                        Author = "", DateTimeStamp = date(), Description = "", ID = id, Origin = "", Heading = "")  
         }  
73          else {          else {
74              doc <- new("PlainTextDocument", URI = elem$uri, Cached = FALSE,          counter <- 1
75                         Author = "", DateTimeStamp = date(), Description = "", ID = id, Origin = "", Heading = "")          while (!eoi(x)) {
76          }              x <- stepNext(x)
77                elem <- getElem(x)
78          return(doc)              id <- if (is.null(x$names) || is.na(x$names))
79      }                  as.character(counter)
80  }              else
81  class(plaintext_parser) <- "function_generator"                  x$names[counter]
82                doc <- readerControl$reader(elem, readerControl$language, id)
83  reut21578xml_parser <- function(...) {              if (x$length > 0)
84      function(elem, lodsupport, load, id) {                  tdl[[counter]] <- doc
         corpus <- paste(elem$content, "\n", collapse = "")  
         tree <- xmlTreeParse(corpus, asText = TRUE)  
         node <- xmlRoot(tree)  
   
         # Mask as list to bypass S4 checks  
         class(tree) <- "list"  
   
         # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!  
         if (!is.null(node[["TEXT"]][["AUTHOR"]]))  
             author <- xmlValue(node[["TEXT"]][["AUTHOR"]])  
         else  
             author <- ""  
   
         datetimestamp <- xmlValue(node[["DATE"]])  
         description <- ""  
         id <- xmlAttrs(node)[["NEWID"]]  
   
         # The <TITLE></TITLE> tag is unfortunately NOT obligatory!  
         if (!is.null(node[["TEXT"]][["TITLE"]]))  
             heading <- xmlValue(node[["TEXT"]][["TITLE"]])  
85          else          else
86              heading <- ""                  tdl <- c(tdl, list(doc))
87                counter <- counter + 1
         topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)  
   
         if (!lodsupport || (lodsupport && load)) {  
             doc <- new("XMLTextDocument", .Data = tree, URI = elem$uri, Cached = TRUE, Author = author,  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters-21578 XML",  
                        Heading = heading, LocalMetaData = list(Topics = topics))  
         } else {  
             doc <- new("XMLTextDocument", URI = elem$uri, Cached = FALSE, Author = author,  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters-21578 XML",  
                        Heading = heading, LocalMetaData = list(Topics = topics))  
         }  
   
         return(doc)  
     }  
 }  
 class(reut21578xml_parser) <- "function_generator"  
   
 rcv1_parser <- function(...) {  
     function(elem, lodsupport, load, id) {  
         corpus <- paste(elem$content, "\n", collapse = "")  
         tree <- xmlTreeParse(corpus, asText = TRUE)  
         node <- xmlRoot(tree)  
   
         # Mask as list to bypass S4 checks  
         class(tree) <- "list"  
   
         datetimestamp <- xmlAttrs(node)[["date"]]  
         id <- xmlAttrs(node)[["itemid"]]  
         heading <- xmlValue(node[["title"]])  
   
         if (!lodsupport || (lodsupport && load)) {  
             doc <- new("XMLTextDocument", .Data = tree, URI = elem$uri, Cached = TRUE, Author = "",  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML",  
                        Heading = heading)  
         } else {  
             doc <- new("XMLTextDocument", URI = elem$uri, Cached = FALSE, Author = "",  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML",  
                        Heading = heading)  
         }  
   
         return(doc)  
88      }      }
89  }  }
90  class(rcv1_parser) <- "function_generator"      if (!is.null(x$names) && !is.na(x$names))
91            names(tdl) <- x$names
92    
93  newsgroup_parser <- function(...) {      structure(list(content = tdl,
94      function(elem, lodsupport, load, id) {                     meta = CorpusMeta(),
95          mail <- elem$content                     dmeta = data.frame(row.names = seq_along(tdl))),
96          author <- gsub("From: ", "", grep("^From:", mail, value = TRUE))                class = c("VCorpus", "Corpus"))
97          datetimestamp <- gsub("Date: ", "", grep("^Date:", mail, value = TRUE))  }
98          origin <- gsub("Path: ", "", grep("^Path:", mail, value = TRUE))  
99          heading <- gsub("Subject: ", "", grep("^Subject:", mail, value = TRUE))  `[.PCorpus` <-
100          newsgroup <- gsub("Newsgroups: ", "", grep("^Newsgroups:", mail, value = TRUE))  function(x, i)
101    {
102          if (!lodsupport || (lodsupport && load)) {      if (!missing(i)) {
103              # The header is separated from the body by a blank line.          x$content <- x$content[i]
104              # Reference: \url{http://en.wikipedia.org/wiki/E-mail#Internet_e-mail_format}          x$dmeta <- x$dmeta[i, , drop = FALSE]
105              for (index in seq(along = mail)) {      }
106                  if (mail[index] == "")      x
107                      break  }
108              }  
109              content <- mail[(index + 1):length(mail)]  `[.VCorpus` <-
110    function(x, i)
111              doc <- new("NewsgroupDocument", .Data = content, URI = elem$uri, Cached = TRUE,  {
112                         Author = author, DateTimeStamp = datetimestamp,      if (!missing(i)) {
113                         Description = "", ID = id, Origin = origin,          x$content <- x$content[i]
114                         Heading = heading, Newsgroup = newsgroup)          x$dmeta <- x$dmeta[i, , drop = FALSE]
115          } else {          if (!is.null(x$lazy))
116              doc <- new("NewsgroupDocument", URI = elem$uri, Cached = FALSE, Author = author, DateTimeStamp = datetimestamp,              x$lazy$index <- x$lazy$index[i]
117                         Description = "", ID = id, Origin = origin, Heading = heading, Newsgroup = newsgroup)      }
118          }      x
119    }
120    
121    .map_name_index <-
122    function(x, i)
123    {
124        if (is.character(i))
125            match(i, if (is.null(names(x))) meta(x, "id", "local") else names(x))
126        else
127            i
128    }
129    
130    `[[.PCorpus` <-
131    function(x, i)
132    {
133        i <- .map_name_index(x, i)
134        db <- filehash::dbInit(x$dbcontrol[["dbName"]], x$dbcontrol[["dbType"]])
135        filehash::dbFetch(db, x$content[[i]])
136    }
137    `[[.VCorpus` <-
138    function(x, i)
139    {
140        i <- .map_name_index(x, i)
141        if (!is.null(x$lazy))
142            .Call(copyCorpus, x, materialize(x, i))
143        x$content[[i]]
144    }
145    
146    `[[<-.PCorpus` <-
147    function(x, i, value)
148    {
149        i <- .map_name_index(x, i)
150        db <- filehash::dbInit(x$dbcontrol[["dbName"]], x$dbcontrol[["dbType"]])
151        db[[x$content[[i]]]] <- value
152        x
153    }
154    `[[<-.VCorpus` <-
155    function(x, i, value)
156    {
157        i <- .map_name_index(x, i)
158        # Mark new objects as inactive for lazy mapping
159        if (!is.null(x$lazy))
160            x$lazy$index[i] <- FALSE
161        x$content[[i]] <- value
162        x
163    }
164    
165    outer_union <-
166    function(x, y, ...)
167    {
168        if (nrow(x) > 0L)
169            x[, setdiff(names(y), names(x))] <- NA
170        if (nrow(y) > 0L)
171            y[, setdiff(names(x), names(y))] <- NA
172        res <- rbind(x, y)
173        if (ncol(res) == 0L)
174            res <- data.frame(row.names = seq_len(nrow(x) + nrow(y)))
175        res
176    }
177    
178    c.VCorpus <-
179    function(..., recursive = FALSE)
180    {
181        args <- list(...)
182        x <- args[[1L]]
183    
184          return(doc)      if (length(args) == 1L)
185      }          return(x)
 }  
 class(newsgroup_parser) <- "function_generator"  
186    
187  # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file      if (!all(unlist(lapply(args, inherits, class(x)))))
188  rcv1_to_plain <- function(node, ...) {          stop("not all arguments are of the same corpus type")
     datetimestamp <- xmlAttrs(node)[["date"]]  
     id <- xmlAttrs(node)[["itemid"]]  
     origin <- "Reuters Corpus Volume 1 XML"  
     corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)  
     heading <- xmlValue(node[["title"]])  
189    
190      new("PlainTextDocument", .Data = corpus, Cached = TRUE, URI = "", Author = "", DateTimeStamp = datetimestamp,      structure(list(content = do.call("c", lapply(args, content)),
191          Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML", Heading = heading)                     meta = structure(do.call("c",
192                         lapply(args, function(a) meta(a, type = "corpus"))),
193                                        class = "CorpusMeta"),
194                       dmeta = Reduce(outer_union, lapply(args, meta))),
195                  class = c("VCorpus", "Corpus"))
196    }
197    
198    as.list.PCorpus <- as.list.VCorpus <-
199    function(x, ...)
200        content(x)
201    
202    content.VCorpus <-
203    function(x)
204    {
205        if (!is.null(x$lazy))
206            .Call(copyCorpus, x, materialize(x))
207        x$content
208    }
209    
210    content.PCorpus <-
211    function(x)
212    {
213        db <- filehash::dbInit(x$dbcontrol[["dbName"]], x$dbcontrol[["dbType"]])
214        filehash::dbMultiFetch(db, unlist(x$content))
215    }
216    
217    length.PCorpus <- length.VCorpus <-
218    function(x)
219        length(x$content)
220    
221    print.PCorpus <- print.VCorpus <-
222    function(x, ...)
223    {
224        writeLines(sprintf("<<%s (documents: %d, metadata (corpus/indexed): %d/%d)>>",
225                           class(x)[1],
226                           length(x),
227                           length(meta(x, type = "corpus")),
228                           ncol(meta(x, type = "indexed"))))
229        invisible(x)
230    }
231    
232    inspect <-
233    function(x)
234        UseMethod("inspect", x)
235    inspect.PCorpus <- inspect.VCorpus <-
236    function(x)
237    {
238        print(x)
239        cat("\n")
240        print(noquote(content(x)))
241        invisible(x)
242  }  }
243    
244  # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file  writeCorpus <-
245  reut21578xml_to_plain <- function(node, ...) {  function(x, path = ".", filenames = NULL)
246      # The <AUTHOR></AUTHOR> tag is unfortunately NOT obligatory!  {
247      if (!is.null(node[["TEXT"]][["AUTHOR"]]))      filenames <- file.path(path,
248          author <- xmlValue(node[["TEXT"]][["AUTHOR"]])        if (is.null(filenames))
249      else            sprintf("%s.txt", as.character(meta(x, "id", "local")))
250          author <- ""        else filenames)
   
     datetimestamp <- xmlValue(node[["DATE"]])  
     description <- ""  
     id <- xmlAttrs(node)[["NEWID"]]  
   
     origin <- "Reuters-21578 XML"  
   
     # The <BODY></BODY> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["BODY"]]))  
         corpus <- xmlValue(node[["TEXT"]][["BODY"]])  
     else  
         corpus <- ""  
   
     # The <TITLE></TITLE> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["TITLE"]]))  
         heading <- xmlValue(node[["TEXT"]][["TITLE"]])  
     else  
         heading <- ""  
251    
252      topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)      stopifnot(length(x) == length(filenames))
253    
254      new("PlainTextDocument", .Data = corpus, Cached = TRUE, URI = "", Author = author, DateTimeStamp = datetimestamp,      mapply(function(doc, f) writeLines(as.character(doc), f), x, filenames)
         Description = description, ID = id, Origin = origin, Heading = heading, LocalMetaData = list(Topics = topics))  
 }  
255    
256  setGeneric("load_doc", function(object, ...) standardGeneric("load_doc"))      invisible(x)
 setMethod("load_doc",  
           signature(object = "PlainTextDocument"),  
           function(object, ...) {  
               if (!Cached(object)) {  
                   con <- eval(URI(object))  
                   corpus <- readLines(con)  
                   close(con)  
                   Corpus(object) <- corpus  
                   Cached(object) <- TRUE  
                   return(object)  
               } else {  
                   return(object)  
               }  
           })  
 setMethod("load_doc",  
           signature(object =  "XMLTextDocument"),  
           function(object, ...) {  
               if (!Cached(object)) {  
                   con <- eval(URI(object))  
                   corpus <- paste(readLines(con), "\n", collapse = "")  
                   close(con)  
                   doc <- xmlTreeParse(corpus, asText = TRUE)  
                   class(doc) <- "list"  
                   Corpus(object) <- doc  
                   Cached(object) <- TRUE  
                   return(object)  
               } else {  
                   return(object)  
               }  
           })  
 setMethod("load_doc",  
           signature(object = "NewsgroupDocument"),  
           function(object, ...) {  
               if (!Cached(object)) {  
                   con <- eval(URI(object))  
                   mail <- readLines(con)  
                   close(con)  
                   Cached(object) <- TRUE  
                   for (index in seq(along = mail)) {  
                       if (mail[index] == "")  
                           break  
                   }  
                   Corpus(object) <- mail[(index + 1):length(mail)]  
                   return(object)  
               } else {  
                   return(object)  
               }  
           })  
   
 setGeneric("tm_update", function(object, origin, parser = plaintext_parser, ...) standardGeneric("tm_update"))  
 # Update is only supported for directories  
 # At the moment no other LoD devices are available anyway  
 setMethod("tm_update",  
           signature(object = "TextDocCol", origin = "DirSource"),  
           function(object, origin, parser = plaintext_parser, ...) {  
               if (inherits(parser, "function_generator"))  
                   parser <- parser(...)  
   
               object.filelist <- unlist(lapply(object, function(x) {as.character(URI(x))[2]}))  
               new.files <- setdiff(origin@FileList, object.filelist)  
   
               for (filename in new.files) {  
                   elem <- list(content = readLines(filename),  
                                uri = substitute(file(filename)))  
                   object <- append_doc(object, parser(elem, TRUE, origin@Load, filename), NA)  
               }  
   
               return(object)  
           })  
   
 setGeneric("tm_transform", function(object, FUN, ...) standardGeneric("tm_transform"))  
 setMethod("tm_transform",  
           signature(object = "TextDocCol", FUN = "function"),  
           function(object, FUN, ...) {  
               result <- object  
               result@.Data <- lapply(object, FUN, ..., DMetaData = DMetaData(object))  
               return(result)  
           })  
   
 setGeneric("as.plaintext_doc", function(object, FUN, ...) standardGeneric("as.plaintext_doc"))  
 setMethod("as.plaintext_doc",  
           signature(object = "PlainTextDocument"),  
           function(object, FUN, ...) {  
               return(object)  
           })  
 setMethod("as.plaintext_doc",  
           signature(object = "XMLTextDocument", FUN = "function"),  
           function(object, FUN, ...) {  
               if (!Cached(object))  
                   object <- load_doc(object)  
   
               corpus <- Corpus(object)  
   
               # As XMLDocument is no native S4 class, restore valid information  
               class(corpus) <- "XMLDocument"  
               names(corpus) <- c("doc","dtd")  
   
               return(FUN(xmlRoot(corpus), ...))  
           })  
   
 setGeneric("tm_tolower", function(object, ...) standardGeneric("tm_tolower"))  
 setMethod("tm_tolower",  
           signature(object = "PlainTextDocument"),  
           function(object, ...) {  
               if (!Cached(object))  
                   object <- load_doc(object)  
   
               Corpus(object) <- tolower(object)  
               return(object)  
           })  
   
 setGeneric("strip_whitespace", function(object, ...) standardGeneric("strip_whitespace"))  
 setMethod("strip_whitespace",  
           signature(object = "PlainTextDocument"),  
           function(object, ...) {  
               if (!Cached(object))  
                   object <- load_doc(object)  
   
               Corpus(object) <- gsub("[[:space:]]+", " ", object)  
               return(object)  
           })  
   
 setGeneric("stem_doc", function(object, ...) standardGeneric("stem_doc"))  
 setMethod("stem_doc",  
           signature(object = "PlainTextDocument"),  
           function(object, ...) {  
               if (!Cached(object))  
                   object <- load_doc(object)  
   
               require(Rstem)  
               splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))  
               stemmedCorpus <- wordStem(splittedCorpus)  
               Corpus(object) <- paste(stemmedCorpus, collapse = " ")  
               return(object)  
           })  
   
 setGeneric("remove_words", function(object, stopwords, ...) standardGeneric("remove_words"))  
 setMethod("remove_words",  
           signature(object = "PlainTextDocument", stopwords = "character"),  
           function(object, stopwords, ...) {  
               if (!Cached(object))  
                   object <- load_doc(object)  
   
               require(Rstem)  
               splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))  
               noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]  
               Corpus(object) <- paste(noStopwordsCorpus, collapse = " ")  
               return(object)  
           })  
   
 setGeneric("tm_filter", function(object, ..., FUN = s_filter, doclevel = FALSE) standardGeneric("tm_filter"))  
 setMethod("tm_filter",  
           signature(object = "TextDocCol"),  
           function(object, ..., FUN = s_filter, doclevel = FALSE) {  
               if (doclevel)  
                   return(object[sapply(object, FUN, ..., DMetaData = DMetaData(object))])  
               else  
                   return(object[FUN(object, ...)])  
           })  
   
 setGeneric("tm_index", function(object, ..., FUN = s_filter, doclevel = FALSE) standardGeneric("tm_index"))  
 setMethod("tm_index",  
           signature(object = "TextDocCol"),  
           function(object, ..., FUN = s_filter, doclevel = FALSE) {  
               if (doclevel)  
                   return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))  
               else  
                   return(FUN(object, ...))  
           })  
   
 s_filter <- function(object, s, ...) {  
     query.df <- DMetaData(object)  
     con <- textConnection(s)  
     tokens <- scan(con, "character")  
     close(con)  
     local.meta <- lapply(object, LocalMetaData)  
     local.used.meta <- lapply(local.meta, function(x) names(x) %in% tokens)  
     l.meta <- NULL  
     for (i in 1:length(object)) {  
         l.meta <- c(l.meta, list(local.meta[[i]][local.used.meta[[i]]]))  
     }  
     # Load local meta data from text documents into data frame  
     for (i in 1:length(l.meta)) {  
         l.meta[[i]] <- c(l.meta[[i]], list(author = Author(object[[i]])))  
         l.meta[[i]] <- c(l.meta[[i]], list(datetimestamp = DateTimeStamp(object[[i]])))  
         l.meta[[i]] <- c(l.meta[[i]], list(description = Description(object[[i]])))  
         l.meta[[i]] <- c(l.meta[[i]], list(identifier = ID(object[[i]])))  
         l.meta[[i]] <- c(l.meta[[i]], list(origin = Origin(object[[i]])))  
         l.meta[[i]] <- c(l.meta[[i]], list(heading = Heading(object[[i]])))  
     }  
     for (i in 1:length(l.meta)) {  
         for (j in 1:length(l.meta[[i]])) {  
             m <- l.meta[[i]][[j]]  
             m.name <- names(l.meta[[i]][j])  
             if (!(m.name %in% names(query.df))) {  
                 before <- rep(NA, i - 1)  
                 after <- rep(NA, length(l.meta) - i)  
                 if (length(m) > 1) {  
                     nl <- vector("list", length(l.meta))  
                     nl[1:(i-1)] <- before  
                     nl[i] <- list(m)  
                     nl[(i+1):length(l.meta)] <- after  
                     insert <- data.frame(I(nl), stringsAsFactors = FALSE)  
                 }  
                 else  
                     insert <- c(before, m, after)  
                 query.df <- cbind(query.df, insert, stringsAsFactors = FALSE)  
                 names(query.df)[length(query.df)] <- m.name  
257              }              }
             else {  
                 if (is.null(m))  
                     m <- NA  
                 if (length(m) > 1) {  
                     rl <- query.df[ , m.name]  
                     rl[i] <- list(m)  
                     query.df[ , m.name] <- data.frame(I(rl), stringsAsFactors = FALSE)  
                 }  
                 else  
                     query.df[i, m.name] <- m  
             }  
         }  
     }  
     attach(query.df)  
     try(result <- rownames(query.df) %in% row.names(query.df[eval(parse(text = s)), ]))  
     detach(query.df)  
     return(result)  
 }  
   
 setGeneric("fulltext_search_filter", function(object, pattern, ...) standardGeneric("fulltext_search_filter"))  
 setMethod("fulltext_search_filter",  
           signature(object = "PlainTextDocument", pattern = "character"),  
           function(object, pattern, ...) {  
               if (!Cached(object))  
                   object <- load_doc(object)  
   
               return(any(grep(pattern, Corpus(object))))  
           })  
   
 setGeneric("attach_data", function(object, data) standardGeneric("attach_data"))  
 setGeneric("attach_metadata", function(object, name, metadata) standardGeneric("attach_metadata"))  
   
 setGeneric("append_doc", function(object, data, meta = NULL) standardGeneric("append_doc"))  
 setMethod("append_doc",  
           signature(object = "TextDocCol", data = "TextDocument"),  
           function(object, data, meta = NULL) {  
               object@.Data <- c(object@.Data, list(data))  
               object@DMetaData <- rbind(object@DMetaData, c(MetaID = DCMetaData(object)@NodeID, meta))  
               return(object)  
           })  
   
 setGeneric("append_meta", function(object, dcmeta = list(), dmeta = NULL) standardGeneric("append_meta"))  
 setMethod("append_meta",  
           signature(object = "TextDocCol"),  
           function(object, dcmeta = list(), dmeta = NULL) {  
               object@DCMetaData@MetaData <- c(object@DCMetaData@MetaData, dcmeta)  
               if (length(dmeta) > 0)  
                   object@DMetaData <- cbind(object@DMetaData, dmeta)  
               return(object)  
           })  
   
 setGeneric("remove_metadata", function(object, name) standardGeneric("remove_metadata"))  
 #setMethod("remove_metadata",  
 #          signature(object = "TextDocCol"),  
 #          function(object, name) {  
 #              object@DMetaData <- DMetaData(object)[names(DMetaData(object)) != name]  
 #              return(object)  
 #          })  
   
 setGeneric("modify_metadata", function(object, name, metadata) standardGeneric("modify_metadata"))  
 #setMethod("modify_metadata",  
 #          signature(object = "TextDocCol"),  
 #          function(object, name, metadata) {  
 #              object@DMetaData[[name]] <- metadata  
 #              return(object)  
 #          })  
   
 setGeneric("prescind_meta", function(object, meta) standardGeneric("prescind_meta"))  
 setMethod("prescind_meta",  
           signature(object = "TextDocCol", meta = "character"),  
           function(object, meta) {  
               for (m in meta) {  
                   if (m %in% c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading")) {  
                       local.m <- lapply(object, m)  
                       local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))  
                       local.m <- unlist(local.m)  
                       object@DMetaData <- cbind(DMetaData(object), data.frame(m = local.m), stringsAsFactors = FALSE)  
                       names(object@DMetaData)[length(object@DMetaData)] <- m  
                   }  
                   else {  
                       local.meta <- lapply(object, LocalMetaData)  
                       local.m <- lapply(local.meta, "[[", m)  
                       local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))  
                       if (length(local.m) == length(unlist(local.m)))  
                           local.m <- unlist(local.m)  
                       else  
                           local.m <- I(local.m)  
                       object@DMetaData <- cbind(DMetaData(object), data.frame(m = local.m), stringsAsFactors = FALSE)  
                       names(object@DMetaData)[length(object@DMetaData)] <- m  
                   }  
               }  
               return(object)  
           })  
   
 setMethod("[",  
           signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),  
           function(x, i, j, ... , drop) {  
               if(missing(i))  
                   return(x)  
   
               object <- x  
               object@.Data <- x@.Data[i, ..., drop = FALSE]  
               df <- as.data.frame(DMetaData(object)[i, ])  
               names(df) <- names(DMetaData(object))  
               object@DMetaData <- df  
               return(object)  
           })  
   
 setMethod("[<-",  
           signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),  
           function(x, i, j, ... , value) {  
               object <- x  
               object@.Data[i, ...] <- value  
               return(object)  
           })  
   
 setMethod("[[",  
           signature(x = "TextDocCol", i = "ANY", j = "ANY"),  
           function(x, i, j, ...) {  
               return(x@.Data[[i, ...]])  
           })  
   
 setMethod("[[<-",  
           signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),  
           function(x, i, j, ..., value) {  
               object <- x  
               object@.Data[[i, ...]] <- value  
               return(object)  
           })  
   
 # Update \code{NodeID}s of a DCMetaData tree  
 # TODO: Avoid global variables outside of update_id function  
 update_id <- function(object) {  
     id <<- 0  
     mapping <<- left.mapping <<- NULL  
     level <<- 0  
     return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))  
 }  
   
 # Traversal of (binary) DCMetaData tree with setup of \code{NodeID}s  
 set_id <- function(object) {  
     object@NodeID <- id  
     id <<- id + 1  
     level <<- level + 1  
   
     if (length(object@children) > 0) {  
         mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))  
         left <- set_id(object@children[[1]])  
         if (level == 1) {  
             left.mapping <<- mapping  
             mapping <<- NULL  
         }  
         mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))  
         right <- set_id(object@children[[2]])  
   
         object@children <- list(left, right)  
     }  
     level <<- level - 1  
   
     return(object)  
 }  
   
 setMethod("c",  
           signature(x = "TextDocCol"),  
           function(x, y, ..., meta = list(merge_date = date(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {  
               if (!inherits(y, "TextDocCol"))  
                   stop("invalid argument")  
   
               object <- x  
               # Concatenate data slots  
               object@.Data <- c(as(x, "list"), as(y, "list"))  
   
               # Update the DCMetaData tree  
               dcmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(DCMetaData(x), DCMetaData(y)))  
               update.struct <- update_id(dcmeta)  
               object@DCMetaData <- update.struct$root  
   
               # Find indices to be updated for the left tree  
               indices.mapping <- NULL  
               for (m in levels(as.factor(DMetaData(x)$MetaID))) {  
                   indices <- (DMetaData(x)$MetaID == m)  
                   indices.mapping <- c(indices.mapping, list(m = indices))  
                   names(indices.mapping)[length(indices.mapping)] <- m  
               }  
   
               # Update the DMetaData data frames for the left tree  
               for (i in 1:ncol(update.struct$left.mapping)) {  
                   map <- update.struct$left.mapping[,i]  
                   x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])  
               }  
   
               # Find indices to be updated for the right tree  
               indices.mapping <- NULL  
               for (m in levels(as.factor(DMetaData(y)$MetaID))) {  
                   indices <- (DMetaData(y)$MetaID == m)  
                   indices.mapping <- c(indices.mapping, list(m = indices))  
                   names(indices.mapping)[length(indices.mapping)] <- m  
               }  
   
               # Update the DMetaData data frames for the right tree  
               for (i in 1:ncol(update.struct$right.mapping)) {  
                   map <- update.struct$right.mapping[,i]  
                   y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])  
               }  
   
               # Merge the DMetaData data frames  
               labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))  
               na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))  
               x.dmeta.aug <- cbind(DMetaData(x), na.matrix)  
               labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))  
               na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))  
               y.dmeta.aug <- cbind(DMetaData(y), na.matrix)  
               object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)  
   
               return(object)  
           })  
 setMethod("c",  
           signature(x = "TextDocument"),  
           function(x, ..., recursive = TRUE){  
               args <- list(...)  
               if(length(args) == 0)  
                   return(x)  
   
               dmeta.df <- data.frame(MetaID = rep(0, length(list(x, ...))), stringsAsFactors = FALSE)  
               dcmeta.node <- new("MetaDataNode",  
                             NodeID = 0,  
                             MetaData = list(create_date = date(), creator = Sys.getenv("LOGNAME")),  
                             children = list())  
   
               return(new("TextDocCol", .Data = list(x, ...), DMetaData = dmeta.df, DCMetaData = dcmeta.node))  
           })  
   
 setMethod("length",  
           signature(x = "TextDocCol"),  
           function(x){  
               return(length(as(x, "list")))  
     })  
   
 setMethod("show",  
           signature(object = "TextDocCol"),  
           function(object){  
               cat(sprintf(ngettext(length(object),  
                                    "A text document collection with %d text document\n",  
                                    "A text document collection with %d text documents\n"),  
                           length(object)))  
     })  
   
 setMethod("summary",  
           signature(object = "TextDocCol"),  
           function(object){  
               show(object)  
               if (length(DMetaData(object)) > 0) {  
                   cat(sprintf(ngettext(length(DMetaData(object)),  
                                               "\nThe global metadata consists of %d tag-value pair\n",  
                                               "\nThe global metadata consists of %d tag-value pairs\n"),  
                                        length(DMetaData(object))))  
                   cat("Available tags are:\n")  
                   cat(names(DMetaData(object)), "\n")  
               }  
     })  
   
 setGeneric("inspect", function(object) standardGeneric("inspect"))  
 setMethod("inspect",  
           signature("TextDocCol"),  
           function(object) {  
               summary(object)  
               cat("\n")  
               show(as(object, "list"))  
           })  
   
 # No metadata is checked  
 setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))  
 setMethod("%IN%",  
           signature(x = "TextDocument", y = "TextDocCol"),  
           function(x, y) {  
               x %in% y  
           })  

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

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