Package org.jenkinsci.plugins.lucene.search.extensionimplementations

Class JunitFreeTextSearchExtension

java.lang.Object

org.jenkinsci.plugins.lucene.search.FreeTextSearchExtension

org.jenkinsci.plugins.lucene.search.extensionimplementations.JunitFreeTextSearchExtension

All Implemented Interfaces:

ExtensionPoint

@Extension
public class JunitFreeTextSearchExtension
extends FreeTextSearchExtension

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
JunitFreeTextSearchExtension()

Method Summary

Modifier and Type	Method	Description
String	getKeyword()	Specifies the keyword that lucene stores the data as.
String	getTextResult(Run<?,?> run)	The text that will be searchable.
boolean	isPersist()	If the original data should be stored in the index.

Methods inherited from class org.jenkinsci.plugins.lucene.search.FreeTextSearchExtension

all, isDefaultSearchable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JunitFreeTextSearchExtension

public JunitFreeTextSearchExtension()

Method Details

getKeyword

public String getKeyword()

Description copied from class: FreeTextSearchExtension

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.

Specified by:

getKeyword in class FreeTextSearchExtension

Returns:

the keyword, the word must be lower case

getTextResult

public String getTextResult(Run<?,?> run)

Description copied from class: FreeTextSearchExtension

The text that will be searchable.

Specified by:

getTextResult in class FreeTextSearchExtension

isPersist

public boolean isPersist()

Description copied from class: FreeTextSearchExtension

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.

Overrides:

isPersist in class FreeTextSearchExtension