#include <fields.h>

Inheritance diagram for jazz_bebop::Fields:

Public Member Functions
	Fields (pBaseAPI api)
	Bop: Start the Fields.

virtual StatusCode	start ()

virtual pChar const	id ()

Public Member Functions inherited from jazz_bebop::Space
	Space (pBaseAPI api, pName a_name)
	Bop: Create the Space.

virtual StatusCode	shut_down ()

virtual StatusCode	load_meta ()
	Load the metadata of the Space.

virtual StatusCode	save_meta ()
	Save the metadata of the Space.

virtual RowNumber	num_rows ()
	Return the number of rows in the Space.

virtual void *	get_index_data (RowNumber row)
	Get a pointer to the data of the index of a given row.

virtual int	num_cols ()
	Get the number of columns in the Space.

virtual pName	col_name (int col)
	Get the name of a column.

virtual int	col_index (pName name)
	Get the index of a column.

virtual pLocator	locator (RowNumber row, int col, int &index)
	Get the location of a cell as a Locator.

virtual pRowSelection	where (pChar query)
	Get a RowSelection from a query.

virtual pColSelection	select (pChar query)
	Get a ColSelection from a query.

virtual pCaster	as (pChar query)
	Get the appropriate Caster from the AS clause of a query.

virtual bool	register_caster (pCaster cast)
	Register a Caster descendant to make it available in queries.

virtual StatusCode	get_row (pTransaction &p_txn, RowNumber row, pColSelection cols=nullptr, pCaster cast=nullptr)
	Get a row from the Space as a Tuple.

Public Member Functions inherited from jazz_elements::Service
	Service (pLogger a_logger, pConfigFile a_config)

void	log (int loglevel, const char *message)

void	log_printf (int loglevel, const char *fmt,...)

bool	get_conf_key (const char *key, int &value)

bool	get_conf_key (const char *key, double &value)

bool	get_conf_key (const char *key, std::string &value)

Private Attributes
Name	storage_ent
	The name of the storage entity (Typically an lmdb database with the metadata of all SemSpaces).

pVolatile	p_volatile
	The Volatile container.

pPersisted	p_persisted
	The Persisted container.

pBaseAPI	p_api
	A pointer to the BaseAPI that provides access to containers.

Additional Inherited Members
Data Fields inherited from jazz_elements::Service
pLogger	p_log
	The logger.

pConfigFile	p_conf
	The configuration file.

Protected Attributes inherited from jazz_bebop::Space
char	storage_base [SHORT_NAME_SIZE]
	The base name of the storage container.

Name	name
	The name of the Space.

pBaseAPI	p_api
	A pointer to the BaseAPI that provides access to containers.

Casters	casters
	A map of all the available Casters.

Detailed Description

Fields: A Space for Snippets.

A Fields is Space interface to the base index of the Volatile Container. The entity is the Fields and the key is the name of the snippet.

A field is a namespace inside Fields.

Constructor & Destructor Documentation

◆ Fields()

jazz_bebop::Fields::Fields ( pBaseAPI api )

Bop: Start the Fields.

Parameters

api	A pointer to a BaseAPI that provides access to containers.

Member Function Documentation

◆ start()

StatusCode jazz_bebop::Fields::start ( )

virtual

Starts the Fields service

Returns: SERVICE_NO_ERROR if successful, an error code otherwise.

Reimplemented from jazz_bebop::Space.

Reimplemented in jazz_models::SemSpaces.

◆ id()

pChar const jazz_bebop::Fields::id ( )

virtual

Return object ID.

Returns: A string identifying the object that is especially useful to track uplifts and versions.

Reimplemented from jazz_elements::Service.

Reimplemented in jazz_models::SemSpaces.

The documentation for this class was generated from the following files:

fields.h
fields.cpp

Public Member Functions