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 828, Sun Mar 9 07:47:15 2008 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("Corpus", function(object,
5  setMethod("TextDocCol",                                    readerControl = list(reader = object@DefaultReader, language = "en_US", load = TRUE),
6                                      dbControl = list(useDb = FALSE, dbName = "", dbType = "DB1"),
7                                      ...) standardGeneric("Corpus"))
8    setMethod("Corpus",
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 = TRUE),
12                    parser <- parser(...)                     dbControl = list(useDb = FALSE, dbName = "", dbType = "DB1"),
13                       ...) {
14                  if (is.null(readerControl$reader))
15                      readerControl$reader <- object@DefaultReader
16                  if (is(readerControl$reader, "FunctionGenerator"))
17                      readerControl$reader <- readerControl$reader(...)
18                  if (is.null(readerControl$language))
19                      readerControl$language = "en_US"
20                  if (is.null(readerControl$load))
21                      readerControl$load = TRUE
22    
23                  if (dbControl$useDb) {
24                      if (!dbCreate(dbControl$dbName, dbControl$dbType))
25                          stop("error in creating database")
26                      db <- dbInit(dbControl$dbName, dbControl$dbType)
27                  }
28    
29                tdl <- list()                tdl <- list()
30                counter <- 1                counter <- 1
31                while (!eoi(object)) {                while (!eoi(object)) {
32                    object <- step_next(object)                    object <- stepNext(object)
33                    elem <- get_elem(object)                    elem <- getElem(object)
34                    # If there is no Load on Demand support                    # If there is no Load on Demand support
35                    # we need to load the corpus into memory at startup                    # we need to load the corpus into memory at startup
36                    if (object@LoDSupport)                    if (!object@LoDSupport)
37                        load <- object@Load                        readerControl$load <- TRUE
38                    else                    doc <- readerControl$reader(elem, readerControl$load, readerControl$language, as.character(counter))
39                        load <- TRUE                    if (dbControl$useDb) {
40                    tdl <- c(tdl, list(parser(elem, object@LoDSupport, load, as.character(counter))))                        dbInsert(db, ID(doc), doc)
41                    counter <- counter + 1                        tdl <- c(tdl, ID(doc))
               }  
   
               return(new("TextDocCol", .Data = tdl))  
           })  
   
 setGeneric("DirSource", function(directory, load = FALSE) standardGeneric("DirSource"))  
 setMethod("DirSource",  
           signature(directory = "character"),  
           function(directory, load = FALSE) {  
               new("DirSource", LoDSupport = TRUE, FileList = dir(directory, full.names = TRUE),  
                   Position = 0, Load = load)  
           })  
   
 setGeneric("CSVSource", function(object, isConCall = FALSE) standardGeneric("CSVSource"))  
 setMethod("CSVSource",  
           signature(object = "character"),  
           function(object, isConCall = FALSE) {  
               if (!isConCall)  
                   object <- paste('file("', object, '")', sep = "")  
               con <- eval(parse(text = object))  
               content <- scan(con, what = "character")  
               close(con)  
               new("CSVSource", LoDSupport = FALSE, URI = object,  
                   Content = content, Position = 0)  
           })  
   
 setGeneric("ReutersSource", function(object, isConCall = FALSE) standardGeneric("ReutersSource"))  
 setMethod("ReutersSource",  
           signature(object = "character"),  
           function(object, isConCall = FALSE) {  
               if (!isConCall)  
                  object <- paste('file("', object, '")', sep = "")  
               con <- eval(parse(text = object))  
               corpus <- paste(readLines(con), "\n", collapse = "")  
               close(con)  
               tree <- xmlTreeParse(corpus, asText = TRUE)  
               content <- xmlRoot(tree)$children  
   
               new("ReutersSource", LoDSupport = FALSE, URI = object,  
                   Content = content, Position = 0)  
           })  
   
 setGeneric("step_next", function(object) standardGeneric("step_next"))  
 setMethod("step_next",  
           signature(object = "DirSource"),  
           function(object) {  
               object@Position <- object@Position + 1  
               object  
           })  
 setMethod("step_next",  
           signature(object = "CSVSource"),  
           function(object) {  
               object@Position <- object@Position + 1  
               object  
           })  
 setMethod("step_next",  
           signature(object = "ReutersSource"),  
           function(object) {  
               object@Position <- object@Position + 1  
               object  
           })  
   
 setGeneric("get_elem", function(object) standardGeneric("get_elem"))  
 setMethod("get_elem",  
           signature(object = "DirSource"),  
           function(object) {  
               list(content = readLines(object@FileList[object@Position]),  
                    uri = paste('file("', object@FileList[object@Position], '")', sep = ""))  
           })  
 setMethod("get_elem",  
           signature(object = "CSVSource"),  
           function(object) {  
               list(content = object@Content[object@Position],  
                    uri = object@URI)  
           })  
 setMethod("get_elem",  
           signature(object = "ReutersSource"),  
           function(object) {  
               # Construct a character representation from the XMLNode  
               con <- textConnection("virtual.file", "w")  
               saveXML(object@Content[[object@Position]], con)  
               close(con)  
   
               list(content = virtual.file, uri = object@URI)  
           })  
   
 setGeneric("eoi", function(object) standardGeneric("eoi"))  
 setMethod("eoi",  
           signature(object = "DirSource"),  
           function(object) {  
               if (length(object@FileList) <= object@Position)  
                   return(TRUE)  
               else  
                   return(FALSE)  
           })  
 setMethod("eoi",  
           signature(object = "CSVSource"),  
           function(object) {  
               if (length(object@Content) <= object@Position)  
                   return(TRUE)  
               else  
                   return(FALSE)  
           })  
 setMethod("eoi",  
           signature(object = "ReutersSource"),  
           function(object) {  
               if (length(object@Content) <= object@Position)  
                   return(TRUE)  
               else  
                   return(FALSE)  
           })  
   
 plaintext_parser <- function(...) {  
     function(elem, lodsupport, load, id) {  
         if (!lodsupport || (lodsupport && load)) {  
             doc <- new("PlainTextDocument", .Data = elem$content, URI = elem$uri, Cached = TRUE,  
                        Author = "", DateTimeStamp = date(), Description = "", ID = id, Origin = "", Heading = "")  
         }  
         else {  
             doc <- new("PlainTextDocument", URI = elem$uri, Cached = FALSE,  
                        Author = "", DateTimeStamp = date(), Description = "", ID = id, Origin = "", Heading = "")  
         }  
   
         return(doc)  
     }  
42  }  }
 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"]])  
