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 722, Sun Apr 1 15:53:58 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 = readPlain, 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 = readPlain, 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)  
37                else                else
38                    return(FALSE)                        tdl <- c(tdl, list(doc))
39            })                    counter <- counter + 1
 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"]])  
         else  
             heading <- ""  
   
         topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)  
   
         if (!lodsupport || (lodsupport && load)) {  
             doc <- new("XMLTextDocument", .Data = tree, URI = elem$uri, Cached = TRUE, Author = author,  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters-21578 XML",  
                        Heading = heading, LocalMetaData = list(Topics = topics))  
         } else {  
             doc <- new("XMLTextDocument", URI = elem$uri, Cached = FALSE, Author = author,  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters-21578 XML",  
                        Heading = heading, LocalMetaData = list(Topics = topics))  
         }  
   
         return(doc)  
     }  
 }  
 class(reut21578xml_parser) <- "function_generator"  
   
 rcv1_parser <- function(...) {  
     function(elem, lodsupport, load, id) {  
         corpus <- paste(elem$content, "\n", collapse = "")  
         tree <- xmlTreeParse(corpus, asText = TRUE)  
         node <- xmlRoot(tree)  
   
         # Mask as list to bypass S4 checks  
         class(tree) <- "list"  
   
         datetimestamp <- xmlAttrs(node)[["date"]]  
         id <- xmlAttrs(node)[["itemid"]]  
         heading <- xmlValue(node[["title"]])  
   
         if (!lodsupport || (lodsupport && load)) {  
             doc <- new("XMLTextDocument", .Data = tree, URI = elem$uri, Cached = TRUE, Author = "",  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML",  
                        Heading = heading)  
         } else {  
             doc <- new("XMLTextDocument", URI = elem$uri, Cached = FALSE, Author = "",  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML",  
                        Heading = heading)  
         }  
   
         return(doc)  
     }  
 }  
 class(rcv1_parser) <- "function_generator"  
   
 newsgroup_parser <- function(...) {  
     function(elem, lodsupport, load, id) {  
         mail <- elem$content  
         author <- gsub("From: ", "", grep("^From:", mail, value = TRUE))  
         datetimestamp <- gsub("Date: ", "", grep("^Date:", mail, value = TRUE))  
         origin <- gsub("Path: ", "", grep("^Path:", mail, value = TRUE))  
         heading <- gsub("Subject: ", "", grep("^Subject:", mail, value = TRUE))  
         newsgroup <- gsub("Newsgroups: ", "", grep("^Newsgroups:", mail, value = TRUE))  
   
         if (!lodsupport || (lodsupport && load)) {  
             # The header is separated from the body by a blank line.  
             # Reference: \url{http://en.wikipedia.org/wiki/E-mail#Internet_e-mail_format}  
             for (index in seq(along = mail)) {  
                 if (mail[index] == "")  
                     break  
             }  
             content <- mail[(index + 1):length(mail)]  
   
             doc <- new("NewsgroupDocument", .Data = content, URI = elem$uri, Cached = TRUE,  
                        Author = author, DateTimeStamp = datetimestamp,  
                        Description = "", ID = id, Origin = origin,  
                        Heading = heading, Newsgroup = newsgroup)  
         } else {  
             doc <- new("NewsgroupDocument", URI = elem$uri, Cached = FALSE, Author = author, DateTimeStamp = datetimestamp,  
                        Description = "", ID = id, Origin = origin, Heading = heading, Newsgroup = newsgroup)  
         }  
   
         return(doc)  
     }  
40  }  }
 class(newsgroup_parser) <- "function_generator"  
   
 # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file  
 rcv1_to_plain <- function(node, ...) {  
     datetimestamp <- xmlAttrs(node)[["date"]]  
     id <- xmlAttrs(node)[["itemid"]]  
     origin <- "Reuters Corpus Volume 1 XML"  
     corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)  
     heading <- xmlValue(node[["title"]])  
