#include <BiblIndex.h>

Inheritance diagram for CBiblIndex:

Collaboration diagram for CBiblIndex:

[legend]

Classes
class	CTextArea

Public Member Functions
	CBiblIndex ()

void	FreeBiblIndices ()
	clears m_FreeBiblIndices More...

void	FreeBiblExpanders ()
	clears m_BiblExpanders More...

bool	RegisterFreeBiblAttributes (string fields, string &ErrorStr)
	initializes free bibliographical attribute descriptions More...

bool	RegisterTextAreas (string fields, string &ErrorStr)
	initializes free text areas descriptions More...

string	GetFreeBibiAttributesDescr () const
	return free bibliographical attribute description More...

string	GetTextAreasDescr () const
	return full text area description More...

void	SetPath (string ProjectFileName)

void	LoadBibl (string Path, size_t FileBreaksSize, bool useMMap=false)

CBibliography	GetFullBibliographyOfHit (size_t FileNo) const
	returns the bibliographical record More...

string	GetBiblIndexFileName () const

string	GetBiblFileName () const

string	GetBiblDateIndexFileName () const

int	GetTextAreaByName (const string &Name) const

CFreeBiblIndex *	GetFreeBiblIndex (const string &FreeBiblAttribNameOrAlias) const
	moo: not quite as ugly or dangerous a hack (respects aliases) More...

CBiblExpander *	GetBiblExpander (const string &ExpanderName) const
	moo: not quite as ugly or dangerous a hack More...

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

bool	GetFilterValue (CDDCFilterWithBounds &Filter, const string &Value) const

bool	GetFilterValues (CDDCFilterWithBounds &Filter, const string &Regex) const

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

void	GetTextAreaElements (const TiXmlDocument &doc, vector< TiXmlElement *> &Result) const
	return all text area elements for this document ("doc") More...

size_t	GetTextAreasCount () const
	return all text area names More...

int	WithinTextArea (const vector< string > &Within) const

void	InitNoSort (vector< CHit > &Hits) const

void	InitSortByDate (vector< CHit > &Hits) const

void	InitSortByBiblIntegerField (string FreeBiblAttribNameOrAlias, vector< CHit > &Hits) const

bool	IsRegisteredBiblField (const string &FreeBiblAttribNameOrAlias) const

CFreeBiblIndexTypeId	GetBiblFieldTypeId (const string &FreeBiblAttribName) const

string	FreeBiblMapToJson (bool useUtf) const
	print to json More...

string	FreeBiblAliasMapToJson () const

string	BiblExpanderMapToJson () const

const ddcDateVector &	GetDates () const
	moo: ugly dangerous hack More...

bool	HasFreeBiblIndex (const string &name) const
	not quite as ugly or dangerous a hack (respects aliases) More...

bool	HasBiblExpander (const string &ExpanderName) const
	moo: not quite as ugly or dangerous a hack More...

const CFreeBiblIndexInterface *	GetFreeBiblIndexConst (const string &name) const
	moo: not quite as ugly or dangerous a hack (respects aliases) More...

void	SetRegexOptions (const RML_RE::Options &opts)
	set regex options for all registered fields More...

string	GetVisibleFreeHeaderBiblAttributes (size_t FileNo, string Delim) const
	return values of all visible free bibliographical attributes for the given FileNo delimited by "Delim" More...

string	GetFreeHeaderBiblAttributesWithNames (size_t FileNo, char Delim) const
	return names and values of all free bibliographical attributes for the given FileNo delimited by "Delim" More...

string	GetFreeHeaderBiblAttributesJson (size_t FileNo, bool assume_utf8=true, bool include_invisible=false) const
	return names and values of all free bibliographical attributes for the given FileNo as JSON (without enclosing {}) More...

string	GetFreeHeaderBiblAttributesTabsDump (size_t FileNo, bool assume_utf8=true, bool include_invisible=false) const
	return names and values of all free bibliographical attributes for the given FileNo as tt-comments (for tt-mode dump) More...

bool	FileMatches (DWORD FileNo, const vector< CDDCFilterWithBounds > &Filters) const
	test whether all compiled Filters match FileNo More...

CBiblExpander *	AddBiblExpander (const string &spec)
	add a new bibliographic expander to m_BiblExpanders, or replace an existing one; returns new expander More...

