hudson.search

Class SuggestedItem

java.lang.Object

hudson.search.SuggestedItem

public class SuggestedItem
extends Object

One item of a search result.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
SearchItem	item

Constructor Summary

Constructors

Constructor and Description
SuggestedItem(SearchItem top)
SuggestedItem(SuggestedItem parent, SearchItem item)

Method Summary

Modifier and Type	Method and Description
static SuggestedItem	build(SearchableModelObject searchContext, SearchItem si) Given a SearchItem, builds a SuggestedItem hierarchy by looking up parent items (if applicable).
String	getPath()
String	getUrl() Gets the URL to this item.

Methods inherited from class java.lang.Object

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

Field Detail

item

public final SearchItem item

Constructor Detail

SuggestedItem

public SuggestedItem(SearchItem top)

SuggestedItem

public SuggestedItem(SuggestedItem parent,
                     SearchItem item)

Method Detail

getPath

public String getPath()

getUrl

public String getUrl()

Gets the URL to this item.

Returns:

URL that starts with '/' but doesn't end with '/'. The path is the combined path from the SearchIndex where the search started to the final item found. Thus to convert to the actual URL, the caller would need to prepend the URL of the object where the search started.

build

public static SuggestedItem build(SearchableModelObject searchContext,
                                  SearchItem si)

Given a SearchItem, builds a SuggestedItem hierarchy by looking up parent items (if applicable). This allows search results for items not contained within the same ItemGroup to be distinguished. If provided searchContext is null, results will be interpreted from the root Jenkins object

Since:

1.527