Interface IndexableField

    • Method Detail

      • name

        String name()
        Field name
      • tokenStream

        TokenStream tokenStream​(Analyzer analyzer,
                                TokenStream reuse)
        Creates the TokenStream used for indexing this field. If appropriate, implementations should use the given Analyzer to create the TokenStreams.
        analyzer - Analyzer that should be used to create the TokenStreams from
        reuse - TokenStream for a previous instance of this field name. This allows custom field types (like StringField and NumericField) that do not use the analyzer to still have good performance. Note: the passed-in type may be inappropriate, for example if you mix up different types of Fields for the same field name. So it's the responsibility of the implementation to check.
        TokenStream value for indexing the document. Should always return a non-null value if the field is to be indexed
      • binaryValue

        BytesRef binaryValue()
        Non-null if this field has a binary value
      • stringValue

        String stringValue()
        Non-null if this field has a string value
      • getCharSequenceValue

        default CharSequence getCharSequenceValue()
        Non-null if this field has a string value
      • readerValue

        Reader readerValue()
        Non-null if this field has a Reader value
      • numericValue

        Number numericValue()
        Non-null if this field has a numeric value