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


TypeAttribute.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 TYPEATTRIBUTE_H
8 #define TYPEATTRIBUTE_H
9 
10 #include "Attribute.h"
11 
12 namespace Lucene {
13 
15 class LPPAPI TypeAttribute : public Attribute {
16 public:
18  TypeAttribute(const String& type);
19  virtual ~TypeAttribute();
20 
22 
23 protected:
24  String _type;
25  static const String& DEFAULT_TYPE();
26 
27 public:
28  virtual String toString();
29 
31  String type();
32 
35  void setType(const String& type);
36 
37  virtual void clear();
38  virtual bool equals(const LuceneObjectPtr& other);
39  virtual int32_t hashCode();
40  virtual void copyTo(const AttributePtr& target);
42 };
43 
44 }
45 
46 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Base class for Attributes that can be added to a AttributeSource.
Definition: Attribute.h:18
A Token's lexical type. The Default value is "word".
Definition: TypeAttribute.h:15
static const String & DEFAULT_TYPE()
virtual String toString()
Returns a string representation of the object.
virtual bool equals(const LuceneObjectPtr &other)
All values used for computation of hashCode() should be checked here for equality.
TypeAttribute(const String &type)
virtual void copyTo(const AttributePtr &target)
Copies the values from this Attribute into the passed-in target attribute. The target implementation ...
virtual void clear()
Clears the values in this Attribute and resets it to its default value. If this implementation implem...
void setType(const String &type)
Set the lexical type.
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.
String type()
Returns this Token's lexical type. Defaults to "word".
String _type
Definition: TypeAttribute.h:21
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