#include <ConcCommon.h>

Collaboration diagram for CDDCFilterWithBounds:

[legend]

Public Member Functions
void	clear ()

HitSortOrderEnum	SortOrder () const
	returns integer sort order as a HitSortOrderEnum (-1:descending, 0:none, 1:ascending, 2:count_keys, 3:count_values) More...

bool	IsFileFilter () const
	returns true iff this is a file-based filter (for optimized count(*) queries) More...

bool	IsTrivialFilter (void) const
	returns true iff this is a trivial-sort filter (i.e. does not change original hit-sort order) More...

bool	IsPruneFilter (void) const
	returns true iff this is a pruning filter More...

	CDDCFilterWithBounds ()

Public Attributes
HitSortEnum	m_FilterType
	the type of the filter More...

string	m_AttrName

bool	m_bSet

bool	m_bNegated
	true iff this is a negated filter More...

int	m_ContextMatchId
	match-id of reference token for context-sort operators (default=0:any) More...

int	m_ContextOffset
	offset from matched token for context-sort operators More...

CHitSortKey	m_KeyLo
	the lower bound of the filter (by default (INT_MIN,"")), valid only if m_bSet==false; formerly int m_LevelStart More...

CHitSortKey	m_KeyHi
	the upper bound of the filter (by default (INT_MAX,"")), valid only if m_bSet==false; formerly int m_LevelEnd More...

set< int >	m_SatisfiedValues
	the possible (integer) values for this bibliographical field, valid only if m_bSet==true More...

const CFreeBiblIndexInterface *	m_BiblIndex
	pointer to the CConcXml::CFreeBiblIndex responsible for populating this filter (only after compile) More...

class CQFilter *	m_Parent
	pointer to parent CQFilter (if any) More...

Detailed Description

This structure describes a filter which can be applied to the result hit set. For example, for filter operator "#less_by_size[5,10]" the slots would have the following values:

m_FilterType = LessBySize
m_LevelStart = 5
m_LevelEnd = 10+1

Constructor & Destructor Documentation

◆ CDDCFilterWithBounds()

CDDCFilterWithBounds::CDDCFilterWithBounds ( )

inline

Member Function Documentation

◆ clear()

void CDDCFilterWithBounds::clear ( void )

inline

Referenced by CStringIndexSet::GetContextBounds(), CBiblIndex::GetFilterBounds(), CBiblIndex::GetFilterValue(), and CBiblIndex::GetFilterValues().

Here is the caller graph for this function:

◆ SortOrder()

HitSortOrderEnum CDDCFilterWithBounds::SortOrder ( ) const

inline

returns integer sort order as a HitSortOrderEnum (-1:descending, 0:none, 1:ascending, 2:count_keys, 3:count_values)

References GreaterByCountKey, GreaterByCountValue, GreaterByDate, GreaterByFreeBiblField, GreaterByLeftContext, GreaterByMiddleContext, GreaterByPruneKey, GreaterByRank, GreaterByRightContext, GreaterBySize, hsoAscending, hsoDescending, hsoNone, and NoSort.

Referenced by CConcSession::GetAllHits(), CConcSession::InitSortKeyForHits(), and CQFPrune::PruneHitsIndex().

Here is the caller graph for this function:

◆ IsFileFilter()

bool CDDCFilterWithBounds::IsFileFilter ( ) const

inline

returns true iff this is a file-based filter (for optimized count(*) queries)

References GreaterByDate, GreaterByFreeBiblField, GreaterByLeftContext, GreaterByMiddleContext, GreaterByPruneKey, GreaterByRank, GreaterByRightContext, GreaterBySize, LessByDate, LessByFreeBiblField, LessByLeftContext, LessByMiddleContext, LessByPruneKey, LessByRank, LessByRightContext, LessBySize, NoSort, and RandomSort.

◆ IsTrivialFilter()

bool CDDCFilterWithBounds::IsTrivialFilter ( void ) const

inline

returns true iff this is a trivial-sort filter (i.e. does not change original hit-sort order)

References NoSort.

◆ IsPruneFilter()

bool CDDCFilterWithBounds::IsPruneFilter ( void ) const

inline

returns true iff this is a pruning filter

References IsPruneFilterType().

Referenced by CConcSession::GetAllHits().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_FilterType

HitSortEnum CDDCFilterWithBounds::m_FilterType

the type of the filter

Referenced by CQFPrune::Clone(), CQFSort::CQFSort(), CQFSort::FilterType(), CConcSession::GetAllHits(), CConcSession::HasRankOrderOperator(), CConcSession::InitSortByContext(), CConcSession::InitSortKeyForHits(), CQFSort::jsonType(), CConcSession::SortKeyLB(), CQFSort::toString(), CQFBiblSort::toString(), CQFContextSort::toString(), and CQFPrune::toString().

◆ m_AttrName

string CDDCFilterWithBounds::m_AttrName

the name of the free bibliographical field for bibliographic filters (#asc[FIELD], #desc[FIELD], #has[FIELD]), or the name of a token field for context-sort filters (#left, #right, etc)

Note: formerly m_AttrName

Referenced by CQFBiblSort::Compile(), CQFContextSort::Compile(), CQFHasField::Compile(), CQFSort::CQFSort(), CConcSession::GetAllHits(), CBiblIndex::GetFilterBounds(), CBiblIndex::GetFilterValue(), CBiblIndex::GetFilterValues(), CConcSession::InitSortByContext(), CConcSession::InitSortKeyForHits(), and CConcSession::SortKeyLB().

◆ m_bSet

bool CDDCFilterWithBounds::m_bSet

true if DDC should use CDDCFilterWithBounds::m_SatisfiedValues
false if DDC should use range defined by CDDCFilterWithBounds::m_LevelStart and CDDCFilterWithBounds::m_LevelEnd slots (formerly m_bRegExp)

Referenced by CQFPrune::CQFPrune(), CQFSort::CQFSort(), CFreeBiblIndex::FileMatches(), CConcSession::GetAllHits(), CStringIndexSet::GetContextBounds(), CFreeBiblIndex::GetFilterBounds(), CFreeBiblStringIndex::GetFilterBounds(), CFreeBiblIndex::GetFilterValue(), CFreeBiblStringIndex::GetFilterValue(), and CFreeBiblStringIndex::GetFilterValues().