The methods of the Document class are listed below. For a complete list of Document class members, see the Document Members topic.
Public Instance Methods
 Add | 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. |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| Fields | Returns an Enumeration of all the fields in a document. |
| Get | 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. |
| GetBinaryValue | Returns an array of bytes for the first (or only) field that has the name specified as the method parameter. This method will return nullif no binary fields with the specified name are available. There may be non-binary fields with the same name. |
| GetBinaryValues | Returns an array of byte arrays for 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. |
| GetBoost | |
| GetField | 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. |
| GetFieldable | 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. |
| GetFieldables | Returns an array of {@link Fieldable}s with the given name. This method returns an empty array when there are no matching fields. It never returns null. |
| GetFields | Overloaded. |
| GetFieldsCount | Returns the number of fields in this document |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| GetValues | 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. |
| RemoveField | 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. |
| RemoveFields | 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. |
| SetBoost | |
| ToString | Prints the fields of a document for human consumption. |
See Also
Document Class | Lucene.Net.Documents Namespace