ddc
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
CFreeBiblStringIndex Class Reference

#include <FreeBiblIndex.h>

Inheritance diagram for CFreeBiblStringIndex:
Inheritance graph
[legend]
Collaboration diagram for CFreeBiblStringIndex:
Collaboration graph
[legend]

Classes

struct  CStringItem
 

Public Member Functions

 CFreeBiblStringIndex ()
 
virtual ~CFreeBiblStringIndex ()
 
virtual void clear ()
 
virtual string GetTypeStr () const
 
virtual CFreeBiblIndexTypeId GetTypeId () const
 return bibl-field subtype identifier More...
 
virtual string GetStringValue (DWORD FileNo) const
 
virtual void CreateUnion (const string &Path, const vector< const CFreeBiblIndex *> &Indices, const vector< size_t > &FileCounts)
 
virtual void CreatePartitions (vector< CFreeBiblIndex *> &Parts, const vector< string > &Paths, const vector< DWORD > &EndFileNo) const
 
virtual void RegisterBiblStringItemId (const string &Value)
 
bool DeleteBiblFiles (string Path) const
 
virtual void ReadFromDisk (string Path, DWORD FileBreaksSize, bool useMMap=false)
 
virtual bool ConvertAndSaveToDiskAfterIndexing (string Path)
 
virtual bool GetFilterBounds (CDDCFilterWithBounds &Filter, const string &LoValue, const string &HiValue) const
 
virtual bool GetFilterValue (CDDCFilterWithBounds &Filter, const string &Value) const
 
virtual bool GetFilterValues (CDDCFilterWithBounds &Filter, const string &Regex) const
 
virtual bool GetFilterValues (CDDCFilterWithBounds &Filter, const set< string > &Values) const
 initialize CDDCFilterWithBounds for a set of target values (default throws errLogic) More...
 
virtual size_t size (void) const
 for server info More...
 
virtual DWORD GetIntegerLowerBound (const string &Value) const
 for key-based pruning (v2.1.9): map a single value-string to its value-id More...
 
- Public Member Functions inherited from CFreeBiblIndex
 CFreeBiblIndex ()
 
virtual ~CFreeBiblIndex ()
 
string GetDescriptionStr () const
 
virtual int GetIntegerValue (DWORD FileNo) const
 
virtual const string & GetXpathStr () const
 
virtual bool FileMatches (DWORD FileNo, const CDDCFilterWithBounds &Filter) const
 test whether a given file matches the filter condition (for count(*) queries) More...
 
- Public Member Functions inherited from CFreeBiblIndexInterface
virtual ~CFreeBiblIndexInterface ()
 

Protected Types

typedef map< string, DWORDBuildStringItemsMapT
 

Protected Member Functions

string GetStringFileName (string Path) const
 
void ReadBiblStringItems (string FileName, bool useMMap=false)
 
bool WriteBiblStringItems (const vector< string > &Set, string FileName) const
 
- Protected Member Functions inherited from CFreeBiblIndex
string GetIndexFileName (string Path) const
 

Protected Attributes

BuildStringItemsMapT m_BuildStringItemsMap
 
size_t m_BuildStringItemsSize
 
ddcStringEnum m_ValuesE
 a set of all possible string values for this index More...
 

Additional Inherited Members

- Public Attributes inherited from CFreeBiblIndex
string m_Name
 the name of the index (from options file) More...
 
string m_Xpath
 the XPath to this information (from options file) More...
 
ddcVecFile< DWORDm_ValuesForEachFile
 integer references to m_Values for each corpus file More...
 
bool m_bShowInHeader
 should DDC show this field for each header? More...
 
RML_RE::Optionsm_pRegexOpts
 regex options More...
 

Member Typedef Documentation

◆ BuildStringItemsMapT

typedef map<string,DWORD> CFreeBiblStringIndex::BuildStringItemsMapT
protected

a list that is used during building this bibl-index v2.2.2 : replace with map<>

Constructor & Destructor Documentation

◆ CFreeBiblStringIndex()

CFreeBiblStringIndex::CFreeBiblStringIndex ( )

◆ ~CFreeBiblStringIndex()

CFreeBiblStringIndex::~CFreeBiblStringIndex ( )
virtual

Member Function Documentation

◆ GetStringFileName()

string CFreeBiblStringIndex::GetStringFileName ( string  Path) const
protected

References CFreeBiblIndex::m_Name, and MakeFName().

Referenced by CreatePartitions().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReadBiblStringItems()

void CFreeBiblStringIndex::ReadBiblStringItems ( string  FileName,
bool  useMMap = false 
)
protected

◆ WriteBiblStringItems()

bool CFreeBiblStringIndex::WriteBiblStringItems ( const vector< string > &  Set,
string  FileName 
) const
protected

References ddcLogError, Format(), and CFreeBiblIndex::size().

Referenced by CreatePartitions().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clear()

void CFreeBiblStringIndex::clear ( void  )
virtual

Reimplemented from CFreeBiblIndex.

Reimplemented in CFreeBiblStringConstant.

References CFreeBiblIndex::clear().

Referenced by CFreeBiblStringConstant::clear().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetTypeStr()

string CFreeBiblStringIndex::GetTypeStr ( ) const
virtual

