BiodbDbInfo: A class for describing the characteristics of a database.

In pkrog/biodb: biodb, a library and a development framework for connecting to chemical and biological databases

A class for describing the characteristics of a database.

Description

This class is used by BiodbDbsInfo for storing database characteristics, and returning them through the get() method. This class inherits from BiodbConnBase.

Super class

biodb::BiodbConnBase -> BiodbDbInfo

Methods

Public methods

• BiodbDbInfo$clone()

Inherited methods

• biodb::BiodbConnBase$getBaseUrl()
• biodb::BiodbConnBase$getConnClass()
• biodb::BiodbConnBase$getConnClassName()
• biodb::BiodbConnBase$getDbClass()
• biodb::BiodbConnBase$getEntryClass()
• biodb::BiodbConnBase$getEntryClassName()
• biodb::BiodbConnBase$getEntryContentType()
• biodb::BiodbConnBase$getEntryFileExt()
• biodb::BiodbConnBase$getEntryIdField()
• biodb::BiodbConnBase$getName()
• biodb::BiodbConnBase$getPropSlots()
• biodb::BiodbConnBase$getPropValSlot()
• biodb::BiodbConnBase$getPropertyValue()
• biodb::BiodbConnBase$getSchedulerNParam()
• biodb::BiodbConnBase$getSchedulerTParam()
• biodb::BiodbConnBase$getToken()
• biodb::BiodbConnBase$getUrl()
• biodb::BiodbConnBase$getUrls()
• biodb::BiodbConnBase$getWsUrl()
• biodb::BiodbConnBase$getXmlNs()
• biodb::BiodbConnBase$hasProp()
• biodb::BiodbConnBase$hasPropSlot()
• biodb::BiodbConnBase$initialize()
• biodb::BiodbConnBase$isSlotProp()
• biodb::BiodbConnBase$print()
• biodb::BiodbConnBase$propExists()
• biodb::BiodbConnBase$setBaseUrl()
• biodb::BiodbConnBase$setPropValSlot()
• biodb::BiodbConnBase$setPropertyValue()
• biodb::BiodbConnBase$setSchedulerNParam()
• biodb::BiodbConnBase$setSchedulerTParam()
• biodb::BiodbConnBase$setToken()
• biodb::BiodbConnBase$setUrl()
• biodb::BiodbConnBase$setWsUrl()
• biodb::BiodbConnBase$updatePropertiesDefinition()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

BiodbDbInfo$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Parent class BiodbDbsInfo and super class BiodbConnBase.

Examples

# Create an instance with default settings:
mybiodb <- biodb::newInst()

# Get a BiodbDbInfo object for a database:
mybiodb$getDbsInfo()$get('comp.csv.file')

# Terminate instance.
mybiodb$terminate()

pkrog/biodb documentation built on Nov. 29, 2022, 4:24 a.m.