Public Attributes
string	m_DefaultAttrName
	name of default bibliographic field to query if no literal match is found This can be used in conjunction with a constant bibliographic metadata attribute (CConcXml::CFreeBiblStringConstant) to provide a default value for unknown bibliographic metadata attributes, e.g. to facilitate interoperability between multiple corpora. If set to the empty string (the default), query filters on an undefined bibliographic attribute will raise an error. More...

Protected Types
typedef map< string, CFreeBiblIndex * >	FreeBiblStringMap

typedef map< string, string >	FreeBiblAliasMap

typedef map< string, CBiblExpander * >	BiblExpanderMap

Protected Attributes
FreeBiblStringMap	m_FreeBiblIndices

FreeBiblAliasMap	m_FreeBiblAlias

BiblExpanderMap	m_BiblExpanders

map< string, size_t >	m_FreeBiblNameToPosition

ddcVecFile< file_off_t >	m_EndOffsetsInBiblFile

ddcDateVector	m_Dates

string	m_Path

string	m_OrigXPath

string	m_ScanXPath

string	m_DateXPath

string	m_StartPageXPath

Private Member Functions
string	ReadFromFile (file_off_t start, size_t nbytes) const

Private Attributes
bool	m_bMemoryMap

ddcFileOrMMap	m_BiblBodyFile

RML_RE::Options	m_RegexOpts
	common regex options More...

vector< CTextArea >	m_TextAreas

Member Typedef Documentation

◆ FreeBiblStringMap

typedef map<string, CFreeBiblIndex *> CBiblIndex::FreeBiblStringMap

protected

◆ FreeBiblAliasMap

typedef map<string, string> CBiblIndex::FreeBiblAliasMap

protected

◆ BiblExpanderMap

typedef map<string, CBiblExpander *> CBiblIndex::BiblExpanderMap

protected

Constructor & Destructor Documentation

◆ CBiblIndex()

CBiblIndex::CBiblIndex ( )

References m_bMemoryMap.

Member Function Documentation

◆ ReadFromFile()

string CBiblIndex::ReadFromFile	(	file_off_t	start,
		size_t	nbytes
	)		const

private

◆ FreeBiblIndices()

void CBiblIndex::FreeBiblIndices ( )

clears m_FreeBiblIndices

References m_FreeBiblIndices.

Referenced by RegisterFreeBiblAttributes(), and CConcXml::~CConcXml().

Here is the caller graph for this function:

◆ FreeBiblExpanders()

void CBiblIndex::FreeBiblExpanders ( )

clears m_BiblExpanders

References m_BiblExpanders.

Referenced by CConcXml::~CConcXml().

Here is the caller graph for this function:

◆ RegisterFreeBiblAttributes()

bool CBiblIndex::RegisterFreeBiblAttributes	(	string	fields,
		string &	ErrorStr
	)

initializes free bibliographical attribute descriptions

References CheckXPath(), ddcLogWarn, ErrorMessage(), Format(), FreeBiblAttribOptionFieldName, FreeBiblIndices(), IntegerTypeStr, CFreeBiblIndex::m_bShowInHeader, m_DateXPath, m_FreeBiblAlias, m_FreeBiblIndices, m_FreeBiblNameToPosition, CFreeBiblIndex::m_Name, m_OrigXPath, CFreeBiblIndex::m_pRegexOpts, m_RegexOpts, m_ScanXPath, m_StartPageXPath, CFreeBiblIndex::m_Xpath, Name, StringAliasTypeStr, StringConstantTypeStr, StringTypeStr, Trim(), unescapeCString(), and StringTokenizer::val().

Referenced by CConcordance::LoadOptionsFromString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterTextAreas()

bool CBiblIndex::RegisterTextAreas	(	string	fields,
		string &	ErrorStr
	)

initializes free text areas descriptions

References CheckXPath(), CBiblIndex::CTextArea::m_TextAreaName, m_TextAreas, CBiblIndex::CTextArea::m_Xpath, morphEnglish, RmlMakeLower(), TextAreaOptionFieldName, Trim(), and StringTokenizer::val().

Referenced by CConcordance::LoadOptionsFromString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFreeBibiAttributesDescr()

string CBiblIndex::GetFreeBibiAttributesDescr ( ) const

return free bibliographical attribute description

References Format(), FreeBiblAttribOptionFieldName, m_DateXPath, m_FreeBiblAlias, m_FreeBiblIndices, m_OrigXPath, m_ScanXPath, and m_StartPageXPath.

