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

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

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