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

Legend:
Removed from v.66  
changed lines
  Added in v.769

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