Referenced by CConcordance::LoadOptionsFromString(), and CConcordance::SaveOptionsToString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTextAreasDescr()

string CBiblIndex::GetTextAreasDescr ( ) const

return full text area description

References Format(), m_TextAreas, and TextAreaOptionFieldName.

Referenced by CConcordance::LoadOptionsFromString(), and CConcordance::SaveOptionsToString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPath()

void CBiblIndex::SetPath ( string ProjectFileName )

References m_Path, and m_RegexOpts.

Referenced by CConcIndexator::CreateAsUnion(), LoadBibl(), and CConcXml::Start().

Here is the caller graph for this function:

◆ LoadBibl()

void CBiblIndex::LoadBibl	(	string	Path,
		size_t	FileBreaksSize,
		bool	useMMap = `false`
	)

References Format(), GetBiblDateIndexFileName(), GetBiblFileName(), GetBiblIndexFileName(), m_BiblBodyFile, m_bMemoryMap, m_Dates, m_EndOffsetsInBiblFile, m_FreeBiblIndices, m_Path, ddcVecFile< T >::open(), ddcFileOrMMap::Open(), SetPath(), and ddcVecFile< T >::size().

Here is the call graph for this function:

◆ GetFullBibliographyOfHit()

CBibliography CBiblIndex::GetFullBibliographyOfHit ( size_t FileNo ) const

returns the bibliographical record

References ArrayPtrHolder< T >::Get(), m_BiblBodyFile, m_EndOffsetsInBiblFile, ddcFileOrMMap::ReadBuffer(), CBibliography::ReadFromString(), and ddcVecFile< T >::size().

Here is the call graph for this function:

◆ GetBiblIndexFileName()

string CBiblIndex::GetBiblIndexFileName ( ) const

References m_Path, and MakeFName().

Referenced by CConcXml::DeleteFiles(), CConcXml::FinalSaveBibliography(), LoadBibl(), CConcXml::SplitBibliography(), and CConcXml::UnionBibliographies().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBiblFileName()

string CBiblIndex::GetBiblFileName ( ) const

References m_Path, and MakeFName().

Referenced by CConcXml::DeleteFiles(), LoadBibl(), CConcXml::SplitBibliography(), CConcXml::Start(), and CConcXml::UnionBibliographies().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBiblDateIndexFileName()

string CBiblIndex::GetBiblDateIndexFileName ( ) const

References m_Path, and MakeFName().

Referenced by CConcXml::DeleteFiles(), CConcXml::FinalSaveBibliography(), LoadBibl(), CConcXml::SplitBibliography(), and CConcXml::UnionBibliographies().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTextAreaByName()

int CBiblIndex::GetTextAreaByName ( const string & Name ) const

References m_TextAreas, and UnknownTextAreaNo.

Referenced by WithinTextArea().

Here is the caller graph for this function:

◆ GetFreeBiblIndex()

CFreeBiblIndex * CBiblIndex::GetFreeBiblIndex ( const string & FreeBiblAttribNameOrAlias ) const

moo: not quite as ugly or dangerous a hack (respects aliases)

References errRuntime, m_FreeBiblAlias, m_FreeBiblIndices, and MAX_ALIAS_REDIR.

Referenced by CQFSort::GetBiblConstant(), GetBiblFieldTypeId(), GetFilterBounds(), GetFilterValue(), GetFilterValues(), GetFreeBiblIndexConst(), HasFreeBiblIndex(), InitSortByBiblIntegerField(), IsRegisteredBiblField(), and CConcXml::SplitBibliography().

Here is the caller graph for this function:

◆ GetBiblExpander()

CBiblExpander * CBiblIndex::GetBiblExpander ( const string & ExpanderName ) const

moo: not quite as ugly or dangerous a hack

References m_BiblExpanders.

Referenced by HasBiblExpander().

Here is the caller graph for this function:

◆ GetFilterBounds()

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

initialize a CDDCFilterWithBounds object for sorting by bibliographical information, given bound(s)

Parameters

Filter	filter to initialize
LoValue	lower bound or emtpy for none (inclusive)
HiValue	upper bound or emtpy for none (exclusive) calls CConcXml::CFreeBiblIndex::GetFilterBounds()

