CLucene - a full-featured, c++ search engine
API Documentation
#include <Document.h>
Public Member Functions | |
| Document () | |
| Constructs a new document with no fields. | |
| ~Document () | |
| void | setBoost (const float_t boost) |
| Sets a boost factor for hits on any field of this document. | |
| float_t | getBoost () const |
| Returns, at indexing time, the boost factor as set by setBoost(float). | |
| void | add (Field &field) |
| void | removeField (const TCHAR *name) |
| void | removeFields (const TCHAR *name) |
| Field * | getField (const TCHAR *name) const |
| Returns a field with the given name if any exist in this document, or null. | |
| const TCHAR * | get (const TCHAR *field) const |
| Returns the string value of the field with the given name if any exist in this document, or null. | |
| DocumentFieldEnumeration * | fields () const |
| Returns an Enumeration of all the fields in a document. | |
| DocumentFieldEnumeration * | getFields () const |
| Returns a List of all the fields in a document. | |
| TCHAR * | toString () const |
| Prints the fields of a document for human consumption. | |
| TCHAR ** | getValues (const TCHAR *name) |
| Returns an array of values of the field specified as the method parameter. | |
| void | clear () |
| Empties out the document so that it can be reused. | |
A Document is a set of fields. Each field has a name and a textual value. A field may be stored with the document, in which case it is returned with search hits on the document. Thus each document should typically contain one or more stored fields which uniquely identify it.
Note that fields which are not stored are not available in documents retrieved from the index, e.g. with Hits#doc(int32_t, Document*), Searcher#doc(int32_t, Document*) or IndexReader#document(int32_t, Document*).
| lucene::document::Document::Document | ( | ) |
Constructs a new document with no fields.
| lucene::document::Document::~Document | ( | ) |
| void lucene::document::Document::setBoost | ( | const float_t | boost | ) |
Sets a boost factor for hits on any field of this document.
This value will be multiplied into the score of all hits on this document.
The default value is 1.0.
Values are multiplied into the value of Field#getBoost() of each field in this document. Thus, this method in effect sets a default boost for the fields of this document.
| float_t lucene::document::Document::getBoost | ( | ) | const |
Returns, at indexing time, the boost factor as set by setBoost(float).
Note that once a document is indexed this value is no longer available from the index. At search time, for retrieved documents, this method always returns 1. This however does not mean that the boost value set at indexing time was ignored - it was just combined with other indexing time factors and stored elsewhere, for better indexing and search performance. (For more information see the "norm(t,d)" part of the scoring formula in Similarity.)
| void lucene::document::Document::add | ( | Field & | field | ) |
Adds a field to a document. Several fields may be added with the same name. In this case, if the fields are indexed, their text is treated as though appended for the purposes of search.
Note that add like the removeField(s) methods only makes sense prior to adding a document to an index. These methods cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added.
| void lucene::document::Document::removeField | ( | const TCHAR * | name | ) |
Removes field with the specified name from the document. If multiple fields exist with this name, this method removes the first field that has been added. If there is no field with the specified name, the document remains unchanged.
Note that the removeField(s) methods like the add method only make sense prior to adding a document to an index. These methods cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added. Note: name is case sensitive
| void lucene::document::Document::removeFields | ( | const TCHAR * | name | ) |
Removes all fields with the given name from the document. If there is no field with the specified name, the document remains unchanged.
Note that the removeField(s) methods like the add method only make sense prior to adding a document to an index. These methods cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added. Note: name is case sensitive
| Field* lucene::document::Document::getField | ( | const TCHAR * | name | ) | const |
Returns a field with the given name if any exist in this document, or null.
If multiple fields exists with this name, this method returns the first value added. Note: name is case sensitive Do not use this method with lazy loaded fields.
| const TCHAR* lucene::document::Document::get | ( | const TCHAR * | field | ) | const |
Returns the string value of the field with the given name if any exist in this document, or null.
If multiple fields exist with this name, this method returns the first value added. If only binary fields with this name exist, returns null. Note: name is case sensitive
| DocumentFieldEnumeration* lucene::document::Document::fields | ( | ) | const |
| DocumentFieldEnumeration* lucene::document::Document::getFields | ( | ) | const |
Returns a List of all the fields in a document.
Note that fields which are not stored are not available in documents retrieved from the index, e.g. with Hits#doc(int), Searcher#doc(int) or IndexReader#document(int).
| TCHAR* lucene::document::Document::toString | ( | ) | const |
Prints the fields of a document for human consumption.
| TCHAR** lucene::document::Document::getValues | ( | const TCHAR * | name | ) |
Returns an array of values of the field specified as the method parameter.
This method can return null. Note: name is case sensitive
| name | the name of the field |
TCHAR** of field values or null | void lucene::document::Document::clear | ( | ) |
Empties out the document so that it can be reused.