Lucene++ - a full-featured, c++ search engine
API Documentation
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
String get(const String &name)
Returns the string value of the field with the given name if any exist in this document,...
ByteArray getBinaryValue(const String &name)
Returns an array of bytes for the first (or only) field that has the name specified as the method par...
void removeFields(const String &name)
Removes all fields with the given name from the document. If there is no field with the specified nam...
FieldablePtr getFieldable(const String &name)
Returns a field with the given name if any exist in this document, or null. If multiple fields exists...
Documents are the unit of indexing and search.
Definition: Document.h:24
virtual String toString()
Returns a string representation of the object.
boost::shared_ptr< Field > FieldPtr
Definition: LuceneTypes.h:75
Definition: AbstractAllTermDocs.h:12
void add(const FieldablePtr &field)
Adds a field to a document. Several fields may be added with the same name. In this case,...
Base class for all Lucene classes.
Definition: LuceneObject.h:31
void setBoost(double boost)
Sets a boost factor for hits on any field of this document. This value will be multiplied into the sc...
Collection< String > getValues(const String &name)
Returns an array of values of the field specified as the method parameter. This method returns an emp...
void removeField(const String &name)
Removes field with the specified name from the document. If multiple fields exist with this name,...
Collection< FieldablePtr > fields
Definition: Document.h:31
boost::shared_ptr< Fieldable > FieldablePtr
Definition: LuceneTypes.h:76
FieldPtr getField(const String &name)
Returns a field with the given name if any exist in this document, or null. If multiple fields exists...
Collection< FieldablePtr > getFieldables(const String &name)
Returns an array of Fieldables with the given name. This method returns an empty array when there are...
Document()
Constructs a new document with no fields.
Collection< FieldablePtr > getFields()
Returns a List of all the fields in a document.
Collection< ByteArray > getBinaryValues(const String &name)
Returns an array of byte arrays for of the fields that have the name specified as the method paramete...
Collection< FieldPtr > getFields(const String &name)
Returns an array of Fields with the given name. Do not use with lazy loaded fields....
double getBoost()
Returns, at indexing time, the boost factor as set by setBoost(double).
double boost
Definition: Document.h:35
clucene.sourceforge.net