References CDDCFilterWithBounds::clear(), CFreeBiblIndex::GetFilterBounds(), GetFreeBiblIndex(), and CDDCFilterWithBounds::m_AttrName.

Referenced by CQFBiblSort::Compile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFilterValue()

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

initialize a CDDCFilterWithBounds object for filtering by bibliographical information, for a literal target value.

Parameters

Filter	filter to initialize
Value	literal value used to set Filter.m_LevelStart calls CConcXml::CFreeBiblIndex::GetFilterValue() formerly GetValueFromBiblSet() with isRegex==false (default)

References CDDCFilterWithBounds::clear(), CFreeBiblIndex::GetFilterValue(), GetFilterValues(), GetFreeBiblIndex(), CDDCFilterWithBounds::m_AttrName, and m_BiblExpanders.

Referenced by CQFHasFieldValue::Compile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFilterValues() [1/2]

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

initialize a CDDCFilterWithBounds object for filtering by bibliographical information, for a target regex. calls CConcXml::CFreeBiblIndex::GetFilterValues()

formerly GetValueFromBiblSet() with isRegex==true

References CDDCFilterWithBounds::clear(), CFreeBiblIndex::GetFilterValues(), GetFreeBiblIndex(), and CDDCFilterWithBounds::m_AttrName.

Referenced by CQFHasFieldRegex::Compile(), CQFHasFieldSet::Compile(), GetFilterValue(), and GetFilterValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFilterValues() [2/2]

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

initialize a CDDCFilterWithBounds object for filtering by bibliographical information, for a set of target values.

calls CConcXml::CFreeBiblIndex::GetFilterValues()

References CDDCFilterWithBounds::clear(), CFreeBiblIndex::GetFilterValues(), GetFilterValues(), GetFreeBiblIndex(), CDDCFilterWithBounds::m_AttrName, and m_BiblExpanders.

Here is the call graph for this function:

◆ GetTextAreaElements()

void CBiblIndex::GetTextAreaElements	(	const TiXmlDocument &	doc,
		vector< TiXmlElement *> &	Result
	)		const

return all text area elements for this document ("doc")

References Format(), m_TextAreas, TiXmlDocument::RootElement(), TiXmlNode::ToElement(), and TinyXPath::XNp_xpath_node().

Referenced by CConcIndexator::IndexFreeIndex(), CConcIndexator::LoadXmlFile(), and CConcXml::ReadMorphXmlFileIntoGraTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTextAreasCount()

size_t CBiblIndex::GetTextAreasCount ( ) const

return all text area names

References m_TextAreas.

Referenced by CQueryNode::ConvertOccurrencesToHits(), CQueryNode::ConvertOccurrencesToHitsForPatterns(), CConcIndexator::IndexTextOrHtmlFile(), and CConcIndexator::LoadXmlFile().

Here is the caller graph for this function:

◆ WithinTextArea()

int CBiblIndex::WithinTextArea ( const vector< string > & Within ) const

return text area index, which is specified in the input query (if nothing is specified, it returns UnknownTextAreaNo)

Deprecated:: use WithinTextArea

returns index of the last valid text area named in Within.

if no valid text area is found, returns UnknownTextAreaNo

References GetTextAreaByName(), and UnknownTextAreaNo.

Referenced by CQueryOptions::Compile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitNoSort()

void CBiblIndex::InitNoSort ( vector< CHit > & Hits ) const

References CHit::m_SortKey.

Referenced by InitSortByBiblIntegerField().

Here is the caller graph for this function:

◆ InitSortByDate()

void CBiblIndex::InitSortByDate ( vector< CHit > & Hits ) const

References ddcVecFile< T >::empty(), m_Dates, CHit::m_FileNo, and CHit::m_SortKey.

Here is the call graph for this function:

◆ InitSortByBiblIntegerField()

void CBiblIndex::InitSortByBiblIntegerField	(	string	FreeBiblAttribNameOrAlias,
		vector< CHit > &	Hits
	)		const

References CHitSortKey::assign(), GetFreeBiblIndex(), CFreeBiblIndex::GetIntegerValue(), CFreeBiblIndex::GetStringValue(), InitNoSort(), CHit::m_FileNo, and CHit::m_SortKey.

Here is the call graph for this function:

◆ IsRegisteredBiblField()

bool CBiblIndex::IsRegisteredBiblField ( const string & FreeBiblAttribNameOrAlias ) const

References GetFreeBiblIndex().

