CConcIndexatorInvoker is a class for invoking an index process. More...

#include <ConcIndexatorInvoker.h>

Inheritance diagram for ConcIndexatorInvoker:

Collaboration diagram for ConcIndexatorInvoker:

Public Member Functions
	ConcIndexatorInvoker ()

void	SetCurrMessage (string Message) const
	outputs a message to stdout or to GUI More...

bool	BuildIndex (string ProjectFile)
	builds index files for project ProjectFile More...

Public Attributes
bool	m_bStoppedByUser
	if true, CConcIndexatorInvoker tries to stop indexing More...

bool	m_bOnlyReindexMorphology
	if true, then BuildIndex should only rebuild MorphPattern index More...

bool	m_bSkipInitialFileChecking
	if true, then there is no initial checking whether the source files exist More...

string	m_CurrMessage
	the last message from indexing process More...

bool	m_bStdout
	should DDC send all messages to stdout More...

int	m_CurrentSourceFileNo
	the index of the currently processing source file More...

int	m_SourceFilesNumber
	the number of files to index More...

string	m_CurrentSourceFileName
	the name of file More...

CMyTimeSpanHolder	m_Profiler
	a slot to gather profiling information for loading stage More...

Private Member Functions
string	GetTimeStatisticsFileName (string Path) const

string	GetErrorLogFileName (string Path) const

void	WriteTimeStatistics (const CConcIndexator &Indexator, DWORD MaxTokenCountInOnePeriod) const

void	FinalizeIndex (CConcIndexator &Indexator, DWORD MaxTokenCountInOnePeriod) const

void	BuildOnlyMorphIndex (string ProjectFile) const

void	BuildIndexStart (string ProjectFile, CConcIndexator &indexator)

void	PrintProgress (DWORD saveCorpusEndTokenNo)

void	IndexFiles (CConcIndexator &Indexator)

void	SaveLoadIndexToDisk (CConcIndexator &Indexator)

DWORD	IndexFile (CConcIndexator &Indexator, CIndexDocument *document)

void	AddInputLoadIndexToMemoryLoadIndexWrapper (CConcIndexator &Indexator)

void	ProcessTarOrSingleFile (CConcIndexator &Indexator, size_t &InputLoadIndexSize, size_t &MemoryLoadIndexSize)

Private Attributes
time_t	m_StartTime

DWORD	m_CorpusEndTokenNo

vector< string >	m_ErrorCorpusFiles

Detailed Description

CConcIndexatorInvoker is a class for invoking an index process.

This class was established to start, to stop and to monitor an indexing process. To start it a user should call function CConcIndexatorInvoker::BuildIndex. To stop the process a user should set CConcIndexatorInvoker::m_bStoppedByUser to true.

Constructor & Destructor Documentation

◆ ConcIndexatorInvoker()

ConcIndexatorInvoker::ConcIndexatorInvoker ( )

References m_bOnlyReindexMorphology, m_bSkipInitialFileChecking, m_bStdout, m_bStoppedByUser, CMyTimeSpanHolder::m_bTimeSpanHolderEnabled, m_CurrentSourceFileNo, m_Profiler, and m_SourceFilesNumber.

Member Function Documentation

◆ GetTimeStatisticsFileName()

string ConcIndexatorInvoker::GetTimeStatisticsFileName ( string Path ) const

private

References MakeFName().

Referenced by WriteTimeStatistics().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetErrorLogFileName()

string ConcIndexatorInvoker::GetErrorLogFileName ( string Path ) const

private

References MakeFName().

Referenced by FinalizeIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteTimeStatistics()

void ConcIndexatorInvoker::WriteTimeStatistics	(	const CConcIndexator &	Indexator,
		DWORD	MaxTokenCountInOnePeriod
	)		const

private

