org.jenkinsci.plugins.lucene.search

Class FreeTextSearchExtension

java.lang.Object

org.jenkinsci.plugins.lucene.search.FreeTextSearchExtension

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

JunitFreeTextSearchExtension

public abstract class FreeTextSearchExtension
extends Object
implements ExtensionPoint

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
FreeTextSearchExtension()

Method Summary

Modifier and Type	Method and Description
static ExtensionList<FreeTextSearchExtension>	all()
abstract String	getKeyword() Specifies the keyword that lucene stores the data as.
abstract String	getTextResult(Run<?,?> run) The text that will be searchable.
boolean	isDefaultSearchable() If this keyword should be included in the default list of fields to search through.
boolean	isPersist() If the original data should be stored in the index.

Methods inherited from class java.lang.Object

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

Constructor Detail

FreeTextSearchExtension

public FreeTextSearchExtension()

Method Detail

all

public static ExtensionList<FreeTextSearchExtension> all()

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.