SCM

SCM Repository

[tm] Annotation of /trunk/tm/man/XMLTextDocument-class.Rd
ViewVC logotype

Annotation of /trunk/tm/man/XMLTextDocument-class.Rd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 693 - (view) (download) (as text)

1 : feinerer 58 \name{XMLTextDocument-class}
2 :     \docType{class}
3 :     \alias{XMLTextDocument-class}
4 :     \alias{Corpus,XMLTextDocument-method}
5 :     \alias{Corpus<-,XMLTextDocument-method}
6 : feinerer 67 \alias{URI,XMLTextDocument-method}
7 : feinerer 58 \alias{Cached,XMLTextDocument-method}
8 :     \alias{Cached<-,XMLTextDocument-method}
9 :     \title{Text document}
10 :     \description{
11 :     A class representing an XML text document with additional
12 :     information. The XML document itself is represented by an
13 :     \code{XMLDocument} from the \code{XML} library.
14 :     }
15 :     \section{Objects from the Class}{
16 :     Objects can be created by calls of the form \code{new("XMLTextDocument", ...)}.
17 :     }
18 :     \section{Slots}{
19 :     \describe{
20 : feinerer 67 \item{\code{URI}:}{Object of class \code{character} containing
21 : feinerer 58 the path and filename holding the data physically on disk}
22 :     \item{\code{Cached}:}{Object of class \code{numeric} containing the
23 :     status whether the file was already loaded in memory. Zero indicates
24 :     not loaded, a value greater zero indicates in memory.}
25 :     }
26 :     }
27 :     \section{Extends}{
28 :     Class \code{list} and \code{TextDocument}, directly.
29 :     }
30 :     \section{Methods}{
31 :     \describe{
32 :     \item{Corpus}{\code{signature(object = "XMLTextDocument")}: returns the
33 :     text corpus, i.e., the actual XMLDocument in the data slot}
34 :     \item{Corpus<-}{\code{signature(object = "XMLTextDocument")}: sets the
35 :     text corpus, i.e., the actual XMLDocument in data slot}
36 : feinerer 67 \item{URI}{\code{signature(object = "XMLTextDocument")}: returns the
37 : feinerer 58 filename on disk}
38 :     \item{Cached}{\code{signature(object = "XMLTextDocument")}: returns
39 :     status information for loading on demand}
40 :     \item{Cached<-}{\code{signature(object = "XMLTextDocument")}: sets
41 :     status information for loading on demand}
42 :     }
43 :     }
44 : feinerer 62 \author{Ingo Feinerer}
45 : feinerer 58 \keyword{classes}

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