Referenced by CConcordance::LoadOptionsFromString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBiblFieldTypeId()

CFreeBiblIndexTypeId CBiblIndex::GetBiblFieldTypeId ( const string & FreeBiblAttribName ) const

get the registered type of a registered bibliographic field as a CFreeBiblIndexTypeId

Returns: m_FreeBiblIndices.find(FreeBiblAttribName).GetTypeId() or cfbiUnknown if not found

References cfbiUnknown, GetFreeBiblIndex(), and CFreeBiblIndex::GetTypeId().

Here is the call graph for this function:

◆ FreeBiblMapToJson()

string CBiblIndex::FreeBiblMapToJson ( bool useUtf ) const

print to json

References cfbiStringConstant, Format(), CFreeBiblIndex::GetTypeId(), CFreeBiblIndex::GetXpathStr(), jsonStr(), CFreeBiblIndex::m_bShowInHeader, m_FreeBiblIndices, CFreeBiblIndex::m_Name, CFreeBiblIndex::m_Xpath, and CFreeBiblIndex::size().

Referenced by CDDCLeafServer::handle__info().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FreeBiblAliasMapToJson()

string CBiblIndex::FreeBiblAliasMapToJson ( ) const

References jsonStr(), and m_FreeBiblAlias.

Referenced by CDDCLeafServer::handle__info().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BiblExpanderMapToJson()

string CBiblIndex::BiblExpanderMapToJson ( ) const

References jsonStr(), m_BiblExpanders, CBiblExpander::m_BxLabel, CBiblExpander::m_BxParam, and CBiblExpander::m_BxTarget.

Referenced by CDDCLeafServer::handle__info().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDates()

const ddcDateVector& CBiblIndex::GetDates ( ) const

inline

moo: ugly dangerous hack

References m_Dates.

◆ HasFreeBiblIndex()

bool CBiblIndex::HasFreeBiblIndex ( const string & name ) const

inline

not quite as ugly or dangerous a hack (respects aliases)

References GetFreeBiblIndex().

Referenced by CQFSort::ResolveAttributeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasBiblExpander()

bool CBiblIndex::HasBiblExpander ( const string & ExpanderName ) const

inline

moo: not quite as ugly or dangerous a hack

References GetBiblExpander().

Referenced by CQFSort::ResolveAttributeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFreeBiblIndexConst()

const CFreeBiblIndexInterface* CBiblIndex::GetFreeBiblIndexConst ( const string & name ) const

inline

moo: not quite as ugly or dangerous a hack (respects aliases)

References AddBiblExpander(), FileMatches(), GetFreeBiblIndex(), GetFreeHeaderBiblAttributesJson(), GetFreeHeaderBiblAttributesTabsDump(), GetFreeHeaderBiblAttributesWithNames(), GetVisibleFreeHeaderBiblAttributes(), and SetRegexOptions().

Here is the call graph for this function:

◆ SetRegexOptions()

void CBiblIndex::SetRegexOptions ( const RML_RE::Options & opts )

set regex options for all registered fields

References m_FreeBiblIndices, and m_RegexOpts.

Referenced by GetFreeBiblIndexConst(), and CConcordance::LoadOptionsFromString().

Here is the caller graph for this function:

◆ GetVisibleFreeHeaderBiblAttributes()

string CBiblIndex::GetVisibleFreeHeaderBiblAttributes	(	size_t	FileNo,
		string	Delim
	)		const

return values of all visible free bibliographical attributes for the given FileNo delimited by "Delim"

References CFreeBiblIndex::GetStringValue(), CFreeBiblIndex::m_bShowInHeader, and m_FreeBiblIndices.

Referenced by GetFreeBiblIndexConst().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFreeHeaderBiblAttributesWithNames()

string CBiblIndex::GetFreeHeaderBiblAttributesWithNames	(	size_t	FileNo,
		char	Delim
	)		const

return names and values of all free bibliographical attributes for the given FileNo delimited by "Delim"

References CFreeBiblIndex::GetStringValue(), CFreeBiblIndex::m_bShowInHeader, m_FreeBiblIndices, and CFreeBiblIndex::m_Name.

Referenced by GetFreeBiblIndexConst().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFreeHeaderBiblAttributesJson()

string CBiblIndex::GetFreeHeaderBiblAttributesJson	(	size_t	FileNo,
		bool	assume_utf8 = `true`,
		bool	include_invisible = `false`
	)		const

