CompSqliteConn: Class for handling a Compound database in SQLite format.

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

Class for handling a Compound database in SQLite format.

Description

This is the connector class for a Compound database.

Super classes

biodb::BiodbConnBase -> biodb::BiodbConn -> biodb::SqliteConn -> CompSqliteConn

Methods

Public methods

• CompSqliteConn$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$isSlotProp()
• 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()
• biodb::BiodbConn$addNewEntry()
• biodb::BiodbConn$allowEditing()
• biodb::BiodbConn$allowWriting()
• biodb::BiodbConn$annotateMzValues()
• biodb::BiodbConn$checkDb()
• biodb::BiodbConn$collapseResultsDataFrame()
• biodb::BiodbConn$correctIds()
• biodb::BiodbConn$deleteAllCacheEntries()
• biodb::BiodbConn$deleteAllEntriesFromPersistentCache()
• biodb::BiodbConn$deleteAllEntriesFromVolatileCache()
• biodb::BiodbConn$deleteWholePersistentCache()
• biodb::BiodbConn$disallowEditing()
• biodb::BiodbConn$disallowWriting()
• biodb::BiodbConn$download()
• biodb::BiodbConn$editingIsAllowed()
• biodb::BiodbConn$filterEntriesOnRt()
• biodb::BiodbConn$getAllCacheEntries()
• biodb::BiodbConn$getAllVolatileCacheEntries()
• biodb::BiodbConn$getBiodb()
• biodb::BiodbConn$getCacheFile()
• biodb::BiodbConn$getCacheId()
• biodb::BiodbConn$getChromCol()
• biodb::BiodbConn$getDownloadPath()
• biodb::BiodbConn$getEntry()
• biodb::BiodbConn$getEntryContent()
• biodb::BiodbConn$getEntryContentFromDb()
• biodb::BiodbConn$getEntryContentRequest()
• biodb::BiodbConn$getEntryIds()
• biodb::BiodbConn$getEntryImageUrl()
• biodb::BiodbConn$getEntryPageUrl()
• biodb::BiodbConn$getId()
• biodb::BiodbConn$getMatchingMzField()
• biodb::BiodbConn$getMzValues()
• biodb::BiodbConn$getNbEntries()
• biodb::BiodbConn$getNbPeaks()
• biodb::BiodbConn$getSearchableFields()
• biodb::BiodbConn$isCompounddb()
• biodb::BiodbConn$isDownloadable()
• biodb::BiodbConn$isDownloaded()
• biodb::BiodbConn$isEditable()
• biodb::BiodbConn$isExtracted()
• biodb::BiodbConn$isMassdb()
• biodb::BiodbConn$isRemotedb()
• biodb::BiodbConn$isSearchableByField()
• biodb::BiodbConn$isWritable()
• biodb::BiodbConn$makeRequest()
• biodb::BiodbConn$makesRefToEntry()
• biodb::BiodbConn$msmsSearch()
• biodb::BiodbConn$print()
• biodb::BiodbConn$requiresDownload()
• biodb::BiodbConn$searchByName()
• biodb::BiodbConn$searchCompound()
• biodb::BiodbConn$searchForEntries()
• biodb::BiodbConn$searchForMassSpectra()
• biodb::BiodbConn$searchMsEntries()
• biodb::BiodbConn$searchMsPeaks()
• biodb::BiodbConn$searchMzRange()
• biodb::BiodbConn$searchMzTol()
• biodb::BiodbConn$setDownloadedFile()
• biodb::BiodbConn$setEditingAllowed()
• biodb::BiodbConn$setMatchingMzField()
• biodb::BiodbConn$setWritingAllowed()
• biodb::BiodbConn$write()
• biodb::BiodbConn$writingIsAllowed()
• biodb::SqliteConn$getQuery()
• biodb::SqliteConn$hasField()
• biodb::SqliteConn$initialize()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CompSqliteConn$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Super class SqliteConn.

Examples

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

# Get a connector:
chebi_file <- system.file("extdata", "chebi_extract.sqlite", package="biodb")
conn <- mybiodb$getFactory()$createConn('comp.sqlite', url=chebi_file)

# Get an entry
e <- conn$getEntry('1018')

# Terminate instance.
mybiodb$terminate()

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