The BASE API

The Public API is intended to be used by client application or plug-in developers. We guarantee a certain degree of stability among the classes and methods in the public API. See documentation on the BASE web site for more information. Methods that have been tagged as @deprecated should be considered part of the internal API and may be removed without warning in a later release.

The Extension API is intended to be used by developers extending the internal BASE functionality. The classes and interfaces in these packages are not intended to be used by plug-ins or client applications.

The Internal API contains code used by the internal implementation of BASE. Client applications and plug-ins should not use the classes and methods in theese packages.

The Mixed Public and Internal API packages contains some classes that belong to the Public API and some classes that belong to the Internal API.

  • In net.sf.basedb.core.data the BatchableData interface and all classes that implements it part of the public API.
  • The net.sf.basedb.clients.web.util.HTML is part of the public API.
  • The net.sf.basedb.clients.web.Base and net.sf.basedb.clients.web.WebException are part of the public API.

All other classes in are part of the internal API.

All Packages Public API Mixed Public and Internal API Extension API Internal API Other Packages 
Package Description
net.sf.basedb.clients.jobagent  
net.sf.basedb.clients.jobagent.executors  
net.sf.basedb.clients.jobagent.handlers  
net.sf.basedb.clients.jobagent.slotmanager  
net.sf.basedb.clients.web  
net.sf.basedb.clients.web.extensions  
net.sf.basedb.clients.web.extensions.edit  
net.sf.basedb.clients.web.extensions.list  
net.sf.basedb.clients.web.extensions.login  
net.sf.basedb.clients.web.extensions.menu  
net.sf.basedb.clients.web.extensions.plot  
net.sf.basedb.clients.web.extensions.renderer  
net.sf.basedb.clients.web.extensions.section  
net.sf.basedb.clients.web.extensions.service  
net.sf.basedb.clients.web.extensions.skin  
net.sf.basedb.clients.web.extensions.startpage  
net.sf.basedb.clients.web.extensions.tabcontrol  
net.sf.basedb.clients.web.extensions.toolbar  
net.sf.basedb.clients.web.fileupload
This package contains classes for handling file uploads from a browser using the standard described in RFC1867.
net.sf.basedb.clients.web.formatter  
net.sf.basedb.clients.web.plugins  
net.sf.basedb.clients.web.resources  
net.sf.basedb.clients.web.servlet  
net.sf.basedb.clients.web.taglib  
net.sf.basedb.clients.web.taglib.extensions  
net.sf.basedb.clients.web.taglib.menu
This package is a taglib that can be used on JSP pages to build a simple drop-down menu system with unlimited levels.
net.sf.basedb.clients.web.taglib.path  
net.sf.basedb.clients.web.taglib.tab  
net.sf.basedb.clients.web.taglib.table  
net.sf.basedb.clients.web.util  
net.sf.basedb.core
This package contains the core business logic of BASE.
net.sf.basedb.core.authentication  
net.sf.basedb.core.data
This package contains pure data-holder classes which are mapped to the database using Hibernate.
net.sf.basedb.core.data.annotations  
net.sf.basedb.core.data.keyring
This package contains helper classes for the Keyring class.
net.sf.basedb.core.dbengine  
net.sf.basedb.core.hibernate  
net.sf.basedb.core.log  
net.sf.basedb.core.log.db  
net.sf.basedb.core.migrate  
net.sf.basedb.core.migrate.postgres  
net.sf.basedb.core.plugin  
net.sf.basedb.core.query
This package contains the core of the Query API.
net.sf.basedb.core.signal  
net.sf.basedb.core.snapshot  
net.sf.basedb.plugins  
net.sf.basedb.plugins.batchimport  
net.sf.basedb.plugins.executor  
net.sf.basedb.plugins.gtf  
net.sf.basedb.plugins.util  
net.sf.basedb.util
This package contains some useful utility classes and methods.
net.sf.basedb.util.affymetrix  
net.sf.basedb.util.annotations  
net.sf.basedb.util.basefile  
net.sf.basedb.util.bcrypt  
net.sf.basedb.util.bfs  
net.sf.basedb.util.charset  
net.sf.basedb.util.collections  
net.sf.basedb.util.encode  
net.sf.basedb.util.error  
net.sf.basedb.util.excel  
net.sf.basedb.util.export  
net.sf.basedb.util.export.spotdata  
net.sf.basedb.util.extensions  
net.sf.basedb.util.extensions.debug  
net.sf.basedb.util.extensions.events  
net.sf.basedb.util.extensions.manager  
net.sf.basedb.util.extensions.manager.filter  
net.sf.basedb.util.extensions.manager.processor  
net.sf.basedb.util.extensions.xml  
net.sf.basedb.util.fileset  
net.sf.basedb.util.filter  
net.sf.basedb.util.formatter  
net.sf.basedb.util.fuzzy  
net.sf.basedb.util.gtf  
net.sf.basedb.util.importer  
net.sf.basedb.util.importer.spotdata  
net.sf.basedb.util.jep  
net.sf.basedb.util.jep.convert  
net.sf.basedb.util.jobagent  
net.sf.basedb.util.json  
net.sf.basedb.util.listable  
net.sf.basedb.util.ma  
net.sf.basedb.util.overview  
net.sf.basedb.util.overview.cache  
net.sf.basedb.util.overview.extensions  
net.sf.basedb.util.overview.filter  
net.sf.basedb.util.overview.loader  
net.sf.basedb.util.overview.node  
net.sf.basedb.util.overview.validator  
net.sf.basedb.util.parser  
net.sf.basedb.util.plot  
net.sf.basedb.util.query  
net.sf.basedb.util.resources  
net.sf.basedb.util.ssl  
net.sf.basedb.util.timer  
net.sf.basedb.util.transform  
net.sf.basedb.util.units  
net.sf.basedb.util.uri  
net.sf.basedb.util.uri.http  
net.sf.basedb.util.zip