References CMyTimeSpanHolder::EndTimer(), CStringIndexator::GetSearchPeriodsCount(), CMyTimeSpanHolder::GetStrRepresentation(), GetTimeStatisticsFileName(), m_CorpusEndTokenNo, CStringIndexator::m_Path, m_Profiler, and SetCurrMessage().

Referenced by BuildIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FinalizeIndex()

void ConcIndexatorInvoker::FinalizeIndex	(	CConcIndexator &	Indexator,
		DWORD	MaxTokenCountInOnePeriod
	)		const

private

References CStringIndexator::AddInputLoadIndexToMemoryLoadIndex(), CStringIndexator::AddMemoryLoadIndexToMainLoadIndex(), CHitBorders::BordersEndIndexing(), CConcIndexator::CalculateSearchPeriods(), CConcIndexator::CreateMorphIndexWrapper(), CMyTimeSpanHolder::EndTimer(), CStringIndexator::FinalSaveAllIndices(), Format(), CHitBorders::GetCorpusEndTokenNo(), GetErrorLogFileName(), CConcordance::GetFileNameForCorpusFileNames(), CIndexItem::GetMaximalNumberOfRunningTokens(), CHitBorders::LoadHitBorders(), CConcordance::m_bIndexMorphPatterns, CConcordance::m_bResumeOnIndexErrors, m_CorpusEndTokenNo, m_ErrorCorpusFiles, CStringIndexator::m_Path, m_Profiler, CConcIndexator::NormalEndIndexing(), CConcIndexator::SaveCorpusFileList(), CStringIndexator::SaveMemoryLoadIndex(), SetCurrMessage(), and CMyTimeSpanHolder::StartTimer().

Referenced by IndexFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildOnlyMorphIndex()

void ConcIndexatorInvoker::BuildOnlyMorphIndex ( string ProjectFile ) const

private

References CConcIndexator::CreateMorphIndexWrapper(), CConcordance::LoadProject(), and SetCurrMessage().

Referenced by BuildIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildIndexStart()

void ConcIndexatorInvoker::BuildIndexStart	(	string	ProjectFile,
		CConcIndexator &	indexator
	)

private

References CMyTimeSpanHolder::ClearTimers(), CConcIndexator::DestroyIndex(), Format(), CSourceFileHolder::FoundNotExistedFile(), CConcIndexator::GetMaxInputLoadIndexSize(), CConcIndexator::GetMaxTokenCountInOnePeriod(), CSourceFileHolder::GetSourceFile(), CSourceFileHolder::GetSourceFilesCount(), CConcordance::LoadSourceFilesAndOptions(), m_bSkipInitialFileChecking, m_CorpusEndTokenNo, m_Profiler, m_SourceFilesNumber, m_StartTime, TiXmlBase::SetCondenseWhiteSpace(), SetCurrMessage(), CConcIndexator::StartIndexing(), and CMyTimeSpanHolder::StartTimer().

Referenced by BuildIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrintProgress()

void ConcIndexatorInvoker::PrintProgress ( DWORD saveCorpusEndTokenNo )

private

References Format(), m_CurrentSourceFileName, m_CurrentSourceFileNo, m_SourceFilesNumber, m_StartTime, and SetCurrMessage().

Referenced by AddInputLoadIndexToMemoryLoadIndexWrapper().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IndexFiles()

void ConcIndexatorInvoker::IndexFiles ( CConcIndexator & Indexator )

private

References FinalizeIndex(), Format(), CConcIndexator::GetMaxInputLoadIndexSize(), CConcIndexator::GetMaxTokenCountInOnePeriod(), CSourceFileHolder::GetSourceFile(), m_bStoppedByUser, m_CorpusEndTokenNo, m_CurrentSourceFileName, m_CurrentSourceFileNo, m_ErrorCorpusFiles, m_SourceFilesNumber, and ProcessTarOrSingleFile().

Referenced by BuildIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveLoadIndexToDisk()

void ConcIndexatorInvoker::SaveLoadIndexToDisk ( CConcIndexator & Indexator )

