mongo::IndexType Class Reference

#include <indexkey.h>

List of all members.

Public Member Functions

virtual int compare (const BSONObj &l, const BSONObj &r) const
virtual BSONObj fixKey (const BSONObj &in)
virtual void getKeys (const BSONObj &obj, BSONObjSetDefaultOrder &keys) const =0
const IndexPlugingetPlugin () const
 IndexType (const IndexPlugin *plugin, const IndexSpec *spec)
const BSONObjkeyPattern () const
virtual shared_ptr< CursornewCursor (const BSONObj &query, const BSONObj &order, int numWanted) const =0
virtual bool scanAndOrderRequired (const BSONObj &query, const BSONObj &order) const
virtual IndexSuitability suitability (const BSONObj &query, const BSONObj &order) const
virtual ~IndexType ()

Protected Attributes

const IndexPlugin_plugin
const IndexSpec_spec

Detailed Description

this represents an instance of a index plugin done this way so parsing, etc... can be cached so if there is a FTS IndexPlugin, for each index using FTS there will be 1 of these, and it can have things pre-parsed, etc...

Definition at line 42 of file indexkey.h.


Constructor & Destructor Documentation

mongo::IndexType::IndexType ( const IndexPlugin plugin,
const IndexSpec spec 
)
virtual mongo::IndexType::~IndexType (  )  [virtual]

Member Function Documentation

virtual int mongo::IndexType::compare ( const BSONObj l,
const BSONObj r 
) const [virtual]

optional op : compare 2 objects with regards to this index

virtual BSONObj mongo::IndexType::fixKey ( const BSONObj in  )  [inline, virtual]

optional op : changes query to match what's in the index

Definition at line 51 of file indexkey.h.

virtual void mongo::IndexType::getKeys ( const BSONObj obj,
BSONObjSetDefaultOrder keys 
) const [pure virtual]
const IndexPlugin* mongo::IndexType::getPlugin (  )  const [inline]
Returns:
plugin

Definition at line 57 of file indexkey.h.

const BSONObj& mongo::IndexType::keyPattern (  )  const
virtual shared_ptr<Cursor> mongo::IndexType::newCursor ( const BSONObj query,
const BSONObj order,
int  numWanted 
) const [pure virtual]
virtual bool mongo::IndexType::scanAndOrderRequired ( const BSONObj query,
const BSONObj order 
) const [virtual]
virtual IndexSuitability mongo::IndexType::suitability ( const BSONObj query,
const BSONObj order 
) const [virtual]

Member Data Documentation

Definition at line 66 of file indexkey.h.

const IndexSpec* mongo::IndexType::_spec [protected]

Definition at line 67 of file indexkey.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


mongodb
Author(s): Nate Koenig
autogenerated on Fri Jan 11 12:15:55 2013