// The MIT License (MIT)

// Copyright (c) 2016, Microsoft

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#pragma once

#include <memory>                               // Embeds std::unique_ptr.

#include "BitFunnel/Index/IConfiguration.h"     // Inherits from IConfiguration.
#include "TermToText.h"                         // Parameterizes std::unique_ptr.


namespace BitFunnel
{
    class Configuration : public IConfiguration
    {
    public:
        Configuration(size_t maxGramSize,
                      bool keepTermText,
                      IIndexedIdfTable const & idfTable);

        // Returns the maximum ngram size to be indexed.
        virtual size_t GetMaxGramSize() const override;

        // Returns true if the configuration is keeping term text in a
        // TermToText mapping.
        bool KeepTermText() const override;

        // Returns the TermToText mapping. This diagnostic class provides
        // a mapping from Term hash to the Term's text in the corpus.
        // Note: behavior is undefined if KeepTermText() is false.
        virtual TermToText & GetTermToText() const override;

        // Returns an IIndexedIdfTable used to set the IDF values in each
        // Term as it is constructed. The IIndexedIdfTable should be
        // representative of the distribution of terms in the corpus.
        virtual IIndexedIdfTable const & GetIdfTable() const override;

    private:
        size_t m_maxGramSize;
        std::unique_ptr<TermToText> m_termToText;
        IIndexedIdfTable const & m_idfTable;
    };
}
