← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/strigi/oneiric

« back to all changes in this revision

Viewing changes to libstreamanalyzer/include/strigi/streamthroughanalyzer.h

  • Committer: Package Import Robot
  • Author(s): Felix Geyer
  • Date: 2011-09-24 17:12:15 UTC
  • mfrom: (1.2.6 upstream)
  • mto: This revision was merged to the branch mainline in revision 44.
  • Revision ID: package-import@ubuntu.com-20110924171215-zmbi1f77jntvz65h
Tags: upstream-0.7.6
Import upstream version 0.7.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
libstreamanalyzer/include/strigi/streamthroughanalyzer.h
 
1
/* This file is part of Strigi Desktop Search
 
2
 *
 
3
 * Copyright (C) 2006 Jos van den Oever <jos@vandenoever.info>
 
4
 *
 
5
 * This library is free software; you can redistribute it and/or
 
6
 * modify it under the terms of the GNU Library General Public
 
7
 * License as published by the Free Software Foundation; either
 
8
 * version 2 of the License, or (at your option) any later version.
 
9
 *
 
10
 * This library is distributed in the hope that it will be useful,
 
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
13
 * Library General Public License for more details.
 
14
 *
 
15
 * You should have received a copy of the GNU Library General Public License
 
16
 * along with this library; see the file COPYING.LIB.  If not, write to
 
17
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 
18
 * Boston, MA 02110-1301, USA.
 
19
 */
 
20
#ifndef STRIGI_STREAMTHROUGHANALYZER_H
 
21
#define STRIGI_STREAMTHROUGHANALYZER_H
 
22
 
 
23
#include "streamanalyzerfactory.h"
 
24
 
 
25
namespace Strigi {
 
26
 
 
27
class AnalysisResult;
 
28
template <class T> class StreamBase;
 
29
typedef StreamBase<char> InputStream;
 
30
 
 
31
/**
 
32
 * This class defines an interface for analyzing streams.
 
33
 * This interface is not yet complete, it lacks good functions for retrieving
 
34
 * the results in other ways than just printing them.
 
35
 */
 
36
class STREAMANALYZER_EXPORT StreamThroughAnalyzer {
 
37
public:
 
38
    virtual ~StreamThroughAnalyzer() {}
 
39
    /**
 
40
     * Passes a pointer to the AnalysisResult to be used for
 
41
     * this stream.
 
42
     **/
 
43
    virtual void setIndexable(Strigi::AnalysisResult*) = 0;
 
44
    /**
 
45
     * This function sets up the analyzer for handling a stream.
 
46
     * The stream \p in is used in constructing a new internal
 
47
     * inputstream that is returned by this function. Every time
 
48
     * a read call is performed on this class, the data read
 
49
     * is used in the analysis before being passed on to the
 
50
     * caller. The InputStream pointer maybe 0 for special filetypes that have
 
51
     * no content, so any implementation must always check the pointer before
 
52
     * reading from the stream.
 
53
     * The stream @p in should be returned and it should be at position 0.
 
54
     * This means reading from the stream is only allowed when the stream is reset to position 0.
 
55
     **/
 
56
    virtual InputStream *connectInputStream(InputStream *in) = 0;
 
57
    /**
 
58
     * Signals to the caller whether this analyzer is finished
 
59
     * with the current stream.
 
60
     **/
 
61
    virtual bool isReadyWithStream() = 0;
 
62
    /**
 
63
     * Return the name of this throughanalyzer.
 
64
     **/
 
65
    virtual const char* name() const = 0;
 
66
};
 
67
 
 
68
/**
 
69
 * The factory class for the StreamThroughAnalyzer
 
70
 */
 
71
class STREAMANALYZER_EXPORT StreamThroughAnalyzerFactory
 
72
        : public StreamAnalyzerFactory {
 
73
public:
 
74
    virtual StreamThroughAnalyzer* newInstance() const = 0;
 
75
};
 
76
 
 
77
} // end namespace Strigi
 
78
 
 
79
#endif