private

References CStringIndexator::AddInputLoadIndexToMemoryLoadIndex(), CStringIndexator::AddMemoryLoadIndexToMainLoadIndex(), CMyTimeSpanHolder::EndTimer(), Format(), m_Profiler, CStringIndexator::SaveMemoryLoadIndex(), SetCurrMessage(), and CMyTimeSpanHolder::StartTimer().

Referenced by ProcessTarOrSingleFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IndexFile()

DWORD ConcIndexatorInvoker::IndexFile	(	CConcIndexator &	Indexator,
		CIndexDocument *	document
	)

private

References CHitBorders::AddBreakByName(), CTokenIndexator::CorpusEndTokenNo, CIndexDocument::CorpusFileName, ddcLogError, ddcLogWarn, CMyTimeSpanHolder::EndTimer(), Format(), CIndexItem::GetMaximalNumberOfRunningTokens(), CConcIndexator::IndexOneFile(), CIndexDocument::IsEmpty(), CConcordance::m_bResumeOnIndexErrors, m_CorpusEndTokenNo, CConcordance::m_CorpusFiles, m_ErrorCorpusFiles, m_Profiler, CExpc::m_strCause, PredefinedFileBreakName, ddcCorpusList< OffT_ >::push_back(), CConcIndexator::RollbackIndexOneFile(), SetCurrMessage(), CMyTimeSpanHolder::StartTimer(), and CExpc::what().

Referenced by ProcessTarOrSingleFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddInputLoadIndexToMemoryLoadIndexWrapper()

void ConcIndexatorInvoker::AddInputLoadIndexToMemoryLoadIndexWrapper ( CConcIndexator & Indexator )

private

References CStringIndexator::AddInputLoadIndexToMemoryLoadIndex(), CMyTimeSpanHolder::EndTimer(), Format(), m_CorpusEndTokenNo, m_CurrentSourceFileName, m_Profiler, PrintProgress(), and CMyTimeSpanHolder::StartTimer().

Referenced by ProcessTarOrSingleFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessTarOrSingleFile()

void ConcIndexatorInvoker::ProcessTarOrSingleFile	(	CConcIndexator &	Indexator,
		size_t &	InputLoadIndexSize,
		size_t &	MemoryLoadIndexSize
	)

private

References AddInputLoadIndexToMemoryLoadIndexWrapper(), CConcIndexator::GetMaxInputLoadIndexSize(), CConcIndexator::GetMaxTokenCountInOnePeriod(), IndexFile(), m_bStoppedByUser, m_CurrentSourceFileName, and SaveLoadIndexToDisk().

Referenced by IndexFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetCurrMessage()

void ConcIndexatorInvoker::SetCurrMessage ( string Message ) const

outputs a message to stdout or to GUI

References m_bStdout, and m_CurrMessage.

Referenced by BuildIndex(), BuildIndexStart(), BuildOnlyMorphIndex(), FinalizeIndex(), IndexFile(), PrintProgress(), SaveLoadIndexToDisk(), and WriteTimeStatistics().

Here is the caller graph for this function:

◆ BuildIndex()

bool ConcIndexatorInvoker::BuildIndex ( string ProjectFile )

builds index files for project ProjectFile

References _MAX_PATH, BuildIndexStart(), BuildOnlyMorphIndex(), ddcLogDebug, ddcLogError, CConcIndexator::DestroyIndex(), Format(), CConcIndexator::GetMaxTokenCountInOnePeriod(), GetPathByFile(), IndexFiles(), m_bOnlyReindexMorphology, m_bStoppedByUser, CExpc::m_strCause, newhandler(), SetCurrMessage(), CConcIndexator::TerminateIndexing(), and WriteTimeStatistics().

Here is the call graph for this function:

Member Data Documentation

◆ m_StartTime

time_t ConcIndexatorInvoker::m_StartTime

private

Referenced by BuildIndexStart(), and PrintProgress().

