SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 78 - (download) (as text) (annotate)
Wed Nov 29 14:56:36 2006 UTC (12 years, 11 months ago) by zeileis
Original Path: trunk/textmin/man/XMLTextDocument-class.Rd
File size: 1734 byte(s)
removed old repos structure, now only R packages
\name{XMLTextDocument-class}
\docType{class}
\alias{XMLTextDocument-class}
\alias{Corpus,XMLTextDocument-method}
\alias{Corpus<-,XMLTextDocument-method}
\alias{URI,XMLTextDocument-method}
\alias{Cached,XMLTextDocument-method}
\alias{Cached<-,XMLTextDocument-method}
\title{Text document}
\description{
  A class representing an XML text document with additional
  information. The XML document itself is represented by an
  \code{XMLDocument} from the \code{XML} library.
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("XMLTextDocument", ...)}.
}
\section{Slots}{
  \describe{
    \item{\code{URI}:}{Object of class \code{character} containing
      the path and filename holding the data physically on disk}
    \item{\code{Cached}:}{Object of class \code{numeric} containing the
      status whether the file was already loaded in memory. Zero indicates
      not loaded, a value greater zero indicates in memory.}
  }
}
\section{Extends}{
Class \code{list} and \code{TextDocument}, directly.
}
\section{Methods}{
  \describe{
    \item{Corpus}{\code{signature(object = "XMLTextDocument")}: returns the
      text corpus, i.e., the actual XMLDocument in the data slot}
    \item{Corpus<-}{\code{signature(object = "XMLTextDocument")}: sets the
      text corpus, i.e., the actual XMLDocument in data slot}
    \item{URI}{\code{signature(object = "XMLTextDocument")}: returns the
      filename on disk}
    \item{Cached}{\code{signature(object = "XMLTextDocument")}: returns
      status information for loading on demand}
    \item{Cached<-}{\code{signature(object = "XMLTextDocument")}: sets
      status information for loading on demand}
  }
}
\author{Ingo Feinerer}
\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