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


FlagsAttribute.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 FLAGSATTRIBUTE_H
8 #define FLAGSATTRIBUTE_H
9 
10 #include "Attribute.h"
11 
12 namespace Lucene {
13 
16 class LPPAPI FlagsAttribute : public Attribute {
17 public:
19  virtual ~FlagsAttribute();
20 
22 
23 protected:
24  int32_t flags;
25 
26 public:
27  virtual String toString();
28 
32  virtual int32_t getFlags();
33 
35  virtual void setFlags(int32_t flags);
36 
37  virtual void clear();
38 
39  virtual bool equals(const LuceneObjectPtr& other);
40  virtual int32_t hashCode();
41  virtual void copyTo(const AttributePtr& target);
43 };
44 
45 }
46 
47 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Base class for Attributes that can be added to a AttributeSource.
Definition: Attribute.h:18
This attribute can be used to pass different flags down the tokenizer chain, eg from one TokenFilter ...
Definition: FlagsAttribute.h:16
virtual LuceneObjectPtr clone(const LuceneObjectPtr &other=LuceneObjectPtr())
Shallow clone. Subclasses must override this if they need to clone any members deeply.
virtual void copyTo(const AttributePtr &target)
Copies the values from this Attribute into the passed-in target attribute. The target implementation ...
virtual void setFlags(int32_t flags)
virtual String toString()
Returns a string representation of the object.
virtual int32_t hashCode()
Subclasses must implement this method and should compute a hashCode similar to this:
virtual bool equals(const LuceneObjectPtr &other)
All values used for computation of hashCode() should be checked here for equality.
virtual int32_t getFlags()
Get the bitset for any bits that have been set. This is completely distinct from {},...
int32_t flags
Definition: FlagsAttribute.h:21
virtual void clear()
Clears the values in this Attribute and resets it to its default value. If this implementation implem...
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