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

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

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