43          else          else
44              heading <- ""                        tdl <- c(tdl, list(doc))
45                      counter <- counter + 1
         topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)  
   
         if (!lodsupport || (lodsupport && load)) {  
             doc <- new("XMLTextDocument", .Data = tree, URI = elem$uri, Cached = TRUE, Author = author,  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters-21578 XML",  
                        Heading = heading, LocalMetaData = list(Topics = topics))  
         } else {  
             doc <- new("XMLTextDocument", URI = elem$uri, Cached = FALSE, Author = author,  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters-21578 XML",  
                        Heading = heading, LocalMetaData = list(Topics = topics))  
         }  
   
         return(doc)  
     }  
 }  
 class(reut21578xml_parser) <- "function_generator"  
   
 rcv1_parser <- function(...) {  
     function(elem, lodsupport, load, id) {  
         corpus <- paste(elem$content, "\n", collapse = "")  
         tree <- xmlTreeParse(corpus, asText = TRUE)  
         node <- xmlRoot(tree)  
   
         # Mask as list to bypass S4 checks  
         class(tree) <- "list"  
   
         datetimestamp <- xmlAttrs(node)[["date"]]  
         id <- xmlAttrs(node)[["itemid"]]  
         heading <- xmlValue(node[["title"]])  
   
         if (!lodsupport || (lodsupport && load)) {  
             doc <- new("XMLTextDocument", .Data = tree, URI = elem$uri, Cached = TRUE, Author = "",  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML",  
                        Heading = heading)  
         } else {  
             doc <- new("XMLTextDocument", URI = elem$uri, Cached = FALSE, Author = "",  
                        DateTimeStamp = datetimestamp, Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML",  
                        Heading = heading)  
         }  
   
         return(doc)  
     }  
 }  
 class(rcv1_parser) <- "function_generator"  
   
 newsgroup_parser <- function(...) {  
     function(elem, lodsupport, load, id) {  
         mail <- elem$content  
         author <- gsub("From: ", "", grep("^From:", mail, value = TRUE))  
         datetimestamp <- gsub("Date: ", "", grep("^Date:", mail, value = TRUE))  
         origin <- gsub("Path: ", "", grep("^Path:", mail, value = TRUE))  
         heading <- gsub("Subject: ", "", grep("^Subject:", mail, value = TRUE))  
         newsgroup <- gsub("Newsgroups: ", "", grep("^Newsgroups:", mail, value = TRUE))  
   
         if (!lodsupport || (lodsupport && load)) {  
             # The header is separated from the body by a blank line.  
             # Reference: \url{http://en.wikipedia.org/wiki/E-mail#Internet_e-mail_format}  
             for (index in seq(along = mail)) {  
                 if (mail[index] == "")  
                     break  
             }  
             content <- mail[(index + 1):length(mail)]  
   
             doc <- new("NewsgroupDocument", .Data = content, URI = elem$uri, Cached = TRUE,  
                        Author = author, DateTimeStamp = datetimestamp,  
                        Description = "", ID = id, Origin = origin,  
                        Heading = heading, Newsgroup = newsgroup)  
         } else {  
             doc <- new("NewsgroupDocument", URI = elem$uri, Cached = FALSE, Author = author, DateTimeStamp = datetimestamp,  
                        Description = "", ID = id, Origin = origin, Heading = heading, Newsgroup = newsgroup)  
46          }          }
47    
48          return(doc)                df <- data.frame(MetaID = rep(0, length(tdl)), stringsAsFactors = FALSE)
49      }                if (dbControl$useDb) {
50                      dbInsert(db, "DMetaData", df)
51                      dmeta.df <- data.frame(key = "DMetaData", subset = I(list(NA)))
52  }  }
 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"]])  
   
     new("PlainTextDocument", .Data = corpus, Cached = TRUE, URI = "", Author = "", DateTimeStamp = datetimestamp,  
         Description = "", ID = id, Origin = "Reuters Corpus Volume 1 XML", Heading = heading)  
 }  
   
 # 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"]])  
53      else      else
54          author <- ""                    dmeta.df <- df
   
     datetimestamp <- xmlValue(node[["DATE"]])  
     description <- ""  
     id <- xmlAttrs(node)[["NEWID"]]  
