patternMatcherInstanceInterface.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Patrick P. Frey
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef _STRUS_ANALYZER_PATTERN_MATCHER_INSTANCE_INTERFACE_HPP_INCLUDED
#define _STRUS_ANALYZER_PATTERN_MATCHER_INSTANCE_INTERFACE_HPP_INCLUDED
#include "strus/analyzer/functionView.hpp"
#include <string>

namespace strus
{

class PatternMatcherContextInterface;

class PatternMatcherInstanceInterface
{
public:
        virtual ~PatternMatcherInstanceInterface(){}

        virtual void defineOption( const std::string& name, double value)=0;

        virtual void defineTermFrequency( unsigned int termid, double df)=0;

        virtual void pushTerm( unsigned int termid)=0;

        enum JoinOperation
        {
                OpSequence,             
                OpSequenceImm,          
                OpSequenceStruct,       
                OpWithin,               
                OpWithinStruct,         
                OpAny,                  
                OpAnd                   
        };
        static const char* joinOperationName( JoinOperation op)
        {
                static const char* ar[] = {"sequence","sequence_imm","sequence_struct","within","within_struct","any","and",0};
                return ar[ op];
        }

        virtual void pushExpression(
                        JoinOperation operation,
                        std::size_t argc, unsigned int range, unsigned int cardinality)=0;

        virtual void pushPattern( const std::string& name)=0;

        virtual void attachVariable( const std::string& name)=0;

        virtual void definePattern( const std::string& name, const std::string& formatstring, bool visible)=0;

        virtual bool compile()=0;

        virtual PatternMatcherContextInterface* createContext() const=0;

        virtual analyzer::FunctionView view() const=0;
};

} //namespace
#endif