java.lang.Object
- lumis.search.SearchHit

```
@Deprecated
@StableMinor(version="17.0",
             sinceVersion="4.0")
public abstract class SearchHit
extends java.lang.Object
```
Deprecated.
Since 8.1.0, lumis.search was replaced by lumis.portal.bigdata.
An item of a SearchResults object. It represents an indexed information that match a query that was executed.
A SearchHit object returns some of the predefined fields (Title, Subtitle, URL) of the original indexed information, and the following additional fields:
- Snippet: A snippet of the matched information. For example, a set of sample text intervals that contain the given searched keywords. It can be used to help the user to identify the relevance of the hit in comparison to other search result items;
- Rank: A float number that indicates the relevante of the matched information. It can be used to compare the relevance of different hits.
Since:

4.0.4

Version:

$Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $

Field Summary

Fields
Modifier and Type	Field	Description
`protected SearchAttributes`	`attributes`	Deprecated.
`protected float`	`rank`	Deprecated.
`protected java.lang.String`	`snippet`	Deprecated.
`protected java.lang.String`	`subtitle`	Deprecated.
`protected java.lang.String`	`title`	Deprecated.
`protected java.lang.String`	`url`	Deprecated.

Constructor Summary

Constructors
Constructor	Description
`SearchHit()`	Deprecated. Constructs an instance with null URL, title and subtitle predefined fields.
`SearchHit(java.lang.String url, java.lang.String title, java.lang.String subtitle)`	Deprecated. Constructs an instance with the given URL, title and subtitle predefined fields.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`SearchAttributes`	`getAttributes()`	Deprecated. Returns the hit's `attributes`.
`java.lang.String`	`getParentId()`	Deprecated. Returns the identifier of the parent of this hit.
`float`	`getRank()`	Deprecated. Returns the rank value.
`SearchContent`	`getSearchContent()`	Deprecated. Returns a `SearchContent` object related to the hit, containing all `fields`.
`java.lang.String`	`getSnippet()`	Deprecated. Returns the snippet value.
`java.lang.String`	`getSubtitle()`	Deprecated. Returns the subtitle field value.
`java.lang.String`	`getTitle()`	Deprecated. Returns the title field value.
`java.lang.String`	`getUrl()`	Deprecated. Returns the URL field value.
`void`	`setParentId(java.lang.String parentId)`	Deprecated. Sets the parent identifier of this hit.
`void`	`setRank(float rank)`	Deprecated. Sets the rank value.
`void`	`setSnippet(java.lang.String snippet)`	Deprecated. Sets the the snippet value.
`void`	`setSubtitle(java.lang.String subtitle)`	Deprecated. Sets the subtitle field value.
`void`	`setTitle(java.lang.String title)`	Deprecated. Sets the title field value.
`void`	`setUrl(java.lang.String url)`	Deprecated. Sets the URL field value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - url
```
protected java.lang.String url
```
    Deprecated.
  - title
```
protected java.lang.String title
```
    Deprecated.
  - subtitle
```
protected java.lang.String subtitle
```
    Deprecated.
  - snippet
```
protected java.lang.String snippet
```
    Deprecated.
  - rank
```
protected float rank
```
    Deprecated.
  - attributes
```
protected SearchAttributes attributes
```
    Deprecated.
- Constructor Detail
  - SearchHit
```
public SearchHit()
```
    Deprecated.
    
    Constructs an instance with null URL, title and subtitle predefined fields.
    
    Since:
    
    4.0.4
    
    See Also:
    
    SearchContentField.FIELDNAME_URL, SearchContentField.FIELDNAME_TITLE, SearchContentField.FIELDNAME_SUBTITLE
  - SearchHit
```
public SearchHit(java.lang.String url,
                 java.lang.String title,
                 java.lang.String subtitle)
```
    Deprecated.
    
    Constructs an instance with the given URL, title and subtitle predefined fields.
    
    Parameters:
    
    url - URL field value
    
    title - title field
    
    subtitle - subtitle field
    
    Since:
    
    4.0.4
    
    See Also:
    
    SearchContentField.FIELDNAME_URL, SearchContentField.FIELDNAME_TITLE, SearchContentField.FIELDNAME_SUBTITLE