◆ m_CorpusEndTokenNo

DWORD ConcIndexatorInvoker::m_CorpusEndTokenNo

private

Referenced by AddInputLoadIndexToMemoryLoadIndexWrapper(), BuildIndexStart(), FinalizeIndex(), IndexFile(), IndexFiles(), and WriteTimeStatistics().

◆ m_ErrorCorpusFiles

vector<string> ConcIndexatorInvoker::m_ErrorCorpusFiles

private

Referenced by FinalizeIndex(), IndexFile(), and IndexFiles().

◆ m_bStoppedByUser

bool ConcIndexatorInvoker::m_bStoppedByUser

if true, CConcIndexatorInvoker tries to stop indexing

Referenced by BuildIndex(), ConcIndexatorInvoker(), IndexFiles(), and ProcessTarOrSingleFile().

◆ m_bOnlyReindexMorphology

bool ConcIndexatorInvoker::m_bOnlyReindexMorphology

if true, then BuildIndex should only rebuild MorphPattern index

Referenced by BuildIndex(), and ConcIndexatorInvoker().

◆ m_bSkipInitialFileChecking

bool ConcIndexatorInvoker::m_bSkipInitialFileChecking

if true, then there is no initial checking whether the source files exist

Referenced by BuildIndexStart(), and ConcIndexatorInvoker().

◆ m_CurrMessage

string ConcIndexatorInvoker::m_CurrMessage

mutable

the last message from indexing process

Referenced by SetCurrMessage().

◆ m_bStdout

bool ConcIndexatorInvoker::m_bStdout

should DDC send all messages to stdout

Referenced by ConcIndexatorInvoker(), and SetCurrMessage().

◆ m_CurrentSourceFileNo

int ConcIndexatorInvoker::m_CurrentSourceFileNo

the index of the currently processing source file

Referenced by ConcIndexatorInvoker(), IndexFiles(), and PrintProgress().

◆ m_SourceFilesNumber

int ConcIndexatorInvoker::m_SourceFilesNumber

the number of files to index

Referenced by BuildIndexStart(), ConcIndexatorInvoker(), IndexFiles(), and PrintProgress().

◆ m_CurrentSourceFileName

string ConcIndexatorInvoker::m_CurrentSourceFileName

the name of file

Referenced by AddInputLoadIndexToMemoryLoadIndexWrapper(), IndexFiles(), PrintProgress(), and ProcessTarOrSingleFile().

◆ m_Profiler

CMyTimeSpanHolder ConcIndexatorInvoker::m_Profiler

mutable

a slot to gather profiling information for loading stage

Referenced by AddInputLoadIndexToMemoryLoadIndexWrapper(), BuildIndexStart(), ConcIndexatorInvoker(), FinalizeIndex(), IndexFile(), SaveLoadIndexToDisk(), and WriteTimeStatistics().

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConcIndexatorInvoker()

Member Function Documentation

◆ GetTimeStatisticsFileName()

◆ GetErrorLogFileName()

◆ WriteTimeStatistics()

◆ FinalizeIndex()

◆ BuildOnlyMorphIndex()

◆ BuildIndexStart()

◆ PrintProgress()

◆ IndexFiles()

◆ SaveLoadIndexToDisk()

◆ IndexFile()

◆ AddInputLoadIndexToMemoryLoadIndexWrapper()

◆ ProcessTarOrSingleFile()

◆ SetCurrMessage()

◆ BuildIndex()

Member Data Documentation

◆ m_StartTime

◆ m_CorpusEndTokenNo

◆ m_ErrorCorpusFiles

◆ m_bStoppedByUser

◆ m_bOnlyReindexMorphology

◆ m_bSkipInitialFileChecking

◆ m_CurrMessage

◆ m_bStdout

◆ m_CurrentSourceFileNo

◆ m_SourceFilesNumber

◆ m_CurrentSourceFileName

◆ m_Profiler