return names and values of all free bibliographical attributes for the given FileNo as JSON (without enclosing {})

References CFreeBiblIndex::GetStringValue(), jsonStr(), CFreeBiblIndex::m_bShowInHeader, m_FreeBiblIndices, and CFreeBiblIndex::m_Name.

Referenced by GetFreeBiblIndexConst().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFreeHeaderBiblAttributesTabsDump()

string CBiblIndex::GetFreeHeaderBiblAttributesTabsDump	(	size_t	FileNo,
		bool	assume_utf8 = `true`,
		bool	include_invisible = `false`
	)		const

return names and values of all free bibliographical attributes for the given FileNo as tt-comments (for tt-mode dump)

References CFreeBiblIndex::GetStringValue(), jsonStr(), CFreeBiblIndex::m_bShowInHeader, m_FreeBiblIndices, and CFreeBiblIndex::m_Name.

Referenced by GetFreeBiblIndexConst().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FileMatches()

bool CBiblIndex::FileMatches	(	DWORD	FileNo,
		const vector< CDDCFilterWithBounds > &	Filters
	)		const

test whether all compiled Filters match FileNo

References CFreeBiblIndex::FileMatches(), GreaterByDate, LessByDate, and m_Dates.

Referenced by CQCount::CountUniversal(), and GetFreeBiblIndexConst().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddBiblExpander()

CBiblExpander * CBiblIndex::AddBiblExpander ( const string & spec )

add a new bibliographic expander to m_BiblExpanders, or replace an existing one; returns new expander

References EngMakeLower(), errLogic, errRuntime, m_BiblExpanders, CTermExpander::m_Class, and Trim().

Referenced by GetFreeBiblIndexConst(), and CConcordance::LoadOptionsFromString().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_bMemoryMap

bool CBiblIndex::m_bMemoryMap

private

whether to mmap resident data (default=false)

Referenced by CBiblIndex(), and LoadBibl().

◆ m_BiblBodyFile

ddcFileOrMMap CBiblIndex::m_BiblBodyFile

private

Referenced by GetFullBibliographyOfHit(), and LoadBibl().

◆ m_RegexOpts

RML_RE::Options CBiblIndex::m_RegexOpts

private

common regex options

Referenced by RegisterFreeBiblAttributes(), SetPath(), and SetRegexOptions().

◆ m_TextAreas

vector<CTextArea> CBiblIndex::m_TextAreas

private

Referenced by GetTextAreaByName(), GetTextAreaElements(), GetTextAreasCount(), GetTextAreasDescr(), and RegisterTextAreas().

◆ m_FreeBiblIndices

◆ m_FreeBiblAlias

FreeBiblAliasMap CBiblIndex::m_FreeBiblAlias

protected

Referenced by FreeBiblAliasMapToJson(), GetFreeBibiAttributesDescr(), GetFreeBiblIndex(), and RegisterFreeBiblAttributes().

◆ m_BiblExpanders

BiblExpanderMap CBiblIndex::m_BiblExpanders

protected

Referenced by AddBiblExpander(), BiblExpanderMapToJson(), FreeBiblExpanders(), GetBiblExpander(), GetFilterValue(), and GetFilterValues().

◆ m_FreeBiblNameToPosition

map<string, size_t> CBiblIndex::m_FreeBiblNameToPosition

protected

Referenced by RegisterFreeBiblAttributes(), and CConcXml::SetFreeBiblByName().

◆ m_EndOffsetsInBiblFile

ddcVecFile<file_off_t> CBiblIndex::m_EndOffsetsInBiblFile

protected

Referenced by CConcXml::AddIndexItem(), CConcXml::FinalSaveBibliography(), GetFullBibliographyOfHit(), LoadBibl(), CConcXml::SplitBibliography(), CConcXml::Start(), and CConcXml::UnionBibliographies().

◆ m_Dates

ddcDateVector CBiblIndex::m_Dates

protected

Referenced by CConcXml::AddIndexItem(), FileMatches(), CConcXml::FinalSaveBibliography(), GetDates(), InitSortByDate(), LoadBibl(), CConcXml::SplitBibliography(), CConcXml::Start(), and CConcXml::UnionBibliographies().

◆ m_Path

string CBiblIndex::m_Path

protected

