StringIndexator.h

Go to the documentation of this file.

//-*- Mode: C++ -*-
//
//  DDC originally by Alexey Sokirko
//  Changes and modifications 2011-2020 by Bryan Jurish
//
//  This file is part of DDC.
// 
//  DDC is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
// 
//  DDC is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Lesser General Public License for more details.
// 
//  You should have received a copy of the GNU Lesser General Public License
//  along with DDC.  If not, see <http://www.gnu.org/licenses/>.
//
#ifndef  StringIndexator_h
#define  StringIndexator_h

#include "../ConcordLib/IndexSet.h"

//const char ddc_archive_stub[] = "ddc_archive_stub";
const char ddc_archive_stub[] = "";

struct CTokenIndexator {
    vector<CStringIndexSet*> ColumnMap;
    vector<CStringIndexSet*> AbsentIndices;
    CTokenNo CorpusEndTokenNo;
};

class CStringIndexator {
        
protected:
        
    vector<CTokenNo>        m_SearchPeriods;

    bool    RegisterChunkIndex();
    string  GetSearchPeriodsFileName() const;
    bool    DestroyIndices();
    void    ReadIndicesFromTheDisk();
    void    ClearStringIndices();
    void    IndexOneToken   (CTokenIndexator* document, const char* Line, bool tryFixErrors=true);

    // \param MaxLen maximum length in bytes of \a Out, including terminating NUL byte
    // \param nCols number of TAB-separated columns to write to \a Out ("globalFieldDelimeter" (sic))
    // \param InputLine TAB-separated input token line string with length greater than or equal to \a MaxLen
    // \param Out output string, should already be allocated with at least \a MaxLen bytes
    // \detail
    //   \li called implicitly by IndexOneToken() encounters a too-long line if \a tryFixErrors is true
    //   \li truncates only "greedy" columns (those using more than MaxLen/nCols bytes)
    //   \li truncates each "greedy" column indepdently, proportionate to its "greediness" (the number of bytes by which its length exceeds MaxLen/nCols)
    void IndexTokenFixLongColumns(const size_t MaxLen, const size_t nCols, const char *InputLine, char *Out);

public:
    typedef map<string,string> IndexAliasMap;

    typedef map<string,CStringIndexSet*> IndexMap;
        
public:
    string                                  m_Path;

    bool                                    m_bMemoryMap;

    vector<CStringIndexSet*>                m_Indices;

    IndexAliasMap                           m_IndexAlias;

    IndexMap                                m_IndexMap;

    size_t                                  m_MaxRegExpExpansionSize;

    CStringIndexSet*                        m_pChunkIndex;

    CStringIndexator();
    ~CStringIndexator();

    bool RegisterStringIndices(const string& IndicesStr);

    bool RegisterIndexAliases(const string& IndexAliasStr);

    bool RegisterIndexAlias(const string& AliasFrom, const string& AliasTo);

    void RegisterIndexAlias(const string& AliasFrom, CStringIndexSet* idx);

    void SetPath(string Path);
    string GetIndicesString() const;
    string GetIndexAliasString() const;
        
    size_t  GetSearchPeriodsCount() const;
    const CTokenNo&  GetSearchPeriod(size_t i) const { return m_SearchPeriods[i]; };

    bool    StartIndexing(string Path);
    void    TerminateIndexing();
    bool    FinalSaveAllIndices(bool bAfterLoading);
    bool    AddInputLoadIndexToMemoryLoadIndex();
    bool    AddMemoryLoadIndexToMainLoadIndex();
    bool    SaveMemoryLoadIndex();
    CStringIndexSet*  GetIndexByName(const string& Name);
    CStringIndexSet*  GetIndexByNameOrShortName(const string& Name);
    CStringIndexSet*  GetIndexByAlias(const string &Alias) const;
    CStringIndexSet* GetTokenIndex();
    const CStringIndexSet* GetTokenIndex() const;

};





#endif

/*--- emacs style variables ---
 * Local Variables:
 *  mode: C++
 *  c-file-style: "ellemtel"
 *  c-basic-offset: 4
 *  tab-width: 8
 *  indent-tabs-mode: nil
 * End:
 */