- Method Detail
  - getUrl
```
public java.lang.String getUrl()
```
    Deprecated.
    
    Returns the URL field value.
    
    Returns:
    
    URL field value
    
    Since:
    
    4.0.4
    
    See Also:
    
    SearchContentField.FIELDNAME_URL
  - setUrl
```
public void setUrl(java.lang.String url)
```
    Deprecated.
    
    Sets the URL field value.
    
    Parameters:
    
    url - URL field value
    
    Since:
    
    4.0.4
    
    See Also:
    
    SearchContentField.FIELDNAME_URL
  - getTitle
```
public java.lang.String getTitle()
```
    Deprecated.
    
    Returns the title field value.
    
    Returns:
    
    title field value
    
    Since:
    
    4.0.4
    
    See Also:
    
    SearchContentField.FIELDNAME_TITLE
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Deprecated.
    
    Sets the title field value.
    
    Parameters:
    
    title - title field value
    
    Since:
    
    4.0.4
    
    See Also:
    
    SearchContentField.FIELDNAME_TITLE
  - getSubtitle
```
public java.lang.String getSubtitle()
```
    Deprecated.
    
    Returns the subtitle field value.
    
    Returns:
    
    subtitle field value
    
    Since:
    
    4.0.4
    
    See Also:
    
    SearchContentField.FIELDNAME_SUBTITLE
  - setSubtitle
```
public void setSubtitle(java.lang.String subtitle)
```
    Deprecated.
    
    Sets the subtitle field value.
    
    Parameters:
    
    subtitle - subtitle field value
    
    Since:
    
    4.0.4
    
    See Also:
    
    SearchContentField.FIELDNAME_SUBTITLE
  - getRank
```
public float getRank()
```
    Deprecated.
    
    Returns the rank value.
    
    Returns:
    
    the rank value
    
    Since:
    
    4.0.4
  - setRank
```
public void setRank(float rank)
```
    Deprecated.
    
    Sets the rank value.
    
    Parameters:
    
    rank - rank value
    
    Since:
    
    4.0.4
  - getSnippet
```
public java.lang.String getSnippet()
```
    Deprecated.
    
    Returns the snippet value.
    
    Returns:
    
    the snippet value
    
    Since:
    
    4.0.4
  - setSnippet
```
public void setSnippet(java.lang.String snippet)
```
    Deprecated.
    
    Sets the the snippet value.
    
    Parameters:
    
    snippet - snippet value
    
    Since:
    
    4.0.4
  - getParentId
```
public java.lang.String getParentId()
```
    Deprecated.
    
    Returns the identifier of the parent of this hit. When a SearchContent is indexed, the indexer may divide it into multiple entries. In this case a primary one should be set as the parent of the others.
    
    Returns:
    
    the identifier of the parent search content, or null if this is a primary hit.
    
    Since:
    
    4.2.2
  - setParentId
```
public void setParentId(java.lang.String parentId)
```
    Deprecated.
    
    Sets the parent identifier of this hit.
    
    Parameters:
    
    parentId - the parent identifier to set.
    
    Since:
    
    4.2.2
    
    See Also:
    
    getParentId()
  - getAttributes
```
public SearchAttributes getAttributes()
```
    Deprecated.
    
    Returns the hit's attributes.
    Attributes contain additional information returned by the search engine in a query execution.
    
    Returns:
    
    hit's attributes
    
    Since:
    
    4.0.4
  - getSearchContent
```
public SearchContent getSearchContent()
                               throws UnsupportedOperationException
```
    Deprecated.
    
    Returns a SearchContent object related to the hit, containing all fields.
    Implementations that do not support this operation will throw an UnsupportedOperationException.
    
    Returns:
    
    SearchContent object related to the hit.
    
    Throws:
    
    UnsupportedOperationException
    
    Since:
    
    4.0.4

Class SearchHit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

url

title

subtitle

snippet

rank

attributes

Constructor Detail

SearchHit

SearchHit

Method Detail

getUrl

setUrl

getTitle

setTitle

getSubtitle

setSubtitle

getRank

setRank

getSnippet

setSnippet

getParentId

setParentId

getAttributes

getSearchContent