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 55, Thu Sep 14 12:31:07 2006 UTC trunk/tm/R/textdoccol.R revision 837, Wed Apr 23 09:16:25 2008 UTC
# Line 1  Line 1 
1  # Author: Ingo Feinerer  # Author: Ingo Feinerer
2    
3  setGeneric("TextDocCol", function(object, inputType = "CSV", stripWhiteSpace = FALSE, toLower = FALSE) standardGeneric("TextDocCol"))  # The "..." are additional arguments for the FunctionGenerator reader
4  setMethod("TextDocCol",  setGeneric("Corpus", function(object,
5            c("character"),                                    readerControl = list(reader = object@DefaultReader, language = "en_US", load = TRUE),
6            function(object, inputType = "CSV", stripWhiteSpace = FALSE, toLower = FALSE) {                                    dbControl = list(useDb = FALSE, dbName = "", dbType = "DB1"),
7                # Add a new type for each unique input source format                                    ...) standardGeneric("Corpus"))
8                type <- match.arg(inputType,c("CSV", "RCV1", "REUT21578", "REUT21578_XML", "RIS"))  setMethod("Corpus",
9                switch(type,            signature(object = "Source"),
10                       # Text in a special CSV format            function(object,
11                       # For details on the file format see the R documentation file                     readerControl = list(reader = object@DefaultReader, language = "en_US", load = TRUE),
12                       # The first argument is a directory with .csv files                     dbControl = list(useDb = FALSE, dbName = "", dbType = "DB1"),
13                       "CSV" = {                     ...) {
14                           filelist <- dir(object, pattern = ".csv", full.names = TRUE)                if (is.null(readerControl$reader))
15                           tdl <- sapply(filelist,                    readerControl$reader <- object@DefaultReader
16                                         function(file) {                if (is(readerControl$reader, "FunctionGenerator"))
17                                             m <- as.matrix(read.csv(file, header = FALSE))                    readerControl$reader <- readerControl$reader(...)
18                                             l <- vector("list", dim(m)[1])                if (is.null(readerControl$language))
19                                             for (i in 1:dim(m)[1]) {                    readerControl$language = "en_US"
20                                                 author <- ""                if (is.null(readerControl$load))
21                                                 datetimestamp <- date()                    readerControl$load = TRUE
22                                                 description <- ""  
23                                                 id <- as.integer(m[i,1])                if (dbControl$useDb) {
24                                                 corpus <- as.character(m[i,2:dim(m)[2]])                    if (!dbCreate(dbControl$dbName, dbControl$dbType))
25                                                 if (stripWhiteSpace)                        stop("error in creating database")
26                                                     corpus <- gsub("[[:space:]]+", " ", corpus)                    db <- dbInit(dbControl$dbName, dbControl$dbType)
27                                                 if (toLower)                }
28                                                     corpus <- tolower(corpus)  
29                                                 origin <- "CSV"                tdl <- list()
30                                                 heading <- ""                counter <- 1
31                  while (!eoi(object)) {
32                                                 l[[i]] <- new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,                    object <- stepNext(object)
33                                                               Description = description, ID = id, Origin = origin, Heading = heading)                    elem <- getElem(object)
34                                             }                    # If there is no Load on Demand support
35                                             l                    # we need to load the corpus into memory at startup
36                                         })                    if (!object@LoDSupport)
37                           if (length(filelist) > 1)                        readerControl$load <- TRUE
38                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))                    doc <- readerControl$reader(elem, readerControl$load, readerControl$language, as.character(counter))
39                           else                    if (dbControl$useDb) {
40                               tdcl <- new("TextDocCol", .Data = tdl)                        dbInsert(db, ID(doc), doc)
41                       },                        tdl <- c(tdl, ID(doc))
42                       # Read in text documents in XML Reuters Corpus Volume 1 (RCV1) format                    }
43                       # The first argument is a directory with the RCV1 XML files                    else
44                       "RCV1" = {                        tdl <- c(tdl, list(doc))
45                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)                    counter <- counter + 1
46                           tdl <- sapply(filelist,                }
47                                         function(file) {  
48                                             tree <- xmlTreeParse(file)                df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)
49                                             xmlApply(xmlRoot(tree), parseNewsItemPlain, stripWhiteSpace, toLower)                if (dbControl$useDb) {
50                                         })                    dbInsert(db, "DMetaData", df)
51                           if (length(filelist) > 1)                    dmeta.df <- data.frame(key = "DMetaData", subset = I(list(NA)))
52                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))                }
53                           else                else
54                               tdcl <- new("TextDocCol", .Data = tdl)                    dmeta.df <- df
55                       },  
56                       # Read in text documents in Reuters-21578 XML (not SGML) format                cmeta.node <- new("MetaDataNode",
57                       # Typically the first argument will be a directory where we can                              NodeID = 0,
58                       # find the files reut2-000.xml ... reut2-021.xml                              MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
59                       "REUT21578" = {                              children = list())
60                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)  
61                           tdl <- sapply(filelist,                return(new("Corpus", .Data = tdl, DMetaData = dmeta.df, CMetaData = cmeta.node, DBControl = dbControl))
62                                         function(file) {            })
63                                             tree <- xmlTreeParse(file)  
64                                             xmlApply(xmlRoot(tree), parseReutersPlain, stripWhiteSpace, toLower)  setGeneric("loadDoc", function(object, ...) standardGeneric("loadDoc"))
65                                         })  setMethod("loadDoc",
66                           if (length(filelist) > 1)            signature(object = "PlainTextDocument"),
67                               tdcl <- new("TextDocCol", .Data = unlist(tdl, recursive = FALSE))            function(object, ...) {
68                           else                if (!Cached(object)) {
69                               tdcl <- new("TextDocCol", .Data = tdl)                    con <- eval(URI(object))
70                       },                    corpus <- readLines(con)
71                       "REUT21578_XML" = {                    close(con)
72                           filelist <- dir(object, pattern = ".xml", full.names = TRUE)                    Content(object) <- corpus
73                           tdl <- sapply(filelist,                    Cached(object) <- TRUE
74                                         function(file) {                    return(object)
75                                             parseReutersXML(file)                } else {
76                                         })                    return(object)
77                           tdcl <- new("TextDocCol", .Data = tdl)                }
78                       },            })
79                       # Read in HTML documents as used by http://ris.bka.gv.at/vwgh  setMethod("loadDoc",
80                       "RIS" = {            signature(object =  "XMLTextDocument"),
81                           filelist <- dir(object, pattern = ".html", full.names = TRUE)            function(object, ...) {
82                           tdl <- sapply(filelist,                if (!Cached(object)) {
83                                         function(file) {                    con <- eval(URI(object))
84                                             # Ignore warnings from misformed HTML documents                    corpus <- paste(readLines(con), "\n", collapse = "")
85                                             suppressWarnings(RISDoc <- parseRISPlain(file, stripWhiteSpace, toLower))                    close(con)
86                                             if (!is.null(RISDoc)) {                    doc <- xmlTreeParse(corpus, asText = TRUE)
                                                l <- list()  
                                                l[[length(l) + 1]] <- RISDoc  
                                                l  
                                            }  
                                        })  
                          tdcl <- new("TextDocCol", .Data = tdl)  
                      })  
               tdcl  
           })  
   
 # Parse an Austrian RIS HTML document  
 parseRISPlain <- function(file, stripWhiteSpace = FALSE, toLower = FALSE) {  
     author <- ""  
     datetimestamp <- date()  
     description <- ""  
   
     tree <- htmlTreeParse(file)  
     htmlElem <- unlist(tree$children$html$children)  
   
     if (is.null(htmlElem))  
         stop(paste("Empty document", file, "cannot be processed."))  
   
     textElem <- htmlElem[which(regexpr("text.value", names(htmlElem)) > 0)]  
     names(textElem) <- NULL  
   
     corpus <- paste(textElem, collapse = " ")  
   
     year <- substring(corpus, regexpr("..../../", corpus), regexpr("..../../", corpus) + 3)  
     senat <- substring(corpus, regexpr("..../../", corpus) + 5, regexpr("..../../", corpus) + 6)  
     number <- substring(corpus, regexpr("..../../", corpus) + 8, regexpr("..../../", corpus) + 11)  
   
     id <- as.integer(paste(year, senat, number, sep = ""))  
   
     if (is.na(id))  
         stop(paste("Cannot extract 'Geschaeftszahl' out of malformed document", file))  
     origin <- ""  
   
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(corpus)  
   
     heading <- ""  
   
     new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading)  
 }  
   
 # Parse a <newsitem></newsitem> element from a well-formed RCV1 XML file  
 parseNewsItemPlain <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {  
     author <- "Not yet implemented"  
     datetimestamp <- xmlAttrs(node)[["date"]]  
     description <- "Not yet implemented"  
     id <- as.integer(xmlAttrs(node)[["itemid"]])  
     origin <- "Reuters Corpus Volume 1 XML"  
     corpus <- unlist(xmlApply(node[["text"]], xmlValue), use.names = FALSE)  
   
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(corpus)  
   
     heading <- xmlValue(node[["title"]])  
   
     new("PlainTextDocument", .Data = corpus, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading)  
 }  
   
 # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file  
 parseReutersPlain <- function(node, stripWhiteSpace = FALSE, toLower = FALSE) {  
     # 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 <- as.integer(xmlAttrs(node)[["NEWID"]])  
   
     origin <- "Reuters-21578 XML"  
   
     # The <BODY></BODY> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["BODY"]]))  
         corpus <- xmlValue(node[["TEXT"]][["BODY"]])  
     else  
         corpus <- ""  
   
     if (stripWhiteSpace)  
         corpus <- gsub("[[:space:]]+", " ", corpus)  
     if (toLower)  
         corpus <- tolower(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 = 1, Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading, LocalMetaData = list(Topics = topics))  
 }  
   
 # Parse a <REUTERS></REUTERS> element from a well-formed Reuters-21578 XML file  
 parseReutersXML<- function(file) {  
     new("XMLTextDocument", FileName = file, Cached = 0, Author = "REUTERS", DateTimeStamp = date(),  
         Description = "Reuters21578 file containing several news articles", ID = as.integer(0),  
         Origin = "Reuters-21578 XML", Heading = "Reuters21578 news articles")  
 }  
   
 setGeneric("loadFileIntoMem", function(object) standardGeneric("loadFileIntoMem"))  
 setMethod("loadFileIntoMem",  
           c("XMLTextDocument"),  
           function(object) {  
               if (object@Cached == 0) {  
                   file <- object@FileName  
                   doc <- xmlTreeParse(file)  
87                    class(doc) <- "list"                    class(doc) <- "list"
88                    object@.Data <- doc                    Content(object) <- doc
89                    object@Cached <- 1                    Cached(object) <- TRUE
90                      return(object)
91                  } else {
92                      return(object)
93                  }
94              })
95    setMethod("loadDoc",
96              signature(object = "NewsgroupDocument"),
97              function(object, ...) {
98                  if (!Cached(object)) {
99                      con <- eval(URI(object))
100                      mail <- readLines(con)
101                      close(con)
102                      Cached(object) <- TRUE
103                      for (index in seq_along(mail)) {
104                          if (mail[index] == "")
105                              break
106                      }
107                      Content(object) <- mail[(index + 1):length(mail)]
108                    return(object)                    return(object)
109                } else {                } else {
110                    return(object)                    return(object)
111                }                }
112            })            })
113    setMethod("loadDoc",
114              signature(object = "StructuredTextDocument"),
115              function(object, ...) {
116                  if (!Cached(object)) {
117                      warning("load on demand not (yet) supported for StructuredTextDocuments")
118                      return(object)
119                  } else
120                      return(object)
121              })
122    
123  setGeneric("tm_transform", function(object, FUN, ...) standardGeneric("tm_transform"))  setGeneric("tmUpdate", function(object,
124  setMethod("tm_transform",                                  origin,
125            c("TextDocCol"),                                  readerControl = list(reader = origin@DefaultReader, language = "en_US", load = TRUE),
126            function(object, FUN, ...) {                                  ...) standardGeneric("tmUpdate"))
127                lapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object))  # Update is only supported for directories
128    # At the moment no other LoD devices are available anyway
129    setMethod("tmUpdate",
130              signature(object = "Corpus", origin = "DirSource"),
131              function(object, origin,
132                       readerControl = list(reader = origin@DefaultReader, language = "en_US", load = TRUE),
133                       ...) {
134                  if (is.null(readerControl$reader))
135                      readerControl$reader <- origin@DefaultReader
136                  if (is(readerControl$reader, "FunctionGenerator"))
137                      readerControl$reader <- readerControl$reader(...)
138                  if (is.null(readerControl$language))
139                      readerControl$language = "en_US"
140                  if (is.null(readerControl$load))
141                      readerControl$load = TRUE
142    
143                  object.filelist <- unlist(lapply(object, function(x) {as.character(URI(x))[2]}))
144                  new.files <- setdiff(origin@FileList, object.filelist)
145    
146                  for (filename in new.files) {
147                      encoding <- origin@Encoding
148                      elem <- list(content = readLines(filename, encoding = encoding),
149                                   uri = substitute(file(filename, encoding = encoding)))
150                      object <- appendElem(object, readerControl$reader(elem, readerControl$load, readerControl$language, filename))
151                  }
152    
153                  return(object)
154            })            })
155    
156  setGeneric("toPlainTextDocument", function(object, FUN, ...) standardGeneric("toPlainTextDocument"))  setGeneric("tmMap", function(object, FUN, ..., lazy = FALSE) standardGeneric("tmMap"))
157  setMethod("toPlainTextDocument",  setMethod("tmMap",
158            c("PlainTextDocument"),            signature(object = "Corpus", FUN = "function"),
159              function(object, FUN, ..., lazy = FALSE) {
160                  result <- object
161                  # Note that text corpora are automatically loaded into memory via \code{[[}
162                  if (DBControl(object)[["useDb"]]) {
163                      if (lazy)
164                          warning("lazy mapping is deactived when using database backend")
165                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
166                      i <- 1
167                      for (id in unlist(object)) {
168                          db[[id]] <- FUN(object[[i]], ..., DMetaData = DMetaData(object))
169                          i <- i + 1
170                      }
171                      # Suggested by Christian Buchta
172                      dbReorganize(db)
173                  }
174                  else {
175                      # Lazy mapping
176                      if (lazy) {
177                          lazyTmMap <- meta(object, tag = "lazyTmMap", type = "corpus")
178                          if (is.null(lazyTmMap)) {
179                              meta(result, tag = "lazyTmMap", type = "corpus") <-
180                                  list(index = rep(TRUE, length(result)),
181                                       maps = list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
182                          }
183                          else {
184                              lazyTmMap$maps <- c(lazyTmMap$maps, list(function(x, DMetaData) FUN(x, ..., DMetaData = DMetaData)))
185                              meta(result, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
186                          }
187                      }
188                      else
189                          result@.Data <- lapply(object, FUN, ..., DMetaData = DMetaData(object))
190                  }
191                  return(result)
192              })
193    
194    # Materialize lazy mappings
195    # Improvements by Christian Buchta
196    materialize <- function(corpus, range = seq_along(corpus)) {
197        lazyTmMap <- meta(corpus, tag = "lazyTmMap", type = "corpus")
198        if (!is.null(lazyTmMap)) {
199           # Make valid and lazy index
200           idx <- (seq_along(corpus) %in% range) & lazyTmMap$index
201           if (any(idx)) {
202               res <- lapply(corpus@.Data[idx], loadDoc)
203               for (m in lazyTmMap$maps)
204                   res <- lapply(res, m, DMetaData = DMetaData(corpus))
205               corpus@.Data[idx] <- res
206               lazyTmMap$index[idx] <- FALSE
207           }
208        }
209        # Clean up if everything is materialized
210        if (!any(lazyTmMap$index))
211            lazyTmMap <- NULL
212        meta(corpus, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
213        return(corpus)
214    }
215    
216    setGeneric("asPlain", function(object, FUN, ...) standardGeneric("asPlain"))
217    setMethod("asPlain",
218              signature(object = "PlainTextDocument"),
219            function(object, FUN, ...) {            function(object, FUN, ...) {
220                return(object)                return(object)
221            })            })
222  setMethod("toPlainTextDocument",  setMethod("asPlain",
223            c("XMLTextDocument"),            signature(object = "XMLTextDocument", FUN = "function"),
224            function(object, FUN, ...) {            function(object, FUN, ...) {
225                if (object@Cached == 0)                corpus <- Content(object)
                   object <- loadFileIntoMem(object)  
   
               corpus <- object@.Data  
226    
227                # As XMLDocument is no native S4 class, restore valid information                # As XMLDocument is no native S4 class, restore valid information
228                class(corpus) <- "XMLDocument"                class(corpus) <- "XMLDocument"
229                names(corpus) <- c("doc","dtd")                names(corpus) <- c("doc","dtd")
230    
231                return(xmlApply(xmlRoot(corpus), FUN, ...))                return(FUN(xmlRoot(corpus), ...))
232            })            })
233    setMethod("asPlain",
234              signature(object = "Reuters21578Document"),
235              function(object, FUN, ...) {
236                  FUN <- convertReut21578XMLPlain
237                  corpus <- Content(object)
238    
239  setGeneric("stemTextDocument", function(object, ...) standardGeneric("stemTextDocument"))                # As XMLDocument is no native S4 class, restore valid information
240  setMethod("stemTextDocument",                class(corpus) <- "XMLDocument"
241            c("PlainTextDocument"),                names(corpus) <- c("doc","dtd")
           function(object) {  
               require(Rstem)  
               splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))  
               stemmedCorpus <- wordStem(splittedCorpus)  
               object@.Data <- paste(stemmedCorpus, collapse = " ")  
               return (object)  
           })  
242    
243  setGeneric("removeStopWords", function(object, stopwords, ...) standardGeneric("removeStopWords"))                return(FUN(xmlRoot(corpus), ...))
 setMethod("removeStopWords",  
           c("PlainTextDocument", "character"),  
           function(object, stopwords) {  
               require(Rstem)  
               splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))  
               noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]  
               object@.Data <- paste(noStopwordsCorpus, collapse = " ")  
               return (object)  
244            })            })
245    setMethod("asPlain",
246  setGeneric("tm_filter", function(object, FUN, ...) standardGeneric("tm_filter"))            signature(object = "RCV1Document"),
 setMethod("tm_filter",  
           c("TextDocCol"),  
247            function(object, FUN, ...) {            function(object, FUN, ...) {
248                sapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object))                FUN <- convertRCV1Plain
249            })                corpus <- Content(object)
250    
251  setGeneric("filterREUT21578Topics", function(object, topics, ...) standardGeneric("filterREUT21578Topics"))                # As XMLDocument is no native S4 class, restore valid information
252  setMethod("filterREUT21578Topics",                class(corpus) <- "XMLDocument"
253            c("PlainTextDocument", "character"),                names(corpus) <- c("doc","dtd")
           function(object, topics) {  
               if (object@Cached == 0)  
                   object <- loadFileIntoMem(object)  
254    
255                if (any(object@LocalMetaData$Topics %in% topics))                return(FUN(xmlRoot(corpus), ...))
                   return(TRUE)  
               else  
                   return(FALSE)  
256            })            })
257    setMethod("asPlain",
258              signature(object = "NewsgroupDocument"),
259              function(object, FUN, ...) {
260                  new("PlainTextDocument", .Data = Content(object), Cached = TRUE, URI = "", Author = Author(object),
261                      DateTimeStamp = DateTimeStamp(object), Description = Description(object), ID = ID(object),
262                      Origin = Origin(object), Heading = Heading(object), Language = Language(object),
263                      LocalMetaData = LocalMetaData(object))
264              })
265    setMethod("asPlain",
266              signature(object = "StructuredTextDocument"),
267              function(object, FUN, ...) {
268                  new("PlainTextDocument", .Data = unlist(Content(object)), Cached = TRUE,
269                      URI = "", Author = Author(object), DateTimeStamp = DateTimeStamp(object),
270                      Description = Description(object), ID = ID(object), Origin = Origin(object),
271                      Heading = Heading(object), Language = Language(object),
272                      LocalMetaData = LocalMetaData(object))
273              })
274    
275    setGeneric("tmFilter", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmFilter"))
276    setMethod("tmFilter",
277              signature(object = "Corpus"),
278              function(object, ..., FUN = sFilter, doclevel = FALSE) {
279                  if (doclevel)
280                      return(object[sapply(object, FUN, ..., DMetaData = DMetaData(object))])
281                  else
282                      return(object[FUN(object, ...)])
283              })
284    
285    setGeneric("tmIndex", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmIndex"))
286    setMethod("tmIndex",
287              signature(object = "Corpus"),
288              function(object, ..., FUN = sFilter, doclevel = FALSE) {
289                  if (doclevel)
290                      return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))
291                  else
292                      return(FUN(object, ...))
293              })
294    
295    sFilter <- function(object, s, ...) {
296        con <- textConnection(s)
297        tokens <- scan(con, "character", quiet = TRUE)
298        close(con)
299        localMetaNames <- unique(names(sapply(object, LocalMetaData)))
300        localMetaTokens <- localMetaNames[localMetaNames %in% tokens]
301        n <- names(DMetaData(object))
302        tags <- c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language", localMetaTokens)
303        query.df <- DMetaData(prescindMeta(object, tags))
304        if (DBControl(object)[["useDb"]])
305            DMetaData(object) <- DMetaData(object)[, setdiff(n, tags), drop = FALSE]
306        # Rename to avoid name conflicts
307        names(query.df)[names(query.df) == "Author"] <- "author"
308        names(query.df)[names(query.df) == "DateTimeStamp"] <- "datetimestamp"
309        names(query.df)[names(query.df) == "Description"] <- "description"
310        names(query.df)[names(query.df) == "ID"] <- "identifier"
311        names(query.df)[names(query.df) == "Origin"] <- "origin"
312        names(query.df)[names(query.df) == "Heading"] <- "heading"
313        names(query.df)[names(query.df) == "Language"] <- "language"
314        attach(query.df)
315        try(result <- rownames(query.df) %in% row.names(query.df[eval(parse(text = s)), ]))
316        detach(query.df)
317        return(result)
318    }
319    
320  setGeneric("filterIDs", function(object, IDs, ...) standardGeneric("filterIDs"))  setGeneric("appendElem", function(object, data, meta = NULL) standardGeneric("appendElem"))
321  setMethod("filterIDs",  setMethod("appendElem",
322            c("TextDocument", "numeric"),            signature(object = "Corpus", data = "TextDocument"),
323            function(object, IDs) {            function(object, data, meta = NULL) {
324                if (object@ID %in% IDs)                if (DBControl(object)[["useDb"]]) {
325                    return(TRUE)                    db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
326                      if (dbExists(db, ID(data)))
327                          warning("document with identical ID already exists")
328                      dbInsert(db, ID(data), data)
329                      object@.Data[[length(object)+1]] <- ID(data)
330                  }
331                else                else
332                    return(FALSE)                    object@.Data[[length(object)+1]] <- data
333                  DMetaData(object) <- rbind(DMetaData(object), c(MetaID = CMetaData(object)@NodeID, meta))
334                  return(object)
335            })            })
336    
337  setGeneric("attachData", function(object, data) standardGeneric("attachData"))  setGeneric("appendMeta", function(object, cmeta = NULL, dmeta = NULL) standardGeneric("appendMeta"))
338  setMethod("attachData",  setMethod("appendMeta",
339            c("TextDocCol","TextDocument"),            signature(object = "Corpus"),
340            function(object, data) {            function(object, cmeta = NULL, dmeta = NULL) {
341                data <- as(list(data), "TextDocCol")                object@CMetaData@MetaData <- c(CMetaData(object)@MetaData, cmeta)
342                object@.Data <- as(c(object@.Data, data), "TextDocCol")                if (!is.null(dmeta)) {
343                      DMetaData(object) <- cbind(DMetaData(object), eval(dmeta))
344                  }
345                return(object)                return(object)
346            })            })
347    
348  setGeneric("attachMetaData", function(object, name, metadata) standardGeneric("attachMetaData"))  setGeneric("removeMeta", function(object, cname = NULL, dname = NULL) standardGeneric("removeMeta"))
349  setMethod("attachMetaData",  setMethod("removeMeta",
350            c("TextDocCol"),            signature(object = "Corpus"),
351            function(object, name, metadata) {            function(object, cname = NULL, dname = NULL) {
352                object@GlobalMetaData <- c(object@GlobalMetaData, new = list(metadata))                if (!is.null(cname))
353                names(object@GlobalMetaData)[length(names(object@GlobalMetaData))] <- name                    object@CMetaData@MetaData <- CMetaData(object)@MetaData[names(CMetaData(object)@MetaData) != cname]
354                  if (!is.null(dname))
355                      DMetaData(object) <- DMetaData(object)[, names(DMetaData(object)) != dname, drop = FALSE]
356                return(object)                return(object)
357            })            })
358    
359  setGeneric("setSubscriptable", function(object, name) standardGeneric("setSubscriptable"))  setGeneric("prescindMeta", function(object, meta) standardGeneric("prescindMeta"))
360  setMethod("setSubscriptable",  setMethod("prescindMeta",
361            c("TextDocCol"),            signature(object = "Corpus", meta = "character"),
362            function(object, name) {            function(object, meta) {
363                if (!is.character(object@GlobalMetaData$subscriptable))                for (m in meta) {
364                    object <- attachMetaData(object, "subscriptable", name)                    if (m %in% c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language")) {
365                else                        local.m <- lapply(object, m)
366                    object@GlobalMetaData$subscriptable <- c(object@GlobalMetaData$subscriptable, name)                        local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
367                          local.m <- unlist(local.m)
368                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
369                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
370                      }
371                      else {
372                          local.meta <- lapply(object, LocalMetaData)
373                          local.m <- lapply(local.meta, "[[", m)
374                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
375                          if (length(local.m) == length(unlist(local.m)))
376                              local.m <- unlist(local.m)
377                          else
378                              local.m <- I(local.m)
379                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
380                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
381                      }
382                  }
383                return(object)                return(object)
384            })            })
385    
386  setMethod("[",  setMethod("[",
387            signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),            signature(x = "Corpus", i = "ANY", j = "ANY", drop = "ANY"),
388            function(x, i, j, ... , drop) {            function(x, i, j, ... , drop) {
389                if(missing(i))                if(missing(i))
390                    return(x)                    return(x)
391    
392                object <- x                object <- x
393                object@.Data <- x@.Data[i, ..., drop = FALSE]                object@.Data <- x@.Data[i, ..., drop = FALSE]
394                for (m in names(object@GlobalMetaData)) {                if (DBControl(object)[["useDb"]]) {
395                    if (m %in% object@GlobalMetaData$subscriptable) {                    index <- object@DMetaData[[1 , "subset"]]
396                        object@GlobalMetaData[[m]] <- object@GlobalMetaData[[m]][i, ..., drop = FALSE]                    if (any(is.na(index)))
397                          object@DMetaData[[1 , "subset"]] <- i
398                      else
399                          object@DMetaData[[1 , "subset"]] <- index[i]
400                    }                    }
401                  else
402                      DMetaData(object) <- DMetaData(x)[i, , drop = FALSE]
403                  return(object)
404              })
405    
406    setMethod("[<-",
407              signature(x = "Corpus", i = "ANY", j = "ANY", value = "ANY"),
408              function(x, i, j, ... , value) {
409                  object <- x
410                  if (DBControl(object)[["useDb"]]) {
411                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
412                      counter <- 1
413                      for (id in object@.Data[i, ...]) {
414                          if (length(value) == 1)
415                              db[[id]] <- value
416                          else {
417                              db[[id]] <- value[[counter]]
418                          }
419                          counter <- counter + 1
420                      }
421                  }
422                  else
423                      object@.Data[i, ...] <- value
424                  return(object)
425              })
426    
427    setMethod("[[",
428              signature(x = "Corpus", i = "ANY", j = "ANY"),
429              function(x, i, j, ...) {
430                  if (DBControl(x)[["useDb"]]) {
431                      db <- dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
432                      result <- dbFetch(db, x@.Data[[i]])
433                      return(loadDoc(result))
434                  }
435                  else {
436                      lazyTmMap <- meta(x, tag = "lazyTmMap", type = "corpus")
437                      if (!is.null(lazyTmMap))
438                          .Call("copyCorpus", x, materialize(x, i))
439                      return(loadDoc(x@.Data[[i]]))
440                  }
441              })
442    
443    setMethod("[[<-",
444              signature(x = "Corpus", i = "ANY", j = "ANY", value = "ANY"),
445              function(x, i, j, ..., value) {
446                  object <- x
447                  if (DBControl(object)[["useDb"]]) {
448                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
449                      index <- object@.Data[[i]]
450                      db[[index]] <- value
451                  }
452                  else {
453                      # Mark new objects as not active for lazy mapping
454                      lazyTmMap <- meta(object, tag = "lazyTmMap", type = "corpus")
455                      if (!is.null(lazyTmMap)) {
456                          lazyTmMap$index[i] <- FALSE
457                          meta(object, tag = "lazyTmMap", type = "corpus") <- lazyTmMap
458                      }
459                      # Set the value
460                      object@.Data[[i, ...]] <- value
461                  }
462                  return(object)
463              })
464    
465    # Update \code{NodeID}s of a CMetaData tree
466    update_id <- function(object, id = 0, mapping = NULL, left.mapping = NULL, level = 0) {
467        # Traversal of (binary) CMetaData tree with setup of \code{NodeID}s
468        set_id <- function(object) {
469            object@NodeID <- id
470            id <<- id + 1
471            level <<- level + 1
472    
473            if (length(object@children) > 0) {
474                mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))
475                left <- set_id(object@children[[1]])
476                if (level == 1) {
477                    left.mapping <<- mapping
478                    mapping <<- NULL
479                }
480                mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))
481                right <- set_id(object@children[[2]])
482    
483                object@children <- list(left, right)
484            }
485            level <<- level - 1
486    
487            return(object)
488        }
489    
490        return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))
491    }
492    
493    setMethod("c",
494              signature(x = "Corpus"),
495              function(x, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
496                  args <- list(...)
497                  if (length(args) == 0)
498                      return(x)
499    
500                  if (!all(sapply(args, inherits, "Corpus")))
501                      stop("not all arguments are text document collections")
502                  if (DBControl(x)[["useDb"]] == TRUE || any(unlist(sapply(args, DBControl)["useDb", ])))
503                      stop("concatenating text document collections with activated database is not supported")
504    
505                  result <- x
506                  for (c in args) {
507                      result <- c2(result, c)
508                  }
509                  return(result)
510              })
511    
512    setGeneric("c2", function(x, y, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) standardGeneric("c2"))
513    setMethod("c2",
514              signature(x = "Corpus", y = "Corpus"),
515              function(x, y, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
516                  object <- x
517                  # Concatenate data slots
518                  object@.Data <- c(as(x, "list"), as(y, "list"))
519    
520                  # Set the DBControl slot
521                  object@DBControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")
522    
523                  # Update the CMetaData tree
524                  cmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(CMetaData(x), CMetaData(y)))
525                  update.struct <- update_id(cmeta)
526                  object@CMetaData <- update.struct$root
527    
528                  # Find indices to be updated for the left tree
529                  indices.mapping <- NULL
530                  for (m in levels(as.factor(DMetaData(x)$MetaID))) {
531                      indices <- (DMetaData(x)$MetaID == m)
532                      indices.mapping <- c(indices.mapping, list(m = indices))
533                      names(indices.mapping)[length(indices.mapping)] <- m
534                  }
535    
536                  # Update the DMetaData data frames for the left tree
537                  for (i in 1:ncol(update.struct$left.mapping)) {
538                      map <- update.struct$left.mapping[,i]
539                      x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
540                  }
541    
542                  # Find indices to be updated for the right tree
543                  indices.mapping <- NULL
544                  for (m in levels(as.factor(DMetaData(y)$MetaID))) {
545                      indices <- (DMetaData(y)$MetaID == m)
546                      indices.mapping <- c(indices.mapping, list(m = indices))
547                      names(indices.mapping)[length(indices.mapping)] <- m
548                }                }
549    
550                  # Update the DMetaData data frames for the right tree
551                  for (i in 1:ncol(update.struct$right.mapping)) {
552                      map <- update.struct$right.mapping[,i]
553                      y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
554                  }
555    
556                  # Merge the DMetaData data frames
557                  labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))
558                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))
559                  x.dmeta.aug <- cbind(DMetaData(x), na.matrix)
560                  labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))
561                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))
562                  y.dmeta.aug <- cbind(DMetaData(y), na.matrix)
563                  object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)
564    
565                return(object)                return(object)
566            })            })
567    
568  setMethod("c",  setMethod("c",
569            signature(x = "TextDocCol"),            signature(x = "TextDocument"),
570            function(x, ..., recursive = TRUE){            function(x, ..., recursive = TRUE){
571                args <- list(...)                args <- list(...)
572                if(length(args) == 0)                if(length(args) == 0)
573                    return(x)                    return(x)
574                return(as(c(as(x, "list"), ...), "TextDocCol"))  
575                  dmeta.df <- data.frame(MetaID = rep(0, length(list(x, ...))), stringsAsFactors = FALSE)
576                  cmeta.node <- new("MetaDataNode",
577                                NodeID = 0,
578                                MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
579                                children = list())
580    
581                  return(new("Corpus",
582                             .Data = list(x, ...),
583                             DMetaData = dmeta.df,
584                             CMetaData = cmeta.node,
585                             DBControl = list(useDb = FALSE, dbName = "", dbType = "DB1")))
586      })      })
587    
588  setMethod("length",  setMethod("length",
589            signature(x = "TextDocCol"),            signature(x = "Corpus"),
590            function(x){            function(x){
591                return(length(as(x, "list")))                return(length(as(x, "list")))
592      })      })
593    
594  setMethod("show",  setMethod("show",
595            signature(object = "TextDocCol"),            signature(object = "Corpus"),
596            function(object){            function(object){
597                cat("A text document collection with", length(object), "text document")                cat(sprintf(ngettext(length(object),
598                if (length(object) == 1)                                     "A text document collection with %d text document\n",
599                    cat("\n")                                     "A text document collection with %d text documents\n"),
600                else                            length(object)))
                   cat("s\n")  
601      })      })
602    
603  setMethod("summary",  setMethod("summary",
604            signature(object = "TextDocCol"),            signature(object = "Corpus"),
605            function(object){            function(object){
606                show(object)                show(object)
607                if (length(GlobalMetaData(object)) > 0) {                if (length(DMetaData(object)) > 0) {
608                    cat("\nThe global metadata consists of", length(GlobalMetaData(object)), "tag-value pair")                    cat(sprintf(ngettext(length(CMetaData(object)@MetaData),
609                    if (length(GlobalMetaData(object)) == 1)                                                "\nThe metadata consists of %d tag-value pair and a data frame\n",
610                        cat(".\n")                                                "\nThe metadata consists of %d tag-value pairs and a data frame\n"),
611                    else                                         length(CMetaData(object)@MetaData)))
                       cat("s.\n")  
612                    cat("Available tags are:\n")                    cat("Available tags are:\n")
613                    cat(names(GlobalMetaData(object)), "\n")                    cat(strwrap(paste(names(CMetaData(object)@MetaData), collapse = " "), indent = 2, exdent = 2), "\n")
614                      cat("Available variables in the data frame are:\n")
615                      cat(strwrap(paste(names(DMetaData(object)), collapse = " "), indent = 2, exdent = 2), "\n")
616                }                }
617      })      })
618    
619  setGeneric("inspect", function(object) standardGeneric("inspect"))  setGeneric("inspect", function(object) standardGeneric("inspect"))
620  setMethod("inspect",  setMethod("inspect",
621            c("TextDocCol"),            signature("Corpus"),
622            function(object) {            function(object) {
623                summary(object)                summary(object)
624                cat("\n")                cat("\n")
625                show(as(object, "list"))                if (DBControl(object)[["useDb"]]) {
626                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
627                      show(dbMultiFetch(db, unlist(object)))
628                  }
629                  else
630                      print(noquote(lapply(object, identity)))
631              })
632    
633    # No metadata is checked
634    setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))
635    setMethod("%IN%",
636              signature(x = "TextDocument", y = "Corpus"),
637              function(x, y) {
638                  if (DBControl(y)[["useDb"]]) {
639                      db <- dbInit(DBControl(y)[["dbName"]], DBControl(y)[["dbType"]])
640                      result <- any(sapply(y, function(x, z) {x %in% Content(z)}, x))
641                  }
642                  else
643                      result <- x %in% y
644                  return(result)
645              })
646    
647    setMethod("lapply",
648              signature(X = "Corpus"),
649              function(X, FUN, ...) {
650                  print("lapply")
651                  if (DBControl(X)[["useDb"]]) {
652                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
653                      result <- lapply(dbMultiFetch(db, unlist(X)), FUN, ...)
654                  }
655                  else {
656                      lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
657                      if (!is.null(lazyTmMap))
658                          .Call("copyCorpus", X, materialize(X))
659                      result <- base::lapply(X, FUN, ...)
660                  }
661                  return(result)
662              })
663    
664    setMethod("sapply",
665              signature(X = "Corpus"),
666              function(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE) {
667                  if (DBControl(X)[["useDb"]]) {
668                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
669                      result <- sapply(dbMultiFetch(db, unlist(X)), FUN, ...)
670                  }
671                  else {
672                      lazyTmMap <- meta(X, tag = "lazyTmMap", type = "corpus")
673                      if (!is.null(lazyTmMap))
674                          .Call("copyCorpus", X, materialize(X))
675                      result <- base::sapply(X, FUN, ...)
676                  }
677                  return(result)
678              })
679    
680    setAs("list", "Corpus", function(from) {
681        cmeta.node <- new("MetaDataNode",
682                          NodeID = 0,
683                          MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
684                          children = list())
685        data <- list()
686        counter <- 1
687        for (f in from) {
688            doc <- new("PlainTextDocument",
689                       .Data = f, URI = NULL, Cached = TRUE,
690                       Author = "", DateTimeStamp = Sys.time(),
691                       Description = "", ID = as.character(counter),
692                       Origin = "", Heading = "", Language = "en_US")
693            data <- c(data, list(doc))
694            counter <- counter + 1
695        }
696        return(new("Corpus", .Data = data,
697                   DMetaData = data.frame(MetaID = rep(0, length(from)), stringsAsFactors = FALSE),
698                   CMetaData = cmeta.node,
699                   DBControl = dbControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")))
700    })
701    
702    setGeneric("writeCorpus", function(object, path = ".", filenames = NULL) standardGeneric("writeCorpus"))
703    setMethod("writeCorpus",
704              signature(object = "Corpus"),
705              function(object, path = ".", filenames = NULL) {
706                  filenames <- file.path(path,
707                                         if (is.null(filenames)) sapply(object, function(x) sprintf("%s.txt", ID(x)))
708                                         else filenames)
709                  i <- 1
710                  for (o in object) {
711                      writeLines(o, filenames[i])
712                      i <- i + 1
713                  }
714            })            })

Legend:
Removed from v.55  
changed lines
  Added in v.837

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