core/org.gnit.lucenekmp.document/Document

Document

class Document : Iterable<IndexableField>

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 are not available in documents retrieved from the index, e.g. with ScoreDoc.doc or StoredFields.document.

Constructors

Document

constructor()

Types

Companion

object Companion

Functions

add

fun add(field: IndexableField)

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.

clear

fun clear()

Removes all the fields from document.

get

fun get(name: String?): String?

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. For a numeric StoredField it returns the string value of the number. If you want the actual numeric field instance back, use .getField.

getBinaryValue

fun getBinaryValue(name: String): BytesRef?

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.

getBinaryValues

fun getBinaryValues(name: String): Array<BytesRef>

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.

getField

fun getField(name: String?): IndexableField?

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.

getFields

fun getFields(): MutableList<IndexableField>

Returns a List of all the fields in a document.

fun getFields(name: String): Array<IndexableField>

Returns an array of IndexableFields with the given name. This method returns an empty array when there are no matching fields. It never returns null.

getValues

fun getValues(name: String): Array<String?>

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. For a numeric [ ] it returns the string value of the number. If you want the actual numeric field instances back, use .getFields.

iterator

open operator override fun iterator(): MutableIterator<IndexableField>

removeField

fun removeField(name: String)

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.

removeFields

fun removeFields(name: String)

Removes all fields with the given name from the document. If there is no field with the specified name, the document remains unchanged.

toString

open override fun toString(): String

Prints the fields of a document for human consumption.