CBiblExpander Class Reference

Abstract API for bibliographic metadata-expansion modules. More...

#include <BiblExpander.h>

Inheritance diagram for CBiblExpander:

Public Member Functions
Constructors etc.
	CBiblExpander (const string &label=string("NoLabel"), const string &target=string("NoTarget"), const string &param=string(""))
virtual	~CBiblExpander (void)
	Default destructor. More...
virtual void	compile (void)
	set up object based on label, target, and/or parameter strings; default implementation does nothing More...
API
virtual string	configString (void) const
	String form of this expander. Default is m_BxLabel + " " + m_BxTarget + " " + m_BxParam. More...
virtual void	expand (const string &src, set< string > &dst)
	Expand a single term term to a set of terms dst ; default just calls expand(const set<string>&, set<string>&) for temporary singleton source-set. More...
virtual void	expand (const set< string > &src, set< string > &dst)
	Expand a set of terms src to a set of terms dst ; must be overridden by subclass. More...

Public Attributes
string	m_BxLabel
	unique label for this expander More...
string	m_BxTarget
	physically indexed target bibliographic field name More...
string	m_BxParam
	string parameters (for stringification) More...

Detailed Description

Abstract API for bibliographic metadata-expansion modules.

Constructor & Destructor Documentation

CBiblExpander()

CBiblExpander::CBiblExpander ( const string &  label = string("NoLabel"), const string &  target = string("NoTarget"), const string &  param = string("")  )

inline

~CBiblExpander()

virtual CBiblExpander::~CBiblExpander ( void  )

inlinevirtual

Default destructor.

Member Function Documentation

compile()

virtual void CBiblExpander::compile ( void  )

inlinevirtual

set up object based on label, target, and/or parameter strings; default implementation does nothing

Reimplemented in BxTermWrapper.

References configString(), and expand().

Here is the call graph for this function:

configString()

string CBiblExpander::configString ( void  ) const

virtual

String form of this expander. Default is m_BxLabel + " " + m_BxTarget + " " + m_BxParam.

References m_BxLabel, m_BxParam, and m_BxTarget.

Referenced by compile().

Here is the caller graph for this function:

expand() [1/2]

void CBiblExpander::expand ( const string &  src, set< string > &  dst  )

virtual

Expand a single term term to a set of terms dst ; default just calls expand(const set<string>&, set<string>&) for temporary singleton source-set.

Referenced by compile().

Here is the caller graph for this function:

expand() [2/2]

void CBiblExpander::expand ( const set< string > &  src, set< string > &  dst  )

virtual

Expand a set of terms src to a set of terms dst ; must be overridden by subclass.

Reimplemented in BxTermWrapper.

References errOther, and m_BxLabel.

Member Data Documentation

m_BxLabel

string CBiblExpander::m_BxLabel

unique label for this expander

Referenced by CBiblIndex::BiblExpanderMapToJson(), configString(), expand(), and BxTermWrapper::expand().

m_BxTarget

string CBiblExpander::m_BxTarget

physically indexed target bibliographic field name

Referenced by CBiblIndex::BiblExpanderMapToJson(), and configString().

m_BxParam

string CBiblExpander::m_BxParam

string parameters (for stringification)

Referenced by CBiblIndex::BiblExpanderMapToJson(), and configString().

---

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

• BiblExpander.h
• BiblExpander.cpp