Reimplemented from CFreeBiblIndex.

Reimplemented in CFreeBiblStringConstant.

References StringTypeStr.

◆ GetTypeId()

CFreeBiblIndexTypeId CFreeBiblStringIndex::GetTypeId ( ) const
virtual

return bibl-field subtype identifier

Reimplemented from CFreeBiblIndex.

Reimplemented in CFreeBiblStringConstant.

References cfbiString.

◆ GetStringValue()

string CFreeBiblStringIndex::GetStringValue ( DWORD  FileNo) const
virtual

Reimplemented from CFreeBiblIndex.

Reimplemented in CFreeBiblStringConstant.

References CFreeBiblIndex::m_ValuesForEachFile.

◆ CreateUnion()

void CFreeBiblStringIndex::CreateUnion ( const string &  Path,
const vector< const CFreeBiblIndex *> &  Indices,
const vector< size_t > &  FileCounts 
)
virtual

◆ CreatePartitions()

void CFreeBiblStringIndex::CreatePartitions ( vector< CFreeBiblIndex *> &  Parts,
const vector< string > &  Paths,
const vector< DWORD > &  EndFileNo 
) const
virtual

◆ RegisterBiblStringItemId()

void CFreeBiblStringIndex::RegisterBiblStringItemId ( const string &  Value)
virtual

◆ DeleteBiblFiles()

bool CFreeBiblStringIndex::DeleteBiblFiles ( string  Path) const
virtual

Reimplemented from CFreeBiblIndex.

References CFreeBiblIndex::DeleteBiblFiles().

Here is the call graph for this function:

◆ ReadFromDisk()

void CFreeBiblStringIndex::ReadFromDisk ( string  Path,
DWORD  FileBreaksSize,
bool  useMMap = false 
)
virtual

Reimplemented from CFreeBiblIndex.

Reimplemented in CFreeBiblStringConstant.

References CFreeBiblIndex::ReadFromDisk().

Here is the call graph for this function:

◆ ConvertAndSaveToDiskAfterIndexing()

bool CFreeBiblStringIndex::ConvertAndSaveToDiskAfterIndexing ( string  Path)
virtual

◆ GetFilterBounds()

bool CFreeBiblStringIndex::GetFilterBounds ( CDDCFilterWithBounds Filter,
const string &  LoValue,
const string &  HiValue 
) const
virtual

initialize CDDCFilterWithBounds for a literal target or regex value (default treats Value as integer string and sets range)

Parameters
Filterfilter to populate
LoValuelower bound value to seek (inclusive)
HiValueupper bound value to seek (exclusive)

Reimplemented from CFreeBiblIndex.

References CHitSortKey::assign(), CHitSortKey::i, CDDCFilterWithBounds::m_BiblIndex, CDDCFilterWithBounds::m_bSet, CDDCFilterWithBounds::m_KeyHi, and CDDCFilterWithBounds::m_KeyLo.

Here is the call graph for this function:

◆ GetFilterValue()

bool CFreeBiblStringIndex::GetFilterValue ( CDDCFilterWithBounds Filter,
const string &  Value 
) const
virtual

initialize CDDCFilterWithBounds for a literal target value (default treats Value as integer string and sets singleton range)

Parameters
Filterfilter to populate
Valuevalue to seek
  • formerly GetValueForDDCFilter() with isRegex==false (default)

Reimplemented from CFreeBiblIndex.

References CHitSortKey::assign(), CHitSortKey::i, CDDCFilterWithBounds::m_BiblIndex, CDDCFilterWithBounds::m_bNegated, CDDCFilterWithBounds::m_bSet, CDDCFilterWithBounds::m_KeyHi, CDDCFilterWithBounds::m_KeyLo, CDDCFilterWithBounds::m_SatisfiedValues, and CHitSortKey::s.

Here is the call graph for this function:

◆ GetFilterValues() [1/2]

bool CFreeBiblStringIndex::GetFilterValues ( CDDCFilterWithBounds Filter,
const string &  Regex 
) const
virtual

◆ GetFilterValues() [2/2]

bool CFreeBiblStringIndex::GetFilterValues ( CDDCFilterWithBounds Filter,
const set< string > &  Values 
) const
virtual

◆ size()

virtual size_t CFreeBiblStringIndex::size ( void  ) const
inlinevirtual

for server info

Reimplemented from CFreeBiblIndex.

References CFreeBiblIndex::GetIntegerLowerBound(), and ddcStringEnum< OffT_ >::size().

Here is the call graph for this function:

◆ GetIntegerLowerBound()

DWORD CFreeBiblStringIndex::GetIntegerLowerBound ( const string &  Value) const
virtual

for key-based pruning (v2.1.9): map a single value-string to its value-id

Reimplemented from CFreeBiblIndex.

Member Data Documentation

◆ m_BuildStringItemsMap

BuildStringItemsMapT CFreeBiblStringIndex::m_BuildStringItemsMap
protected

◆ m_BuildStringItemsSize

size_t CFreeBiblStringIndex::m_BuildStringItemsSize
protected

◆ m_ValuesE

ddcStringEnum CFreeBiblStringIndex::m_ValuesE
protected

a set of all possible string values for this index

Referenced by CreatePartitions().


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