 |
Lucene.Net
3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
|
|
Lucene.Net
3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
|
Documents are the unit of indexing and search. More...
Public Member Functions | |
| Document () | |
| Constructs a new document with no fields. | |
| void | Add (IFieldable 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 | RemoveField (System.String 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. | |
| void | RemoveFields (System.String 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. | |
| Field | GetField (System.String name) |
| 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. Do not use this method with lazy loaded fields. | |
| IFieldable | GetFieldable (System.String name) |
| 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. | |
| System.String | Get (System.String name) |
| 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. | |
| System.Collections.Generic.IList < IFieldable > | GetFields () |
| 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. Searcher.Doc(int) or IndexReader.Document(int). | |
| Field[] | GetFields (System.String name) |
| Returns an array of Fields with the given name. Do not use with lazy loaded fields. This method returns an empty array when there are no matching fields. It never returns null. | |
| IFieldable[] | GetFieldables (System.String name) |
| Returns an array of IFieldables with the given name. This method returns an empty array when there are no matching fields. It never returns null. | |
| System.String[] | GetValues (System.String name) |
| Returns an array of values of the field specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null. | |
| byte[][] | GetBinaryValues (System.String name) |
| Returns an array of byte arrays for of the fields that have the name specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null. | |
| byte[] | GetBinaryValue (System.String name) |
Returns an array of bytes for the first (or only) field that has the name specified as the method parameter. This method will return null if no binary fields with the specified name are available. There may be non-binary fields with the same name. | |
| override System.String | ToString () |
| Prints the fields of a document for human consumption. | |
Properties | |
| float | Boost [get, set] |
| Gets or sets, at indexing time, the boost factor. | |
| System.Collections.Generic.IList < IFieldable > | fields_ForNUnit [get] |
Documents are the unit of indexing and search.
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 ScoreDoc.Doc, Searcher.Doc(int) or IndexReader.Document(int).
Definition at line 42 of file Document.cs.
| Lucene.Net.Documents.Document.Document | ( | ) |
Constructs a new document with no fields.
Definition at line 100 of file Document.cs.
| void Lucene.Net.Documents.Document.Add | ( | IFieldable | 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.
Definition at line 132 of file Document.cs.
| System.String Lucene.Net.Documents.Document.Get | ( | System.String | name | ) |
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.
Definition at line 210 of file Document.cs.
| byte [] Lucene.Net.Documents.Document.GetBinaryValue | ( | System.String | name | ) |
Returns an array of bytes for the first (or only) field that has the name specified as the method parameter. This method will return null if no binary fields with the specified name are available. There may be non-binary fields with the same name.
| name | the name of the field. |
byte[] containing the binary field value or null Definition at line 351 of file Document.cs.
| byte [][] Lucene.Net.Documents.Document.GetBinaryValues | ( | System.String | name | ) |
Returns an array of byte arrays for of the fields that have the name specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null.
| name | the name of the field |
byte[][] of binary field values Definition at line 326 of file Document.cs.
| Field Lucene.Net.Documents.Document.GetField | ( | System.String | name | ) |
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. Do not use this method with lazy loaded fields.
Definition at line 185 of file Document.cs.
| IFieldable Lucene.Net.Documents.Document.GetFieldable | ( | System.String | name | ) |
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.
Definition at line 195 of file Document.cs.
| IFieldable [] Lucene.Net.Documents.Document.GetFieldables | ( | System.String | name | ) |
Returns an array of IFieldables with the given name. This method returns an empty array when there are no matching fields. It never returns null.
| name | the name of the field |
Fieldable[] array Definition at line 271 of file Document.cs.
| System.Collections.Generic.IList<IFieldable> Lucene.Net.Documents.Document.GetFields | ( | ) |
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. Searcher.Doc(int) or IndexReader.Document(int).
Definition at line 225 of file Document.cs.
| Field [] Lucene.Net.Documents.Document.GetFields | ( | System.String | name | ) |
Returns an array of Fields with the given name. Do not use with lazy loaded fields. This method returns an empty array when there are no matching fields. It never returns null.
| name | the name of the field |
Field[] array Definition at line 242 of file Document.cs.
| System.String [] Lucene.Net.Documents.Document.GetValues | ( | System.String | name | ) |
Returns an array of values of the field specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null.
| name | the name of the field |
String[] of field values Definition at line 299 of file Document.cs.
| void Lucene.Net.Documents.Document.RemoveField | ( | System.String | 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.
Definition at line 146 of file Document.cs.
| void Lucene.Net.Documents.Document.RemoveFields | ( | System.String | 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.
Definition at line 168 of file Document.cs.
| override System.String Lucene.Net.Documents.Document.ToString | ( | ) |
Prints the fields of a document for human consumption.
Definition at line 362 of file Document.cs.
|
getset |
Gets or sets, at indexing time, the boost factor.
The default is 1.0
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.)
Definition at line 118 of file Document.cs.
|
get |
Definition at line 378 of file Document.cs.
1.8.3