documentAnalyzerInstanceInterface.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014 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_DOCUMENT_ANALYZER_INTERFACE_HPP_INCLUDED
#define _STRUS_ANALYZER_DOCUMENT_ANALYZER_INTERFACE_HPP_INCLUDED
#include "strus/analyzer/document.hpp"
#include "strus/analyzer/positionBind.hpp"
#include "strus/analyzer/documentClass.hpp"
#include "strus/analyzer/featureOptions.hpp"
#include "strus/analyzer/segmenterOptions.hpp"
#include "strus/analyzer/documentAnalyzerView.hpp"
#include <vector>
#include <string>

namespace strus
{

class DocumentAnalyzerContextInterface;
class NormalizerFunctionInstanceInterface;
class TokenizerFunctionInstanceInterface;
class AggregatorFunctionInstanceInterface;
class SegmenterInterface;
class PatternTermFeederInstanceInterface;
class PatternMatcherInstanceInterface;
class PatternLexerInstanceInterface;

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

        virtual void addSearchIndexFeature(
                        const std::string& type,
                        const std::string& selectexpr,
                        TokenizerFunctionInstanceInterface* tokenizer,
                        const std::vector<NormalizerFunctionInstanceInterface*>& normalizers,
                        int priority,
                        const analyzer::FeatureOptions& options)=0;

        virtual void addForwardIndexFeature(
                        const std::string& type,
                        const std::string& selectexpr,
                        TokenizerFunctionInstanceInterface* tokenizer,
                        const std::vector<NormalizerFunctionInstanceInterface*>& normalizers,
                        int priority,
                        const analyzer::FeatureOptions& options)=0;

        virtual void defineMetaData(
                        const std::string& metaname,
                        const std::string& selectexpr,
                        TokenizerFunctionInstanceInterface* tokenizer,
                        const std::vector<NormalizerFunctionInstanceInterface*>& normalizers)=0;

        virtual void defineAggregatedMetaData(
                        const std::string& metaname,
                        AggregatorFunctionInstanceInterface* statfunc)=0;

        virtual void defineAttribute(
                        const std::string& attribname,
                        const std::string& selectexpr,
                        TokenizerFunctionInstanceInterface* tokenizer,
                        const std::vector<NormalizerFunctionInstanceInterface*>& normalizers)=0;

        virtual void defineSubDocument(
                        const std::string& subDocumentTypeName,
                        const std::string& selectexpr)=0;

        virtual void defineSubContent(
                        const std::string& selectexpr,
                        const analyzer::DocumentClass& documentClass)=0;

        virtual void addPatternLexem(
                        const std::string& termtype,
                        const std::string& selectexpr,
                        TokenizerFunctionInstanceInterface* tokenizer,
                        const std::vector<NormalizerFunctionInstanceInterface*>& normalizers,
                        int priority)=0;

        virtual void defineTokenPatternMatcher(
                        const std::string& patternName,
                        PatternMatcherInstanceInterface* matcher,
                        PatternTermFeederInstanceInterface* feeder)=0;

        virtual void defineContentPatternMatcher(
                        const std::string& patternName,
                        PatternMatcherInstanceInterface* matcher,
                        PatternLexerInstanceInterface* lexer,
                        const std::vector<std::string>& selectexpr)=0;

        virtual void addSearchIndexFeatureFromPatternMatch(
                        const std::string& type,
                        const std::string& patternName,
                        const std::vector<NormalizerFunctionInstanceInterface*>& normalizers,
                        int priority,
                        const analyzer::FeatureOptions& options)=0;

        virtual void addForwardIndexFeatureFromPatternMatch(
                        const std::string& type,
                        const std::string& patternName,
                        const std::vector<NormalizerFunctionInstanceInterface*>& normalizers,
                        int priority,
                        const analyzer::FeatureOptions& options)=0;

        virtual void defineMetaDataFromPatternMatch(
                        const std::string& metaname,
                        const std::string& patternName,
                        const std::vector<NormalizerFunctionInstanceInterface*>& normalizers)=0;

        virtual void defineAttributeFromPatternMatch(
                        const std::string& attribname,
                        const std::string& patternName,
                        const std::vector<NormalizerFunctionInstanceInterface*>& normalizers)=0;

        virtual analyzer::Document analyze(
                        const std::string& content,
                        const analyzer::DocumentClass& dclass) const=0;

        virtual DocumentAnalyzerContextInterface* createContext(
                        const analyzer::DocumentClass& dclass) const=0;

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

}//namespace
#endif