41    
42      new("PlainTextDocument", .Data = corpus, Cached = TRUE, URI = "", Author = "", DateTimeStamp = datetimestamp,                df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)
43          Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML", Heading = heading)                if (dbControl$useDb) {
44                      dbInsert(db, "DMetaData", df)
45                      dmeta.df <- data.frame(key = "DMetaData")
46                      dbDisconnect(db)
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 = readPlain, 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 = readPlain, 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 375  Line 171 
171                return(FUN(xmlRoot(corpus), ...))                return(FUN(xmlRoot(corpus), ...))
172            })            })
173    
174  setGeneric("stem_doc", function(object, ...) standardGeneric("stem_doc"))  setGeneric("tmTolower", function(object, ...) standardGeneric("tmTolower"))
175  setMethod("stem_doc",  setMethod("tmTolower",
176              signature(object = "PlainTextDocument"),
177              function(object, ...) {
178                  Corpus(object) <- tolower(object)
179                  return(object)
180              })
181    
182    setGeneric("stripWhitespace", function(object, ...) standardGeneric("stripWhitespace"))
183    setMethod("stripWhitespace",
184            signature(object = "PlainTextDocument"),            signature(object = "PlainTextDocument"),
185            function(object, ...) {            function(object, ...) {
186                if (!Cached(object))                Corpus(object) <- gsub("[[:space:]]+", " ", object)
187                    object <- load_doc(object)                return(object)
188              })
189    
190                require(Rstem)  setGeneric("stemDoc", function(object, language = "english", ...) standardGeneric("stemDoc"))
191    setMethod("stemDoc",
192              signature(object = "PlainTextDocument"),
193              function(object, language = "english", ...) {
194                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))
195                stemmedCorpus <- wordStem(splittedCorpus, ...)                stemmedCorpus <- if (require("Rstem"))
196                      Rstem::wordStem(splittedCorpus, language)
197                  else
198                      SnowballStemmer(splittedCorpus, Weka_control(S = language))
199                Corpus(object) <- paste(stemmedCorpus, collapse = " ")                Corpus(object) <- paste(stemmedCorpus, collapse = " ")
200                return(object)                return(object)
201            })            })
202    
203  setGeneric("remove_words", function(object, stopwords, ...) standardGeneric("remove_words"))  setGeneric("removePunctuation", function(object, ...) standardGeneric("removePunctuation"))
204  setMethod("remove_words",  setMethod("removePunctuation",
205              signature(object = "PlainTextDocument"),
206              function(object, ...) {
207                  Corpus(object) <- gsub("[[:punct:]]+", "", Corpus(object))
208                  return(object)
209              })
210    
211    setGeneric("removeWords", function(object, stopwords, ...) standardGeneric("removeWords"))
212    setMethod("removeWords",
213            signature(object = "PlainTextDocument", stopwords = "character"),            signature(object = "PlainTextDocument", stopwords = "character"),
214            function(object, stopwords, ...) {            function(object, stopwords, ...) {
               if (!Cached(object))  
                   object <- load_doc(object)  
   
               require(Rstem)  
215                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))
216                noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]                noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]
217                Corpus(object) <- paste(noStopwordsCorpus, collapse = " ")                Corpus(object) <- paste(noStopwordsCorpus, collapse = " ")
218                return(object)                return(object)
219            })            })
220    
221  setGeneric("tm_filter", function(object, ..., FUN = s_filter) standardGeneric("tm_filter"))  setGeneric("tmFilter", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmFilter"))
222  setMethod("tm_filter",  setMethod("tmFilter",
223            signature(object = "TextDocCol"),            signature(object = "TextDocCol"),
224            function(object, ..., FUN = s_filter) {            function(object, ..., FUN = sFilter, doclevel = FALSE) {
225                object[tm_index(object, ..., FUN)]                if (doclevel)
226                      return(object[sapply(object, FUN, ..., DMetaData = DMetaData(object))])
227                  else
228                      return(object[FUN(object, ...)]) # TODO: Check that FUN knows about the database
229            })            })
230    
231  setGeneric("tm_index", function(object, ..., FUN = s_filter) standardGeneric("tm_index"))  setGeneric("tmIndex", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmIndex"))
232  setMethod("tm_index",  setMethod("tmIndex",
233            signature(object = "TextDocCol"),            signature(object = "TextDocCol"),
234            function(object, ..., FUN = s_filter) {            function(object, ..., FUN = sFilter, doclevel = FALSE) {
235                sapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object))                if (doclevel)
236                      return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))
237                  else
238                      return(FUN(object, ...)) # TODO: Check that FUN knows about the database
239            })            })
240    
241  s_filter <- function(object, s, ..., GlobalMetaData) {  sFilter <- function(object, s, ...) {
242      b <- TRUE      con <- textConnection(s)
243      for (tag in names(s)) {      tokens <- scan(con, "character")
244          if (tag %in% names(LocalMetaData(object))) {      close(con)
245              b <- b && any(grep(s[[tag]], LocalMetaData(object)[[tag]]))      localMetaNames <- unique(names(sapply(object, LocalMetaData)))
246          } else if (tag %in% names(GlobalMetaData)){      localMetaTokens <- localMetaNames[localMetaNames %in% tokens]
247              b <- b && any(grep(s[[tag]], GlobalMetaData[[tag]]))      query.df <- DMetaData(prescindMeta(object,
248          } else {                                         c("Author", "DateTimeStamp", "Description", "ID",
249              b <- b && any(grep(s[[tag]], eval(call(tag, object))))                                           "Origin", "Heading", "Language", localMetaTokens)))
250          }      # Rename to avoid name conflicts
251      }      names(query.df)[names(query.df) == "Author"] <- "author"
252      return(b)      names(query.df)[names(query.df) == "DateTimeStamp"] <- "datetimestamp"
253        names(query.df)[names(query.df) == "Description"] <- "description"
254        names(query.df)[names(query.df) == "ID"] <- "identifier"
255        names(query.df)[names(query.df) == "Origin"] <- "origin"
256        names(query.df)[names(query.df) == "Heading"] <- "heading"
257        names(query.df)[names(query.df) == "Language"] <- "language"
258        attach(query.df)
259        try(result <- rownames(query.df) %in% row.names(query.df[eval(parse(text = s)), ]))
260        detach(query.df)
261        return(result)
262  }  }
263    
264  setGeneric("fulltext_search_filter", function(object, pattern, ...) standardGeneric("fulltext_search_filter"))  setGeneric("searchFullText", function(object, pattern, ...) standardGeneric("searchFullText"))
265  setMethod("fulltext_search_filter",  setMethod("searchFullText",
266            signature(object = "PlainTextDocument", pattern = "character"),            signature(object = "PlainTextDocument", pattern = "character"),
267            function(object, pattern, ...) {            function(object, pattern, ...) {
               if (!Cached(object))  
                   object <- load_doc(object)  
   
268                return(any(grep(pattern, Corpus(object))))                return(any(grep(pattern, Corpus(object))))
269            })            })
270    
271  setGeneric("attach_data", function(object, data) standardGeneric("attach_data"))  setGeneric("appendElem", function(object, data, meta = NULL) standardGeneric("appendElem"))
272  setMethod("attach_data",  setMethod("appendElem",
273            signature(object = "TextDocCol", data = "TextDocument"),            signature(object = "TextDocCol", data = "TextDocument"),
274            function(object, data) {            function(object, data, meta = NULL) {
275                data <- as(list(data), "TextDocCol")                if (DBControl(object)[["useDb"]]) {
276                object@.Data <- as(c(object@.Data, data), "TextDocCol")                    db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
277                      if (dbExists(db, ID(data)))
278                          warning("document with identical ID already exists")
279                      dbInsert(db, ID(data), data)
280                      dbDisconnect(db)
281                      object@.Data[[length(object)+1]] <- ID(data)
282                  }
283                  else
284                      object@.Data[[length(object)+1]] <- data
285                  DMetaData(object) <- rbind(DMetaData(object), c(MetaID = CMetaData(object)@NodeID, meta))
286                return(object)                return(object)
287            })            })
288    
289  setGeneric("attach_metadata", function(object, name, metadata) standardGeneric("attach_metadata"))  setGeneric("appendMeta", function(object, cmeta = NULL, dmeta = NULL) standardGeneric("appendMeta"))
290  setMethod("attach_metadata",  setMethod("appendMeta",
291            signature(object = "TextDocCol"),            signature(object = "TextDocCol"),
292            function(object, name, metadata) {            function(object, cmeta = NULL, dmeta = NULL) {
293                object@GlobalMetaData <- c(GlobalMetaData(object), new = list(metadata))                object@CMetaData@MetaData <- c(CMetaData(object)@MetaData, cmeta)
294                names(object@GlobalMetaData)[length(names(GlobalMetaData(object)))] <- name                if (!is.null(dmeta)) {
295                      DMetaData(object) <- cbind(DMetaData(object), eval(dmeta))
296                  }
297                return(object)                return(object)
298            })            })
299    
300  setGeneric("set_subscriptable", function(object, name) standardGeneric("set_subscriptable"))  setGeneric("removeMeta", function(object, cname = NULL, dname = NULL) standardGeneric("removeMeta"))
301  setMethod("set_subscriptable",  setMethod("removeMeta",
302            signature(object = "TextDocCol"),            signature(object = "TextDocCol"),
303            function(object, name) {            function(object, cname = NULL, dname = NULL) {
304                if (!is.character(GlobalMetaData(object)$subscriptable))                if (!is.null(cname)) {
305                    object <- attach_metadata(object, "subscriptable", name)                    object@CMetaData@MetaData <- CMetaData(object)@MetaData[names(CMetaData(object)@MetaData) != cname]
306                  }
307                  if (!is.null(dname)) {
308                      DMetaData(object) <- DMetaData(object)[names(DMetaData(object)) != dname]
309                  }
310                  return(object)
311              })
312    
313    # WARNING: If dbUse the augmented dataframe is stored (watch out since sFilter calls this method)
314    setGeneric("prescindMeta", function(object, meta) standardGeneric("prescindMeta"))
315    setMethod("prescindMeta",
316              signature(object = "TextDocCol", meta = "character"),
317              function(object, meta) {
318                  for (m in meta) {
319                      if (m %in% c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language")) {
320                          local.m <- lapply(object, m)
321                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
322                          local.m <- unlist(local.m)
323                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
324                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
325                      }
326                      else {
327                          local.meta <- lapply(object, LocalMetaData)
328                          local.m <- lapply(local.meta, "[[", m)
329                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
330                          if (length(local.m) == length(unlist(local.m)))
331                              local.m <- unlist(local.m)
332                else                else
333                    object@GlobalMetaData$subscriptable <- c(GlobalMetaData(object)$subscriptable, name)                            local.m <- I(local.m)
334                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
335                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
336                      }
337                  }
338                return(object)                return(object)
339            })            })
340    
341    # WARNING: DMetaData is changed (since both use the same database)
342  setMethod("[",  setMethod("[",
343            signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),            signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),
344            function(x, i, j, ... , drop) {            function(x, i, j, ... , drop) {
# Line 478  Line 347 
347    
348                object <- x                object <- x
349                object@.Data <- x@.Data[i, ..., drop = FALSE]                object@.Data <- x@.Data[i, ..., drop = FALSE]
350                for (m in names(GlobalMetaData(object))) {                df <- as.data.frame(DMetaData(x)[i, ])
351                    if (m %in% GlobalMetaData(object)$subscriptable) {                names(df) <- names(DMetaData(x))
352                        object@GlobalMetaData[[m]] <- GlobalMetaData(object)[[m]][i, ..., drop = FALSE]                DMetaData(object) <- df
                   }  
               }  
353                return(object)                return(object)
354            })            })
355    
356    # TODO
357  setMethod("[<-",  setMethod("[<-",
358            signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),            signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),
359            function(x, i, j, ... , value) {            function(x, i, j, ... , value) {
# Line 497  Line 365 
365  setMethod("[[",  setMethod("[[",
366            signature(x = "TextDocCol", i = "ANY", j = "ANY"),            signature(x = "TextDocCol", i = "ANY", j = "ANY"),
367            function(x, i, j, ...) {            function(x, i, j, ...) {
368                return(x@.Data[[i, ...]])                if (DBControl(x)[["useDb"]]) {
369                      db <- dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
370                      result <- dbFetch(db, x@.Data[[i]])
371                      dbDisconnect(db)
372                      return(loadDoc(result))
373                  }
374                  else
375                      return(loadDoc(x@.Data[[i]]))
376            })            })
377    
378  setMethod("[[<-",  setMethod("[[<-",
379            signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),            signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),
380            function(x, i, j, ..., value) {            function(x, i, j, ..., value) {
381                object <- x                object <- x
382                  if (DBControl(object)[["useDb"]]) {
383                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
384                      index <- object@.Data[[i]]
385                      db[[index]] <- value
386                      dbDisconnect(db)
387                  }
388                  else
389                object@.Data[[i, ...]] <- value                object@.Data[[i, ...]] <- value
390                return(object)                return(object)
391            })            })
392    
393    # Update \code{NodeID}s of a CMetaData tree
394    update_id <- function(object, id = 0, mapping = NULL, left.mapping = NULL, level = 0) {
395        # Traversal of (binary) CMetaData tree with setup of \code{NodeID}s
396        set_id <- function(object) {
397            object@NodeID <- id
398            id <<- id + 1
399            level <<- level + 1
400    
401            if (length(object@children) > 0) {
402                mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))
403                left <- set_id(object@children[[1]])
404                if (level == 1) {
405                    left.mapping <<- mapping
406                    mapping <<- NULL
407                }
408                mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))
409                right <- set_id(object@children[[2]])
410    
411                object@children <- list(left, right)
412            }
413            level <<- level - 1
414    
415            return(object)
416        }
417    
418        return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))
419    }
420    
421  setMethod("c",  setMethod("c",
422            signature(x = "TextDocCol"),            signature(x = "TextDocCol"),
423            function(x, ..., recursive = TRUE){            function(x, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
424                args <- list(...)                args <- list(...)
425                if(length(args) == 0)                if(length(args) == 0)
426                    return(x)                    return(x)
427                return(as(c(as(x, "list"), ...), "TextDocCol"))  
428                  if (!all(sapply(args, inherits, "TextDocCol")))
429                      stop("not all arguments are text document collections")
430                  if (DBControl(x)$useDb == TRUE || any(unlist(sapply(args, DBControl)["useDb", ])))
431                      stop("concatenating text document collections with activated database is not supported")
432    
433                  result <- x
434                  for (c in args) {
435                      result <- c2(result, c)
436                  }
437                  return(result)
438              })
439    
440    setGeneric("c2", function(x, y, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) standardGeneric("c2"))
441    setMethod("c2",
442              signature(x = "TextDocCol", y = "TextDocCol"),
443              function(x, y, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
444                  object <- x
445                  # Concatenate data slots
446                  object@.Data <- c(as(x, "list"), as(y, "list"))
447    
448                  # Set the DBControl slot
449                  object@DBControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")
450    
451                  # Update the CMetaData tree
452                  cmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(CMetaData(x), CMetaData(y)))
453                  update.struct <- update_id(cmeta)
454                  object@CMetaData <- update.struct$root
455    
456                  # Find indices to be updated for the left tree
457                  indices.mapping <- NULL
458                  for (m in levels(as.factor(DMetaData(x)$MetaID))) {
459                      indices <- (DMetaData(x)$MetaID == m)
460                      indices.mapping <- c(indices.mapping, list(m = indices))
461                      names(indices.mapping)[length(indices.mapping)] <- m
462                  }
463    
464                  # Update the DMetaData data frames for the left tree
465                  for (i in 1:ncol(update.struct$left.mapping)) {
466                      map <- update.struct$left.mapping[,i]
467                      x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
468                  }
469    
470                  # Find indices to be updated for the right tree
471                  indices.mapping <- NULL
472                  for (m in levels(as.factor(DMetaData(y)$MetaID))) {
473                      indices <- (DMetaData(y)$MetaID == m)
474                      indices.mapping <- c(indices.mapping, list(m = indices))
475                      names(indices.mapping)[length(indices.mapping)] <- m
476                  }
477    
478                  # Update the DMetaData data frames for the right tree
479                  for (i in 1:ncol(update.struct$right.mapping)) {
480                      map <- update.struct$right.mapping[,i]
481                      y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
482                  }
483    
484                  # Merge the DMetaData data frames
485                  labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))
486                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))
487                  x.dmeta.aug <- cbind(DMetaData(x), na.matrix)
488                  labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))
489                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))
490                  y.dmeta.aug <- cbind(DMetaData(y), na.matrix)
491                  object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)
492    
493                  return(object)
494      })      })
495    
496  setMethod("c",  setMethod("c",
497            signature(x = "TextDocument"),            signature(x = "TextDocument"),
498            function(x, ..., recursive = TRUE){            function(x, ..., recursive = TRUE){
499                args <- list(...)                args <- list(...)
500                if(length(args) == 0)                if(length(args) == 0)
501                    return(x)                    return(x)
502                return(new("TextDocCol", .Data = list(x, ...)))  
503                  dmeta.df <- data.frame(MetaID = rep(0, length(list(x, ...))), stringsAsFactors = FALSE)
504                  cmeta.node <- new("MetaDataNode",
505                                NodeID = 0,
506                                MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
507                                children = list())
508    
509                  return(new("TextDocCol",
510                             .Data = list(x, ...),
511                             DMetaData = dmeta.df,
512                             CMetaData = cmeta.node,
513                             DBControl = list(useDb = FALSE, dbName = "", dbType = "DB1")))
514      })      })
515    
516  setMethod("length",  setMethod("length",
# Line 534  Line 522 
522  setMethod("show",  setMethod("show",
523            signature(object = "TextDocCol"),            signature(object = "TextDocCol"),
524            function(object){            function(object){
525                cat("A text document collection with", length(object), "text document")                cat(sprintf(ngettext(length(object),
526                if (length(object) == 1)                                     "A text document collection with %d text document\n",
527                    cat("\n")                                     "A text document collection with %d text documents\n"),
528                else                            length(object)))
                   cat("s\n")  
529      })      })
530    
531  setMethod("summary",  setMethod("summary",
532            signature(object = "TextDocCol"),            signature(object = "TextDocCol"),
533            function(object){            function(object){
534                show(object)                show(object)
535                if (length(GlobalMetaData(object)) > 0) {                if (length(DMetaData(object)) > 0) {
536                    cat("\nThe global metadata consists of", length(GlobalMetaData(object)), "tag-value pair")                    cat(sprintf(ngettext(length(CMetaData(object)@MetaData),
537                    if (length(GlobalMetaData(object)) == 1)                                                "\nThe metadata consists of %d tag-value pair and a data frame\n",
538                        cat(".\n")                                                "\nThe metadata consists of %d tag-value pairs and a data frame\n"),
539                    else                                         length(CMetaData(object)@MetaData)))
                       cat("s.\n")  
540                    cat("Available tags are:\n")                    cat("Available tags are:\n")
541                    cat(names(GlobalMetaData(object)), "\n")                    cat(strwrap(paste(names(CMetaData(object)@MetaData), collapse = " "), indent = 2, exdent = 2), "\n")
542                      cat("Available variables in the data frame are:\n")
543                      cat(strwrap(paste(names(DMetaData(object)), collapse = " "), indent = 2, exdent = 2), "\n")
544                }                }
545      })      })
546    
# Line 562  Line 550 
550            function(object) {            function(object) {
551                summary(object)                summary(object)
552                cat("\n")                cat("\n")
553                show(as(object, "list"))                if (DBControl(object)[["useDb"]]) {
554                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
555                      show(dbMultiFetch(db, unlist(object)))
556                      dbDisconnect(db)
557                  }
558                  else
559                      show(object@.Data)
560            })            })
561    
562  # No metadata is checked  # No metadata is checked
# Line 572  Line 566 
566            function(x, y) {            function(x, y) {
567                x %in% y                x %in% y
568            })            })
569    
570    setMethod("lapply",
571              signature(X = "TextDocCol"),
572              function(X, FUN, ...) {
573                  if (DBControl(X)[["useDb"]]) {
574                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
575                      result <- lapply(dbMultiFetch(db, unlist(X)), FUN, ...)
576                      dbDisconnect(db)
577                  }
578                  else
579                      result <- base::lapply(X, FUN, ...)
580                  return(result)
581              })
582    
583    setMethod("sapply",
584              signature(X = "TextDocCol"),
585              function(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE) {
586                  if (DBControl(X)[["useDb"]]) {
587                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
588                      result <- sapply(dbMultiFetch(db, unlist(X)), FUN, ...)
589                      dbDisconnect(db)
590                  }
591                  else
592                      result <- base::sapply(X, FUN, ...)
593                  return(result)
594              })

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

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