storageDocumentUpdateInterface.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_STORAGE_DOCUMENT_UPDATE_INTERFACE_HPP_INCLUDED
#define _STRUS_STORAGE_DOCUMENT_UPDATE_INTERFACE_HPP_INCLUDED
#include <string>
#include "strus/index.hpp"
#include "strus/numericVariant.hpp"

namespace strus
{

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

        virtual void addSearchIndexTerm(
                        const std::string& type_,
                        const std::string& value_,
                        const Index& position_)=0;

        virtual void addSearchIndexStructure(
                        const std::string& struct_,
                        const IndexRange& source_,
                        const IndexRange& sink_)=0;

        virtual void addForwardIndexTerm(
                        const std::string& type_,
                        const std::string& value_,
                        const Index& position_)=0;

        virtual void clearSearchIndexTerm(
                        const std::string& type_)=0;

        virtual void clearSearchIndexStructure(
                        const std::string& struct_)=0;

        virtual void clearForwardIndexTerm(
                        const std::string& type_)=0;

        virtual void setMetaData(
                        const std::string& name_,
                        const NumericVariant& value_)=0;

        virtual void setAttribute(
                        const std::string& name_,
                        const std::string& value_)=0;

        virtual void clearAttribute(
                        const std::string& name_)=0;

        virtual void setUserAccessRight(
                        const std::string& username_)=0;

        virtual void clearUserAccessRight(
                        const std::string& username_)=0;

        virtual void clearUserAccessRights()=0;

        virtual void done()=0;
};

}//namespace
#endif