55    
56      origin <- "Reuters-21578 XML"                cmeta.node <- new("MetaDataNode",
57                                NodeID = 0,
58                                MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
59                                children = list())
60    
61      # The <BODY></BODY> tag is unfortunately NOT obligatory!                return(new("Corpus", .Data = tdl, DMetaData = dmeta.df, CMetaData = cmeta.node, DBControl = dbControl))
62      if (!is.null(node[["TEXT"]][["BODY"]]))            })
         corpus <- xmlValue(node[["TEXT"]][["BODY"]])  
     else  
         corpus <- ""  
   
     # The <TITLE></TITLE> tag is unfortunately NOT obligatory!  
     if (!is.null(node[["TEXT"]][["TITLE"]]))  
         heading <- xmlValue(node[["TEXT"]][["TITLE"]])  
     else  
         heading <- ""  
   
     topics <- unlist(xmlApply(node[["TOPICS"]], function(x) xmlValue(x)), use.names = FALSE)  
   
     new("PlainTextDocument", .Data = corpus, Cached = TRUE, URI = "", Author = author, DateTimeStamp = datetimestamp,  
         Description = description, ID = id, Origin = origin, Heading = heading, LocalMetaData = list(Topics = topics))  
 }  
63    
64  setGeneric("load_doc", function(object, ...) standardGeneric("load_doc"))  setGeneric("loadDoc", function(object, ...) standardGeneric("loadDoc"))
65  setMethod("load_doc",  setMethod("loadDoc",
66            signature(object = "PlainTextDocument"),            signature(object = "PlainTextDocument"),
67            function(object, ...) {            function(object, ...) {
68                if (!Cached(object)) {                if (!Cached(object)) {
69                    con <- eval(parse(text = URI(object)))                    con <- eval(URI(object))
70                    corpus <- readLines(con)                    corpus <- readLines(con)
71                    close(con)                    close(con)
72                    Corpus(object) <- corpus                    Content(object) <- corpus
73                    Cached(object) <- TRUE                    Cached(object) <- TRUE
74                    return(object)                    return(object)
75                } else {                } else {
76                    return(object)                    return(object)
77                }                }
78            })            })
79  setMethod("load_doc",  setMethod("loadDoc",
80            signature(object =  "XMLTextDocument"),            signature(object =  "XMLTextDocument"),
81            function(object, ...) {            function(object, ...) {
82                if (!Cached(object)) {                if (!Cached(object)) {
83                    con <- eval(parse(text = URI(object)))                    con <- eval(URI(object))
84                    corpus <- paste(readLines(con), "\n", collapse = "")                    corpus <- paste(readLines(con), "\n", collapse = "")
85                    close(con)                    close(con)
86                    doc <- xmlTreeParse(corpus, asText = TRUE)                    doc <- xmlTreeParse(corpus, asText = TRUE)
87                    class(doc) <- "list"                    class(doc) <- "list"
88                    Corpus(object) <- doc                    Content(object) <- doc
89                    Cached(object) <- TRUE                    Cached(object) <- TRUE
90                    return(object)                    return(object)
91                } else {                } else {
92                    return(object)                    return(object)
93                }                }
94            })            })
95  setMethod("load_doc",  setMethod("loadDoc",
96            signature(object = "NewsgroupDocument"),            signature(object = "NewsgroupDocument"),
97            function(object, ...) {            function(object, ...) {
98                if (!Cached(object)) {                if (!Cached(object)) {
99                    con <- eval(parse(text = URI(object)))                    con <- eval(URI(object))
100                    mail <- readLines(con)                    mail <- readLines(con)
101                    close(con)                    close(con)
102                    Cached(object) <- TRUE                    Cached(object) <- TRUE
103                    for (index in seq(along = mail)) {                    for (index in seq_along(mail)) {
104                        if (mail[index] == "")                        if (mail[index] == "")
105                            break                            break
106                    }                    }
107                    Corpus(object) <- mail[(index + 1):length(mail)]                    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("tmUpdate", function(object,
124                                    origin,
125                                    readerControl = list(reader = origin@DefaultReader, language = "en_US", load = TRUE),
126                                    ...) standardGeneric("tmUpdate"))
127    # 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("tm_transform", function(object, FUN, ...) standardGeneric("tm_transform"))  setGeneric("tmMap", function(object, FUN, lazy = FALSE, ...) standardGeneric("tmMap"))
157  setMethod("tm_transform",  ############################################
158            signature(object = "TextDocCol", FUN = "function"),  # Lazy mapping restrictions (at the moment):
159            function(object, FUN, ...) {  #   *) No database backend support
160                result <- as(lapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object)), "TextDocCol")  #   *) No function composition
161                result@GlobalMetaData <- GlobalMetaData(object)  ############################################
162    setMethod("tmMap",
163              signature(object = "Corpus", FUN = "function"),
164              function(object, FUN, lazy = FALSE, ...) {
165                  result <- object
166                  # Note that text corpora are automatically loaded into memory via \code{[[}
167                  if (DBControl(object)[["useDb"]]) {
168                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
169                      i <- 1
170                      for (id in unlist(object)) {
171                          db[[id]] <- FUN(object[[i]], ..., DMetaData = DMetaData(object))
172                          i <- i + 1
173                      }
174                  }
175                  else {
176                      if (lazy)
177                          meta(result, tag = "lazyTmMap", type = "corpus") <- list(fun = FUN, args = ...)
178                      else
179                          result@.Data <- lapply(object, FUN, ..., DMetaData = DMetaData(object))
180                  }
181                return(result)                return(result)
182            })            })
183    
184  setGeneric("as.plaintext_doc", function(object, FUN, ...) standardGeneric("as.plaintext_doc"))  # Materialize lazy mappings
185  setMethod("as.plaintext_doc",  materialize <- function(corpus) {
186        lazyTmMap <- meta(corpus, tag = "lazyTmMap", type = "corpus")
187        if (!is.null(lazyTmMap))
188            corpus@.Data <- lapply(corpus, lazyTmMap$fun, DMetaData = DMetaData(corpus))
189        return(corpus)
190    }
191    
192    setGeneric("asPlain", function(object, FUN, ...) standardGeneric("asPlain"))
193    setMethod("asPlain",
194            signature(object = "PlainTextDocument"),            signature(object = "PlainTextDocument"),
195            function(object, FUN, ...) {            function(object, FUN, ...) {
196                return(object)                return(object)
197            })            })
198  setMethod("as.plaintext_doc",  setMethod("asPlain",
199            signature(object = "XMLTextDocument", FUN = "function"),            signature(object = "XMLTextDocument", FUN = "function"),
200            function(object, FUN, ...) {            function(object, FUN, ...) {
201                if (!Cached(object))                corpus <- Content(object)
                   object <- load_doc(object)  
   
               corpus <- Corpus(object)  
202    
203                # As XMLDocument is no native S4 class, restore valid information                # As XMLDocument is no native S4 class, restore valid information
204                class(corpus) <- "XMLDocument"                class(corpus) <- "XMLDocument"
# Line 374  Line 206 
206    
207                return(FUN(xmlRoot(corpus), ...))                return(FUN(xmlRoot(corpus), ...))
208            })            })
209    setMethod("asPlain",
210              signature(object = "Reuters21578Document"),
211              function(object, FUN, ...) {
212                  FUN <- convertReut21578XMLPlain
213                  corpus <- Content(object)
214    
215  setGeneric("stem_doc", function(object, ...) standardGeneric("stem_doc"))                # As XMLDocument is no native S4 class, restore valid information
216  setMethod("stem_doc",                class(corpus) <- "XMLDocument"
217            signature(object = "PlainTextDocument"),                names(corpus) <- c("doc","dtd")
           function(object, ...) {  
               if (!Cached(object))  
                   object <- load_doc(object)  
218    
219                require(Rstem)                return(FUN(xmlRoot(corpus), ...))
               splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))  
               stemmedCorpus <- wordStem(splittedCorpus, ...)  
               Corpus(object) <- paste(stemmedCorpus, collapse = " ")  
               return(object)  
220            })            })
221    setMethod("asPlain",
222              signature(object = "RCV1Document"),
223              function(object, FUN, ...) {
224                  FUN <- convertRCV1Plain
225                  corpus <- Content(object)
226    
227  setGeneric("remove_words", function(object, stopwords, ...) standardGeneric("remove_words"))                # As XMLDocument is no native S4 class, restore valid information
228  setMethod("remove_words",                class(corpus) <- "XMLDocument"
229            signature(object = "PlainTextDocument", stopwords = "character"),                names(corpus) <- c("doc","dtd")
           function(object, stopwords, ...) {  
               if (!Cached(object))  
                   object <- load_doc(object)  
230    
231                require(Rstem)                return(FUN(xmlRoot(corpus), ...))
232                splittedCorpus <- unlist(strsplit(object, " ", fixed = TRUE))            })
233                noStopwordsCorpus <- splittedCorpus[!splittedCorpus %in% stopwords]  setMethod("asPlain",
234                Corpus(object) <- paste(noStopwordsCorpus, collapse = " ")            signature(object = "NewsgroupDocument"),
235                return(object)            function(object, FUN, ...) {
236                  new("PlainTextDocument", .Data = Content(object), Cached = TRUE, URI = "", Author = Author(object),
237                      DateTimeStamp = DateTimeStamp(object), Description = Description(object), ID = ID(object),
238                      Origin = Origin(object), Heading = Heading(object), Language = Language(object),
239                      LocalMetaData = LocalMetaData(object))
240              })
241    setMethod("asPlain",
242              signature(object = "StructuredTextDocument"),
243              function(object, FUN, ...) {
244                  new("PlainTextDocument", .Data = unlist(Content(object)), Cached = TRUE,
245                      URI = "", Author = Author(object), DateTimeStamp = DateTimeStamp(object),
246                      Description = Description(object), ID = ID(object), Origin = Origin(object),
247                      Heading = Heading(object), Language = Language(object),
248                      LocalMetaData = LocalMetaData(object))
249            })            })
250    
251  setGeneric("tm_filter", function(object, ..., FUN = s_filter) standardGeneric("tm_filter"))  setGeneric("tmFilter", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmFilter"))
252  setMethod("tm_filter",  setMethod("tmFilter",
253            signature(object = "TextDocCol"),            signature(object = "Corpus"),
254            function(object, ..., FUN = s_filter) {            function(object, ..., FUN = sFilter, doclevel = FALSE) {
255                object[tm_index(object, ..., FUN)]                if (doclevel)
256                      return(object[sapply(object, FUN, ..., DMetaData = DMetaData(object))])
257                  else
258                      return(object[FUN(object, ...)])
259            })            })
260    
261  setGeneric("tm_index", function(object, ..., FUN = s_filter) standardGeneric("tm_index"))  setGeneric("tmIndex", function(object, ..., FUN = sFilter, doclevel = FALSE) standardGeneric("tmIndex"))
262  setMethod("tm_index",  setMethod("tmIndex",
263            signature(object = "TextDocCol"),            signature(object = "Corpus"),
264            function(object, ..., FUN = s_filter) {            function(object, ..., FUN = sFilter, doclevel = FALSE) {
265                sapply(object, FUN, ..., GlobalMetaData = GlobalMetaData(object))                if (doclevel)
266                      return(sapply(object, FUN, ..., DMetaData = DMetaData(object)))
267                  else
268                      return(FUN(object, ...))
269            })            })
270    
271  s_filter <- function(object, s, ..., GlobalMetaData) {  sFilter <- function(object, s, ...) {
272      b <- TRUE      con <- textConnection(s)
273      for (tag in names(s)) {      tokens <- scan(con, "character", quiet = TRUE)
274          if (tag %in% names(LocalMetaData(object))) {      close(con)
275              b <- b && any(grep(s[[tag]], LocalMetaData(object)[[tag]]))      localMetaNames <- unique(names(sapply(object, LocalMetaData)))
276          } else if (tag %in% names(GlobalMetaData)){      localMetaTokens <- localMetaNames[localMetaNames %in% tokens]
277              b <- b && any(grep(s[[tag]], GlobalMetaData[[tag]]))      n <- names(DMetaData(object))
278          } else {      tags <- c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language", localMetaTokens)
279              b <- b && any(grep(s[[tag]], eval(call(tag, object))))      query.df <- DMetaData(prescindMeta(object, tags))
280          }      if (DBControl(object)[["useDb"]])
281      }          DMetaData(object) <- DMetaData(object)[, setdiff(n, tags), drop = FALSE]
282      return(b)      # Rename to avoid name conflicts
283        names(query.df)[names(query.df) == "Author"] <- "author"
284        names(query.df)[names(query.df) == "DateTimeStamp"] <- "datetimestamp"
285        names(query.df)[names(query.df) == "Description"] <- "description"
286        names(query.df)[names(query.df) == "ID"] <- "identifier"
287        names(query.df)[names(query.df) == "Origin"] <- "origin"
288        names(query.df)[names(query.df) == "Heading"] <- "heading"
289        names(query.df)[names(query.df) == "Language"] <- "language"
290        attach(query.df)
291        try(result <- rownames(query.df) %in% row.names(query.df[eval(parse(text = s)), ]))
292        detach(query.df)
293        return(result)
294  }  }
295    
296  setGeneric("fulltext_search_filter", function(object, pattern, ...) standardGeneric("fulltext_search_filter"))  setGeneric("appendElem", function(object, data, meta = NULL) standardGeneric("appendElem"))
297  setMethod("fulltext_search_filter",  setMethod("appendElem",
298            signature(object = "PlainTextDocument", pattern = "character"),            signature(object = "Corpus", data = "TextDocument"),
299            function(object, pattern, ...) {            function(object, data, meta = NULL) {
300                if (!Cached(object))                if (DBControl(object)[["useDb"]]) {
301                    object <- load_doc(object)                    db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
302                      if (dbExists(db, ID(data)))
303                return(any(grep(pattern, Corpus(object))))                        warning("document with identical ID already exists")
304                      dbInsert(db, ID(data), data)
305                      object@.Data[[length(object)+1]] <- ID(data)
306                  }
307                  else
308                      object@.Data[[length(object)+1]] <- data
309                  DMetaData(object) <- rbind(DMetaData(object), c(MetaID = CMetaData(object)@NodeID, meta))
310                  return(object)
311            })            })
312    
313  setGeneric("attach_data", function(object, data) standardGeneric("attach_data"))  setGeneric("appendMeta", function(object, cmeta = NULL, dmeta = NULL) standardGeneric("appendMeta"))
314  setMethod("attach_data",  setMethod("appendMeta",
315            signature(object = "TextDocCol", data = "TextDocument"),            signature(object = "Corpus"),
316            function(object, data) {            function(object, cmeta = NULL, dmeta = NULL) {
317                data <- as(list(data), "TextDocCol")                object@CMetaData@MetaData <- c(CMetaData(object)@MetaData, cmeta)
318                object@.Data <- as(c(object@.Data, data), "TextDocCol")                if (!is.null(dmeta)) {
319                      DMetaData(object) <- cbind(DMetaData(object), eval(dmeta))
320                  }
321                return(object)                return(object)
322            })            })
323    
324  setGeneric("attach_metadata", function(object, name, metadata) standardGeneric("attach_metadata"))  setGeneric("removeMeta", function(object, cname = NULL, dname = NULL) standardGeneric("removeMeta"))
325  setMethod("attach_metadata",  setMethod("removeMeta",
326            signature(object = "TextDocCol"),            signature(object = "Corpus"),
327            function(object, name, metadata) {            function(object, cname = NULL, dname = NULL) {
328                object@GlobalMetaData <- c(GlobalMetaData(object), new = list(metadata))                if (!is.null(cname))
329                names(object@GlobalMetaData)[length(names(GlobalMetaData(object)))] <- name                    object@CMetaData@MetaData <- CMetaData(object)@MetaData[names(CMetaData(object)@MetaData) != cname]
330                  if (!is.null(dname))
331                      DMetaData(object) <- DMetaData(object)[, names(DMetaData(object)) != dname, drop = FALSE]
332                return(object)                return(object)
333            })            })
334    
335  setGeneric("set_subscriptable", function(object, name) standardGeneric("set_subscriptable"))  setGeneric("prescindMeta", function(object, meta) standardGeneric("prescindMeta"))
336  setMethod("set_subscriptable",  setMethod("prescindMeta",
337            signature(object = "TextDocCol"),            signature(object = "Corpus", meta = "character"),
338            function(object, name) {            function(object, meta) {
339                if (!is.character(GlobalMetaData(object)$subscriptable))                for (m in meta) {
340                    object <- attach_metadata(object, "subscriptable", name)                    if (m %in% c("Author", "DateTimeStamp", "Description", "ID", "Origin", "Heading", "Language")) {
341                else                        local.m <- lapply(object, m)
342                    object@GlobalMetaData$subscriptable <- c(GlobalMetaData(object)$subscriptable, name)                        local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
343                          local.m <- unlist(local.m)
344                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
345                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
346                      }
347                      else {
348                          local.meta <- lapply(object, LocalMetaData)
349                          local.m <- lapply(local.meta, "[[", m)
350                          local.m <- lapply(local.m, function(x) if (is.null(x)) return(NA) else return(x))
351                          if (length(local.m) == length(unlist(local.m)))
352                              local.m <- unlist(local.m)
353                          else
354                              local.m <- I(local.m)
355                          DMetaData(object) <- cbind(DMetaData(object), data.frame(m = local.m, stringsAsFactors = FALSE))
356                          names(DMetaData(object))[which(names(DMetaData(object)) == "m")] <- m
357                      }
358                  }
359                return(object)                return(object)
360            })            })
361    
362  setMethod("[",  setMethod("[",
363            signature(x = "TextDocCol", i = "ANY", j = "ANY", drop = "ANY"),            signature(x = "Corpus", i = "ANY", j = "ANY", drop = "ANY"),
364            function(x, i, j, ... , drop) {            function(x, i, j, ... , drop) {
365                if(missing(i))                if(missing(i))
366                    return(x)                    return(x)
367    
368                object <- x                object <- x
369                object@.Data <- x@.Data[i, ..., drop = FALSE]                object@.Data <- x@.Data[i, ..., drop = FALSE]
370                for (m in names(GlobalMetaData(object))) {                if (DBControl(object)[["useDb"]]) {
371                    if (m %in% GlobalMetaData(object)$subscriptable) {                    index <- object@DMetaData[[1 , "subset"]]
372                        object@GlobalMetaData[[m]] <- GlobalMetaData(object)[[m]][i, ..., drop = FALSE]                    if (any(is.na(index)))
373                    }                        object@DMetaData[[1 , "subset"]] <- i
374                      else
375                          object@DMetaData[[1 , "subset"]] <- index[i]
376                }                }
377                  else
378                      DMetaData(object) <- DMetaData(x)[i, , drop = FALSE]
379                return(object)                return(object)
380            })            })
381    
382  setMethod("[<-",  setMethod("[<-",
383            signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),            signature(x = "Corpus", i = "ANY", j = "ANY", value = "ANY"),
384            function(x, i, j, ... , value) {            function(x, i, j, ... , value) {
385                object <- x                object <- x
386                  if (DBControl(object)[["useDb"]]) {
387                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
388                      counter <- 1
389                      for (id in object@.Data[i, ...]) {
390                          if (length(value) == 1)
391                              db[[id]] <- value
392                          else {
393                              db[[id]] <- value[[counter]]
394                          }
395                          counter <- counter + 1
396                      }
397                  }
398                  else
399                object@.Data[i, ...] <- value                object@.Data[i, ...] <- value
400                return(object)                return(object)
401            })            })
402    
403    # ToDo: Implement on-demand materialization of lazy mappings
404  setMethod("[[",  setMethod("[[",
405            signature(x = "TextDocCol", i = "ANY", j = "ANY"),            signature(x = "Corpus", i = "ANY", j = "ANY"),
406            function(x, i, j, ...) {            function(x, i, j, ...) {
407                return(x@.Data[[i, ...]])                if (DBControl(x)[["useDb"]]) {
408                      db <- dbInit(DBControl(x)[["dbName"]], DBControl(x)[["dbType"]])
409                      result <- dbFetch(db, x@.Data[[i]])
410                      return(loadDoc(result))
411                  }
412                  else
413                      return(loadDoc(x@.Data[[i]]))
414            })            })
415    
416  setMethod("[[<-",  setMethod("[[<-",
417            signature(x = "TextDocCol", i = "ANY", j = "ANY", value = "ANY"),            signature(x = "Corpus", i = "ANY", j = "ANY", value = "ANY"),
418            function(x, i, j, ..., value) {            function(x, i, j, ..., value) {
419                object <- x                object <- x
420                  if (DBControl(object)[["useDb"]]) {
421                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
422                      index <- object@.Data[[i]]
423                      db[[index]] <- value
424                  }
425                  else
426                object@.Data[[i, ...]] <- value                object@.Data[[i, ...]] <- value
427                return(object)                return(object)
428            })            })
429    
430    # Update \code{NodeID}s of a CMetaData tree
431    update_id <- function(object, id = 0, mapping = NULL, left.mapping = NULL, level = 0) {
432        # Traversal of (binary) CMetaData tree with setup of \code{NodeID}s
433        set_id <- function(object) {
434            object@NodeID <- id
435            id <<- id + 1
436            level <<- level + 1
437    
438            if (length(object@children) > 0) {
439                mapping <<- cbind(mapping, c(object@children[[1]]@NodeID, id))
440                left <- set_id(object@children[[1]])
441                if (level == 1) {
442                    left.mapping <<- mapping
443                    mapping <<- NULL
444                }
445                mapping <<- cbind(mapping, c(object@children[[2]]@NodeID, id))
446                right <- set_id(object@children[[2]])
447    
448                object@children <- list(left, right)
449            }
450            level <<- level - 1
451    
452            return(object)
453        }
454    
455        return(list(root = set_id(object), left.mapping = left.mapping, right.mapping = mapping))
456    }
457    
458  setMethod("c",  setMethod("c",
459            signature(x = "TextDocCol"),            signature(x = "Corpus"),
460            function(x, ..., recursive = TRUE){            function(x, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
461                args <- list(...)                args <- list(...)
462                if(length(args) == 0)                if(length(args) == 0)
463                    return(x)                    return(x)
464                return(as(c(as(x, "list"), ...), "TextDocCol"))  
465                  if (!all(sapply(args, inherits, "Corpus")))
466                      stop("not all arguments are text document collections")
467                  if (DBControl(x)[["useDb"]] == TRUE || any(unlist(sapply(args, DBControl)["useDb", ])))
468                      stop("concatenating text document collections with activated database is not supported")
469    
470                  result <- x
471                  for (c in args) {
472                      result <- c2(result, c)
473                  }
474                  return(result)
475              })
476    
477    setGeneric("c2", function(x, y, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) standardGeneric("c2"))
478    setMethod("c2",
479              signature(x = "Corpus", y = "Corpus"),
480              function(x, y, ..., meta = list(merge_date = Sys.time(), merger = Sys.getenv("LOGNAME")), recursive = TRUE) {
481                  object <- x
482                  # Concatenate data slots
483                  object@.Data <- c(as(x, "list"), as(y, "list"))
484    
485                  # Set the DBControl slot
486                  object@DBControl <- list(useDb = FALSE, dbName = "", dbType = "DB1")
487    
488                  # Update the CMetaData tree
489                  cmeta <- new("MetaDataNode", NodeID = 0, MetaData = meta, children = list(CMetaData(x), CMetaData(y)))
490                  update.struct <- update_id(cmeta)
491                  object@CMetaData <- update.struct$root
492    
493                  # Find indices to be updated for the left tree
494                  indices.mapping <- NULL
495                  for (m in levels(as.factor(DMetaData(x)$MetaID))) {
496                      indices <- (DMetaData(x)$MetaID == m)
497                      indices.mapping <- c(indices.mapping, list(m = indices))
498                      names(indices.mapping)[length(indices.mapping)] <- m
499                  }
500    
501                  # Update the DMetaData data frames for the left tree
502                  for (i in 1:ncol(update.struct$left.mapping)) {
503                      map <- update.struct$left.mapping[,i]
504                      x@DMetaData$MetaID <- replace(DMetaData(x)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
505                  }
506    
507                  # Find indices to be updated for the right tree
508                  indices.mapping <- NULL
509                  for (m in levels(as.factor(DMetaData(y)$MetaID))) {
510                      indices <- (DMetaData(y)$MetaID == m)
511                      indices.mapping <- c(indices.mapping, list(m = indices))
512                      names(indices.mapping)[length(indices.mapping)] <- m
513                  }
514    
515                  # Update the DMetaData data frames for the right tree
516                  for (i in 1:ncol(update.struct$right.mapping)) {
517                      map <- update.struct$right.mapping[,i]
518                      y@DMetaData$MetaID <- replace(DMetaData(y)$MetaID, indices.mapping[[as.character(map[1])]], map[2])
519                  }
520    
521                  # Merge the DMetaData data frames
522                  labels <- setdiff(names(DMetaData(y)), names(DMetaData(x)))
523                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(x)), ncol = length(labels), dimnames = list(row.names(DMetaData(x)), labels))
524                  x.dmeta.aug <- cbind(DMetaData(x), na.matrix)
525                  labels <- setdiff(names(DMetaData(x)), names(DMetaData(y)))
526                  na.matrix <- matrix(NA, nrow = nrow(DMetaData(y)), ncol = length(labels), dimnames = list(row.names(DMetaData(y)), labels))
527                  y.dmeta.aug <- cbind(DMetaData(y), na.matrix)
528                  object@DMetaData <- rbind(x.dmeta.aug, y.dmeta.aug)
529    
530                  return(object)
531      })      })
532    
533  setMethod("c",  setMethod("c",
534            signature(x = "TextDocument"),            signature(x = "TextDocument"),
535            function(x, ..., recursive = TRUE){            function(x, ..., recursive = TRUE){
536                args <- list(...)                args <- list(...)
537                if(length(args) == 0)                if(length(args) == 0)
538                    return(x)                    return(x)
539                return(new("TextDocCol", .Data = list(x, ...)))  
540                  dmeta.df <- data.frame(MetaID = rep(0, length(list(x, ...))), stringsAsFactors = FALSE)
541                  cmeta.node <- new("MetaDataNode",
542                                NodeID = 0,
543                                MetaData = list(create_date = Sys.time(), creator = Sys.getenv("LOGNAME")),
544                                children = list())
545    
546                  return(new("Corpus",
547                             .Data = list(x, ...),
548                             DMetaData = dmeta.df,
549                             CMetaData = cmeta.node,
550                             DBControl = list(useDb = FALSE, dbName = "", dbType = "DB1")))
551      })      })
552    
553  setMethod("length",  setMethod("length",
554            signature(x = "TextDocCol"),            signature(x = "Corpus"),
555            function(x){            function(x){
556                return(length(as(x, "list")))                return(length(as(x, "list")))
557      })      })
558    
559  setMethod("show",  setMethod("show",
560            signature(object = "TextDocCol"),            signature(object = "Corpus"),
561            function(object){            function(object){
562                cat("A text document collection with", length(object), "text document")                cat(sprintf(ngettext(length(object),
563                if (length(object) == 1)                                     "A text document collection with %d text document\n",
564                    cat("\n")                                     "A text document collection with %d text documents\n"),
565                else                            length(object)))
                   cat("s\n")  
566      })      })
567    
568  setMethod("summary",  setMethod("summary",
569            signature(object = "TextDocCol"),            signature(object = "Corpus"),
570            function(object){            function(object){
571                show(object)                show(object)
572                if (length(GlobalMetaData(object)) > 0) {                if (length(DMetaData(object)) > 0) {
573                    cat("\nThe global metadata consists of", length(GlobalMetaData(object)), "tag-value pair")                    cat(sprintf(ngettext(length(CMetaData(object)@MetaData),
574                    if (length(GlobalMetaData(object)) == 1)                                                "\nThe metadata consists of %d tag-value pair and a data frame\n",
575                        cat(".\n")                                                "\nThe metadata consists of %d tag-value pairs and a data frame\n"),
576                    else                                         length(CMetaData(object)@MetaData)))
                       cat("s.\n")  
577                    cat("Available tags are:\n")                    cat("Available tags are:\n")
578                    cat(names(GlobalMetaData(object)), "\n")                    cat(strwrap(paste(names(CMetaData(object)@MetaData), collapse = " "), indent = 2, exdent = 2), "\n")
579                      cat("Available variables in the data frame are:\n")
580                      cat(strwrap(paste(names(DMetaData(object)), collapse = " "), indent = 2, exdent = 2), "\n")
581                }                }
582      })      })
583    
584  setGeneric("inspect", function(object) standardGeneric("inspect"))  setGeneric("inspect", function(object) standardGeneric("inspect"))
585  setMethod("inspect",  setMethod("inspect",
586            signature("TextDocCol"),            signature("Corpus"),
587            function(object) {            function(object) {
588                summary(object)                summary(object)
589                cat("\n")                cat("\n")
590                show(as(object, "list"))                if (DBControl(object)[["useDb"]]) {
591                      db <- dbInit(DBControl(object)[["dbName"]], DBControl(object)[["dbType"]])
592                      show(dbMultiFetch(db, unlist(object)))
593                  }
594                  else
595                      show(object@.Data)
596            })            })
597    
598  # No metadata is checked  # No metadata is checked
599  setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))  setGeneric("%IN%", function(x, y) standardGeneric("%IN%"))
600  setMethod("%IN%",  setMethod("%IN%",
601            signature(x = "TextDocument", y = "TextDocCol"),            signature(x = "TextDocument", y = "Corpus"),
602            function(x, y) {            function(x, y) {
603                x %in% y                if (DBControl(y)[["useDb"]]) {
604                      db <- dbInit(DBControl(y)[["dbName"]], DBControl(y)[["dbType"]])
605                      result <- any(sapply(y, function(x, z) {x %in% Content(z)}, x))
606                  }
607                  else
608                      result <- x %in% y
609                  return(result)
610              })
611    
612    setMethod("lapply",
613              signature(X = "Corpus"),
614              function(X, FUN, ...) {
615                  if (DBControl(X)[["useDb"]]) {
616                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
617                      result <- lapply(dbMultiFetch(db, unlist(X)), FUN, ...)
618                  }
619                  else
620                      result <- base::lapply(X, FUN, ...)
621                  return(result)
622              })
623    
624    setMethod("sapply",
625              signature(X = "Corpus"),
626              function(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE) {
627                  if (DBControl(X)[["useDb"]]) {
628                      db <- dbInit(DBControl(X)[["dbName"]], DBControl(X)[["dbType"]])
629                      result <- sapply(dbMultiFetch(db, unlist(X)), FUN, ...)
630                  }
631                  else
632                      result <- base::sapply(X, FUN, ...)
633                  return(result)
634              })
635    
636    setGeneric("writeCorpus", function(object, path = ".", filenames = NULL) standardGeneric("writeCorpus"))
637    setMethod("writeCorpus",
638              signature(object = "Corpus"),
639              function(object, path = ".", filenames = NULL) {
640                  filenames <- file.path(path,
641                                         if (is.null(filenames)) sapply(object, function(x) sprintf("%s.txt", ID(x)))
642                                         else filenames)
643                  i <- 1
644                  for (o in object) {
645                      writeLines(o, filenames[i])
646                      i <- i + 1
647                  }
648            })            })

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

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