Class TextField

  • All Implemented Interfaces:
    IndexableField

    public final class TextField
    extends Field
    A field that is indexed and tokenized, without term vectors. For example this would be used on a 'body' field, that contains the bulk of a document's text.
    • Field Detail

      • TYPE_NOT_STORED

        public static final FieldType TYPE_NOT_STORED
        Indexed, tokenized, not stored.
      • TYPE_STORED

        public static final FieldType TYPE_STORED
        Indexed, tokenized, stored.
    • Constructor Detail

      • TextField

        public TextField​(java.lang.String name,
                         java.io.Reader reader)
        Creates a new un-stored TextField with Reader value.
        Parameters:
        name - field name
        reader - reader value
        Throws:
        java.lang.IllegalArgumentException - if the field name is null
        java.lang.NullPointerException - if the reader is null
      • TextField

        public TextField​(java.lang.String name,
                         java.lang.String value,
                         Field.Store store)
        Creates a new TextField with String value.
        Parameters:
        name - field name
        value - string value
        store - Store.YES if the content should also be stored
        Throws:
        java.lang.IllegalArgumentException - if the field name or value is null.
      • TextField

        public TextField​(java.lang.String name,
                         TokenStream stream)
        Creates a new un-stored TextField with TokenStream value.
        Parameters:
        name - field name
        stream - TokenStream value
        Throws:
        java.lang.IllegalArgumentException - if the field name is null.
        java.lang.NullPointerException - if the tokenStream is null