Package com.complexible.stardog.api.search

# Class SearchResults

java.lang.Object
com.complexible.stardog.api.search.SearchResults

All Implemented Interfaces:
  `Iterable<SearchResult>`

public final class SearchResults extends Object implements Iterable<SearchResult>
A wrapper around the search results that may additionally have suggestions for an alternative search string.

Since:
  0.6.5
Version:
  4.0
Author:
  Evren Sirin, Hector Perez-Urbina

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SearchResults(String searchString, CloseableIterator<SearchResult> results, List<String> suggestions, int offset)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getOffset()`
  Returns the offset for this slice of results.
  `String`
  `getSearchString()`
  Returns the search string that was used to create this result.
  `CloseableIterator<SearchResult>`
  `iterator()`

  ### Methods inherited from class java.lang.Object

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

  ### Methods inherited from interface java.lang.Iterable

  `forEach, spliterator`

- ## Constructor Details

  - ### SearchResults

    public SearchResults(String searchString, CloseableIterator<SearchResult> results, List<String> suggestions, int offset)

- ## Method Details

  - ### getOffset

    public int getOffset()
    Returns the offset for this slice of results.

  - ### getSearchString

    public String getSearchString()
    Returns the search string that was used to create this result.

  - ### iterator

    public CloseableIterator<SearchResult> iterator()
    Specified by:
      `iterator` in interface `Iterable<SearchResult>`