Class FreeTextSearchExtension

    • Constructor Detail

      • FreeTextSearchExtension

        public FreeTextSearchExtension()
    • Method Detail

      • getKeyword

        public abstract String getKeyword()
        Specifies the keyword that lucene stores the data as. This keyword is the same as the user can use to search for. E.g. with keyword = "foo", the following query "foo:bar" will look for "bar" in the textresult for this extension.

        Care must be taken to make sure this does not collide with any fieldName in Field.

        Returns:
        the keyword, the word must be lower case
      • getTextResult

        public abstract String getTextResult​(Run<?,​?> run)
        The text that will be searchable.
      • isPersist

        public boolean isPersist()
        If the original data should be stored in the index. This is necessary if the data should be displayed with context around the match in the search result.
      • isDefaultSearchable

        public boolean isDefaultSearchable()
        If this keyword should be included in the default list of fields to search through.