1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
|
% $Id: dbObjectId-class.Rd,v 0.1 2008/08/10 18:04:01 psk Exp $
\name{dbObjectId-class}
\docType{class}
\alias{dbObjectId-class}
\title{Class dbObjectId}
\description{
A helper (mixin) class to provide external references in
an R/S-Plus portable way.
}
\section{Objects from the Class}{A virtual Class: No objects may be created from it.}
\section{Slots}{
\describe{
\item{\code{Id}:}{Object of class \code{"integer"}
this is an integer vector holding an opaque reference into a C struct
(may or may not be a C pointer, may or may not have length one).
}
}
}
\section{Methods}{
\describe{
\item{\link{coerce}}{\code{signature(from = "dbObjectId", to = "integer")}: ... }
\item{\link{coerce}}{\code{signature(from = "dbObjectId", to = "numeric")}: ... }
\item{\link{coerce}}{\code{signature(from = "dbObjectId", to = "character")}: ... }
\item{\link{format}}{\code{signature(x = "dbObjectId")}: ... }
\item{\link{print}}{\code{signature(x = "dbObjectId")}: ... }
\item{\link{show}}{\code{signature(object = "dbObjectId")}: ... }
}
}
\note{A cleaner mechanism would use external references, but
historically this class has existed mainly for R/S-Plus portability.}
\examples{\dontrun{
pg <- dbDriver("PostgreSQL")
con <- dbConnect(pg, "user", "password")
is(pg, "dbObjectId") ## True
is(con, "dbObjectId") ## True
isPostgresqlIdCurrent(con) ## True
q("yes")
\$ R
isPostgresqlIdCurrent(con) ## False
}
}
\keyword{classes}
\keyword{interface}
\keyword{database}
% vim: syntax=tex
|