QueryOptions.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 DDC_QUERY_OPTIONS_H
#define DDC_QUERY_OPTIONS_H

#include "../ConcordLib/QueryFilter.h"

//======================================================================
// typedefs

class CQueryCompiler;  //-- forward decl

typedef vector<CQFilter*>       CQFilterList;
typedef vector<string>          CQSubcorpusList;
typedef list<string>            CQCommentList;

//======================================================================
class CQueryOptions : public ddcObject {
public:
    size_t m_ContextSentencesCount;

    // if true, DDC shows file names, instead of bibliographical information for this query
    bool m_bEnableBibliography;
  
    bool m_bDebugRank;

    bool m_bSeparateHits;

    int m_TextAreaNo;

    vector<string> m_Within;

    string m_HitTypeStr;
  
    CQFilterList m_QFilters;

    vector<CDDCFilterWithBounds> m_Filters; 

    CQSubcorpusList m_Subcorpora;

    CQCommentList m_Comments;

    CQCommentList m_LexerComments;

public:
    //------------------------------------------------------------


    CQueryOptions()
        : 
        m_ContextSentencesCount(0),
        m_bEnableBibliography(true),
        m_bDebugRank(false),
        m_bSeparateHits(false),
        m_TextAreaNo(UnknownTextAreaNo),
        m_HitTypeStr("")
    {};

    virtual ~CQueryOptions(void);

    void swap(CQueryOptions &x);

    void assign(const CQueryOptions &src, bool deep=true);

    inline CQueryOptions* Clone(void) const
    {
        CQueryOptions *clone = new CQueryOptions();
        clone->assign(*this);
        return clone;
    };

    inline CQueryOptions* SafeClone()
    {
        CQueryOptions *clone = new CQueryOptions();
        clone->assign(*this,false);
        return clone;
    };

public:
    //------------------------------------------------------------


    virtual bool CheckSatisfiable(CQueryCompiler *compiler);
    
    virtual bool Compile(CQueryCompiler *compiler);

    virtual void Clear();

    void ClearComments();

    bool CanFilterByFile() const;

    bool IsTrivialFilter() const;

    CQFilter *PrimarySortFilter() const;

    bool IsPruneFilter() const;

public:
    //------------------------------------------------------------

    virtual ddcObjectList Children() const;
    virtual void DisownChildren();
    virtual string toString();
    virtual string jsonClass() { return "CQueryOptions"; };
    virtual string jsonData();
};

#endif /* DDC_QUERY_OPTIONS_H */

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