Lucene++ - a full-featured, c++ search engine
API Documentation

Loading...
Searching...
No Matches
PayloadFunction.h
Go to the documentation of this file.
1
2// Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3// Distributable under the terms of either the Apache License (Version 2.0)
4// or the GNU Lesser General Public License.
6
7#ifndef PAYLOADFUNCTION_H
8#define PAYLOADFUNCTION_H
9
10#include "LuceneObject.h"
11
12 namespace Lucene {
13
18 class LPPAPI PayloadFunction : public LuceneObject {
19 protected:
20 PayloadFunction();
21
22 public:
23 virtual ~PayloadFunction();
24 LUCENE_CLASS(PayloadFunction);
25
26 public:
38 virtual double currentScore(int32_t docId, const String& field, int32_t start, int32_t end, int32_t numPayloadsSeen,
39 double currentScore, double currentPayloadScore) = 0;
40
47 virtual double docScore(int32_t docId, const String& field, int32_t numPayloadsSeen, double payloadScore) = 0;
48
50 virtual int32_t hashCode() = 0;
51
53 virtual bool equals(const LuceneObjectPtr& other) = 0;
54};
55
56}
57
58#endif
LuceneObject.h
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
Lucene::LuceneObject
Base class for all Lucene classes.
Definition LuceneObject.h:31
Lucene::PayloadFunction
An abstract class that defines a way for Payload*Query instances to transform the cumulative effects ...
Definition PayloadFunction.h:18
Lucene::PayloadFunction::~PayloadFunction
virtual ~PayloadFunction()
Lucene::PayloadFunction::equals
virtual bool equals(const LuceneObjectPtr &other)=0
Return whether two objects are equal.
Lucene::PayloadFunction::currentScore
virtual double currentScore(int32_t docId, const String &field, int32_t start, int32_t end, int32_t numPayloadsSeen, double currentScore, double currentPayloadScore)=0
Calculate the score up to this point for this doc and field.
Lucene::PayloadFunction::docScore
virtual double docScore(int32_t docId, const String &field, int32_t numPayloadsSeen, double payloadScore)=0
Calculate the final score for all the payloads seen so far for this doc/field.
Lucene::PayloadFunction::PayloadFunction
PayloadFunction()
Lucene::PayloadFunction::hashCode
virtual int32_t hashCode()=0
Return hash code for this object.
Lucene
Definition AbstractAllTermDocs.h:12
Lucene::LuceneObjectPtr
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition LuceneTypes.h:539

clucene.sourceforge.net