Referenced by CConcXml::DeleteFiles(), CConcXml::FinalSaveBibliography(), GetBiblDateIndexFileName(), GetBiblFileName(), GetBiblIndexFileName(), LoadBibl(), SetPath(), and CConcXml::UnionBibliographies().

◆ m_OrigXPath

string CBiblIndex::m_OrigXPath

protected

Referenced by GetFreeBibiAttributesDescr(), CConcXml::LoadXmlAndReadBibliography(), and RegisterFreeBiblAttributes().

◆ m_ScanXPath

string CBiblIndex::m_ScanXPath

protected

Referenced by GetFreeBibiAttributesDescr(), CConcXml::LoadXmlAndReadBibliography(), and RegisterFreeBiblAttributes().

◆ m_DateXPath

string CBiblIndex::m_DateXPath

protected

Referenced by GetFreeBibiAttributesDescr(), CConcXml::LoadXmlAndReadBibliography(), and RegisterFreeBiblAttributes().

◆ m_StartPageXPath

string CBiblIndex::m_StartPageXPath

protected

Referenced by GetFreeBibiAttributesDescr(), CConcXml::LoadXmlAndReadBibliography(), and RegisterFreeBiblAttributes().

◆ m_DefaultAttrName

string CBiblIndex::m_DefaultAttrName

name of default bibliographic field to query if no literal match is found This can be used in conjunction with a constant bibliographic metadata attribute (CConcXml::CFreeBiblStringConstant) to provide a default value for unknown bibliographic metadata attributes, e.g. to facilitate interoperability between multiple corpora. If set to the empty string (the default), query filters on an undefined bibliographic attribute will raise an error.

Warning: Think carefully before using this feature, since it will suppress error and/or warning messages due to typographical errors for "real" attribute fields.

Referenced by CConcordance::InitDefaultOptions(), CConcordance::LoadOptionsFromString(), CQFSort::ResolveAttributeName(), and CConcordance::SaveOptionsToString().

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

Classes

Public Member Functions

Public Attributes

Protected Types

Protected Attributes

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ FreeBiblStringMap

◆ FreeBiblAliasMap

◆ BiblExpanderMap

Constructor & Destructor Documentation

◆ CBiblIndex()

Member Function Documentation

◆ ReadFromFile()

◆ FreeBiblIndices()

◆ FreeBiblExpanders()

◆ RegisterFreeBiblAttributes()

◆ RegisterTextAreas()

◆ GetFreeBibiAttributesDescr()

◆ GetTextAreasDescr()

◆ SetPath()

◆ LoadBibl()

◆ GetFullBibliographyOfHit()

◆ GetBiblIndexFileName()

◆ GetBiblFileName()

◆ GetBiblDateIndexFileName()

◆ GetTextAreaByName()

◆ GetFreeBiblIndex()

◆ GetBiblExpander()

◆ GetFilterBounds()

◆ GetFilterValue()

◆ GetFilterValues() [1/2]

◆ GetFilterValues() [2/2]

◆ GetTextAreaElements()

◆ GetTextAreasCount()

◆ WithinTextArea()

◆ InitNoSort()

◆ InitSortByDate()

◆ InitSortByBiblIntegerField()

◆ IsRegisteredBiblField()

◆ GetBiblFieldTypeId()

◆ FreeBiblMapToJson()

◆ FreeBiblAliasMapToJson()

◆ BiblExpanderMapToJson()

◆ GetDates()

◆ HasFreeBiblIndex()

◆ HasBiblExpander()

◆ GetFreeBiblIndexConst()

◆ SetRegexOptions()

◆ GetVisibleFreeHeaderBiblAttributes()

◆ GetFreeHeaderBiblAttributesWithNames()

◆ GetFreeHeaderBiblAttributesJson()

◆ GetFreeHeaderBiblAttributesTabsDump()

◆ FileMatches()

◆ AddBiblExpander()

Member Data Documentation

◆ m_bMemoryMap

◆ m_BiblBodyFile

◆ m_RegexOpts

◆ m_TextAreas

◆ m_FreeBiblIndices

◆ m_FreeBiblAlias

◆ m_BiblExpanders

◆ m_FreeBiblNameToPosition

◆ m_EndOffsetsInBiblFile

◆ m_Dates

◆ m_Path

◆ m_OrigXPath

◆ m_ScanXPath

◆ m_DateXPath

◆ m_StartPageXPath

◆ m_DefaultAttrName