Liking cljdoc? Tell your friends :D

lib.lucene.impl.document


+field-type+clj


+field-type-defaults+clj


+field-type-lu+clj


+field-type-rlu+clj


+getter-opts+clj


doc-values-typeclj

(doc-values-type s)

returns the doc values type enum

(doc-values-type "NONE") => org.apache.lucene.index.DocValuesType/NONE

returns the doc values type enum

(doc-values-type "NONE")
=> org.apache.lucene.index.DocValuesType/NONE
raw docstring

documentclj

(document {:keys [fields] :as m})

constructs a document

(document {:fields [{:name "hello" :value "world" :type {}}]})

constructs a document

(document {:fields [{:name "hello" :value "world" :type {}}]})
raw docstring

document-displayclj

(document-display m)

display function for document

display function for document
raw docstring

document-set-fieldsclj

(document-set-fields document fields)

setters for document fields

(-> (document {}) (document-set-fields [{:name "hello" :value "world" :type {}}]))

setters for document fields

(-> (document {})
    (document-set-fields [{:name "hello" :value "world" :type {}}]))
raw docstring

fieldclj

(field {:keys [name value type] :as m})

constructor for field

constructor for field
raw docstring

field-constructclj

(field-construct name value type)

constructs a field

(field-construct "hello" "world" {}) ;; #field{:name "hello", :type {:index [:freq :doc]}, :length 5} => org.apache.lucene.document.Field

constructs a field

(field-construct "hello" "world" {})
;; #field{:name "hello", :type {:index [:freq :doc]}, :length 5}
=> org.apache.lucene.document.Field
raw docstring

field-displayclj

(field-display m)

displays the field

displays the field
raw docstring

field-typeclj

(field-type {:keys [tokenized stored omit-norms doc-values-type] :as m})

constructs a field type

(field-type {:tokenized false :index #{}}) ;; #field.type{:tokenized false, :index []} => org.apache.lucene.document.FieldType

constructs a field type

(field-type {:tokenized false :index #{}})
;; #field.type{:tokenized false, :index []}
=> org.apache.lucene.document.FieldType
raw docstring

field-type-displayclj

(field-type-display m)

returns field types that are not defaults

(field-type-display {:tokenized false :stored true}) => (contains {:tokenized false})

returns field types that are not defaults

(field-type-display {:tokenized false
                     :stored true})
=> (contains {:tokenized false})
raw docstring

field-type-get-indexclj

(field-type-get-index ft)

gets the field type index value

(field-type-get-index (field-type {})) => #{:freq :doc}

gets the field type index value

(field-type-get-index (field-type {}))
=> #{:freq :doc}
raw docstring

field-type-set-indexclj

(field-type-set-index ft value)

sets the field type index value

(field-type-set-index (field-type {}) #{:doc})

sets the field type index value

(field-type-set-index (field-type {}) #{:doc})
raw docstring

field-valueclj

(field-value field value)

setter for field value (-> (field-value (field-construct "hello" "" {}) "world") (.stringValue)) => "world"

setter for field value
(-> (field-value (field-construct "hello" "" {})
                 "world")
    (.stringValue))
=> "world"
raw docstring

from-mapclj

(from-map m)
(from-map m template)

turns a map into a document

(from-map {:hello "world"} nil) => org.apache.lucene.document.Document

turns a map into a document

(from-map {:hello "world"} nil)
=> org.apache.lucene.document.Document
raw docstring

to-mapclj

(to-map document)

turns the document into a map

(-> (document {:fields [{:name "hello" :value "world" :type {}}]}) to-map) => {:hello "world"}

turns the document into a map

(-> (document {:fields [{:name "hello" :value "world" :type {}}]})
    to-map)
=> {:hello "world"}
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close