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

- Main Page
- Related Pages
- Namespaces
- Data Structures
- Files

- File List
- Globals

Payload.h
Go to the documentation of this file.
1 // 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 PAYLOAD_H
8 #define PAYLOAD_H
9
10 #include "LuceneObject.h"
11
12 namespace Lucene {
13
21 class LPPAPI Payload : public LuceneObject {
22 public:
24 Payload();
25
29 Payload(ByteArray data);
30
36 Payload(ByteArray data, int32_t offset, int32_t length);
37
38 virtual ~Payload();
39
40 LUCENE_CLASS(Payload);
41
42 protected:
44 ByteArray data;
45
47 int32_t offset;
48
50 int32_t _length;
51
52 public:
54 void setData(ByteArray data);
55
57 void setData(ByteArray data, int32_t offset, int32_t length);
58
60 ByteArray getData();
61
63 int32_t getOffset();
64
66 int32_t length();
67
69 uint8_t byteAt(int32_t index);
70
72 ByteArray toByteArray();
73
77 void copyTo(ByteArray target, int32_t targetOffset);
78
80 virtual LuceneObjectPtr clone(const LuceneObjectPtr& other = LuceneObjectPtr());
81
82 virtual bool equals(const LuceneObjectPtr& other);
83 virtual int32_t hashCode();
84 };
85
86 }
87
88 #endif
Lucene::LuceneObjectPtr
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition: LuceneTypes.h:539
Lucene::Payload::_length
int32_t _length
the length of the payload data
Definition: Payload.h:50
LuceneObject.h
Lucene::Payload
A Payload is metadata that can be stored together with each occurrence of a term. This metadata is st...
Definition: Payload.h:21
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Lucene::Payload::offset
int32_t offset
the offset within the byte array
Definition: Payload.h:47
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene
Definition: AbstractAllTermDocs.h:12

clucene.sourceforge.net