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

Legend:
Removed from v.65  
changed lines
  Added in v.744

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