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


Loading...
Searching...
No Matches
PositionIncrementAttribute.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 POSITIONINCREMENTATTRIBUTE_H
8#define POSITIONINCREMENTATTRIBUTE_H
9
10#include "Attribute.h"
11
12namespace Lucene {
13
33public:
36
38
39protected:
41
42public:
43 virtual String toString();
44
47 virtual void setPositionIncrement(int32_t positionIncrement);
48
51 virtual int32_t getPositionIncrement();
52
53 virtual void clear();
54 virtual bool equals(const LuceneObjectPtr& other);
55 virtual int32_t hashCode();
56 virtual void copyTo(const AttributePtr& target);
58};
59
60}
61
62#endif
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
Base class for Attributes that can be added to a AttributeSource.
Definition Attribute.h:18
The positionIncrement determines the position of this token relative to the previous Token in a Token...
Definition PositionIncrementAttribute.h:32
virtual bool equals(const LuceneObjectPtr &other)
All values used for computation of hashCode() should be checked here for equality.
virtual int32_t hashCode()
Subclasses must implement this method and should compute a hashCode similar to this:
virtual LuceneObjectPtr clone(const LuceneObjectPtr &other=LuceneObjectPtr())
Shallow clone. Subclasses must override this if they need to clone any members deeply.
int32_t positionIncrement
Definition PositionIncrementAttribute.h:40
virtual void clear()
Clears the values in this Attribute and resets it to its default value. If this implementation implem...
virtual void setPositionIncrement(int32_t positionIncrement)
Set the position increment. The default value is one.
virtual void copyTo(const AttributePtr &target)
Copies the values from this Attribute into the passed-in target attribute. The target implementation ...
virtual String toString()
Returns a string representation of the object.
virtual int32_t getPositionIncrement()
Returns the position increment of this Token.
Definition AbstractAllTermDocs.h:12
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition LuceneTypes.h:539
boost::shared_ptr< Attribute > AttributePtr
Definition LuceneTypes.h:518

clucene.sourceforge.net