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

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

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