storageClientInterface.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_CLIENT_INTERFACE_HPP_INCLUDED
#define _STRUS_STORAGE_CLIENT_INTERFACE_HPP_INCLUDED
#include "strus/index.hpp"
#include "strus/termStatistics.hpp"
#include <string>
#include <vector>
#include <ostream>

namespace strus
{

class PostingIteratorInterface;
class StructIteratorInterface;
class ForwardIteratorInterface;
class DocumentTermIteratorInterface;
class InvAclIteratorInterface;
class ValueIteratorInterface;
class StorageTransactionInterface;
class StorageDocumentInterface;
class StatisticsProcessorInterface;
class StatisticsIteratorInterface;
class MetaDataReaderInterface;
class MetaDataRestrictionInterface;
class AttributeReaderInterface;
class AclReaderInterface;


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

        virtual std::string config() const=0;

        virtual PostingIteratorInterface*
                createTermPostingIterator(
                        const std::string& type,
                        const std::string& value,
                        const Index& length) const=0;

        virtual StructIteratorInterface*
                createStructIterator(
                        const std::string& structstr) const=0;

        virtual PostingIteratorInterface*
                createBrowsePostingIterator(
                        const MetaDataRestrictionInterface* restriction,
                        const Index& maxpos) const=0;

        virtual PostingIteratorInterface*
                createFieldPostingIterator(
                        const std::string& meta_fieldStart,
                        const std::string& meta_fieldEnd) const=0;

        virtual ForwardIteratorInterface*
                createForwardIterator(
                        const std::string& type) const=0;

        virtual DocumentTermIteratorInterface*
                createDocumentTermIterator(
                        const std::string& type) const=0;

        virtual InvAclIteratorInterface*
                createInvAclIterator(
                        const std::string& username) const=0;

        virtual AclReaderInterface* createAclReader() const=0;

        virtual Index nofDocumentsInserted() const=0;

        virtual Index documentFrequency(
                        const std::string& type,
                        const std::string& term) const=0;

        virtual Index maxDocumentNumber() const=0;

        virtual Index documentNumber( const std::string& docid) const=0;

        virtual Index termTypeNumber( const std::string& type) const=0;

        virtual bool isForwardIndexTerm( const std::string& type) const=0;

        virtual ValueIteratorInterface* createTermTypeIterator() const=0;

        virtual ValueIteratorInterface* createStructTypeIterator() const=0;

        virtual ValueIteratorInterface* createTermValueIterator() const=0;

        virtual ValueIteratorInterface* createDocIdIterator() const=0;

        virtual ValueIteratorInterface* createUserNameIterator() const=0;

        enum DocumentStatisticsType
        {
                StatNofTerms = 1,                       
                StatNofTermOccurrencies = 2             
        };

        virtual Index documentStatistics(
                        const Index& docno,
                        const DocumentStatisticsType& stat,
                        const std::string& type) const=0;

        virtual MetaDataReaderInterface* createMetaDataReader() const=0;

        virtual MetaDataRestrictionInterface* createMetaDataRestriction() const=0;

        virtual AttributeReaderInterface* createAttributeReader() const=0;

        virtual StorageTransactionInterface* createTransaction()=0;

        virtual StatisticsIteratorInterface* createAllStatisticsIterator( bool sign=true)=0;

        virtual StatisticsIteratorInterface* createChangeStatisticsIterator()=0;

        virtual const StatisticsProcessorInterface* getStatisticsProcessor() const=0;

        virtual StorageDocumentInterface* createDocumentChecker(
                        const std::string& docid,
                        const std::string& logfilename) const=0;

        virtual bool checkStorage( std::ostream& errorlog) const=0;

        virtual void close()=0;
};

}//namespace
#endif