com.intechcore.scomponents.scell.api.spreadsheet.service.search

Interface ISearchService

public interface ISearchService

Represents the search service

Method Summary

Modifier and Type	Method and Description
ISearchIterator	createSearchInWorkbookIterator(ISearchParams searchParams) Searches all occurrences of a pattern in the workbook and returns the iterator.
ISearchIterator	createSearchInWorkbookIterator(ISearchParams searchParams, int startWorksheetId, IRangeAddress startAddress) Searches all occurrences of a pattern in the workbook and returns the iterator.
ISearchIterator	createSearchInWorksheetIterator(ISearchParams searchParams, int worksheetId) Searches all occurrences of a pattern in the selected worksheet and returns the iterator.
ISearchIterator	createSearchInWorksheetIterator(ISearchParams searchParams, int worksheetId, IRangeAddress startAddress) Searches all occurrences of a pattern in the selected worksheet and returns the iterator.
ISearchParams.ISearchParamsBuilder	createSearchParamsBuilder() Creates the builder for the ISearchParams
Stream<ISearchResultItem>	search(ISearchParams searchParams) Searches all occurrences of a pattern in a workbook and returns a stream of the found elements.
Stream<ISearchResultItem>	search(ISearchParams searchParams, int worksheetId) Searches all occurrences of the pattern in the selected worksheet and returns the iterator It's unsafe to modify the cells of the worksheet during the process due to the nature of the streams

Method Detail

createSearchInWorkbookIterator

ISearchIterator createSearchInWorkbookIterator(ISearchParams searchParams)

Searches all occurrences of a pattern in the workbook and returns the iterator. It's unsafe to modify the cells during iteration.

To use the ISearchIterator replacement functionality the ISearchParams.SearchTarget is to be set to FORMULA.

Parameters:

searchParams - the search parameters

Returns:

the search iterator

See Also:

ISearchIterator.replace(String), ISearchIterator.replaceRemaining(String)

createSearchInWorkbookIterator

ISearchIterator createSearchInWorkbookIterator(ISearchParams searchParams,
                                               int startWorksheetId,
                                               IRangeAddress startAddress)

Searches all occurrences of a pattern in the workbook and returns the iterator. It's unsafe to modify the cells during iteration.

To use the ISearchIterator replacement functionality the ISearchParams.SearchTarget is to be set to FORMULA.

Parameters:

searchParams - the search parameters

startWorksheetId - the id of the worksheet where the search starts

startAddress - the address where the search starts

Returns:

the search iterator

See Also:

ISearchIterator.replace(String), ISearchIterator.replaceRemaining(String)

createSearchInWorksheetIterator

ISearchIterator createSearchInWorksheetIterator(ISearchParams searchParams,
                                                int worksheetId)

Searches all occurrences of a pattern in the selected worksheet and returns the iterator. It's unsafe to modify the cells of the worksheet during iteration.

Parameters:

searchParams - the search parameters

worksheetId - the id of the worksheet

Returns:

the search iterator

createSearchInWorksheetIterator

ISearchIterator createSearchInWorksheetIterator(ISearchParams searchParams,
                                                int worksheetId,
                                                IRangeAddress startAddress)

Searches all occurrences of a pattern in the selected worksheet and returns the iterator. It's unsafe to modify the cells of the worksheet during iteration.

Parameters:

searchParams - the search parameters

worksheetId - the id of the worksheet

startAddress - the address where the search starts

Returns:

the search iterator

search

Stream<ISearchResultItem> search(ISearchParams searchParams)

Searches all occurrences of a pattern in a workbook and returns a stream of the found elements. It's unsafe to modify the cells during the process due to the nature of the streams

Parameters:

searchParams - the search parameters

Returns:

the stream of found elements

search

Stream<ISearchResultItem> search(ISearchParams searchParams,
                                 int worksheetId)

Searches all occurrences of the pattern in the selected worksheet and returns the iterator It's unsafe to modify the cells of the worksheet during the process due to the nature of the streams

Parameters:

searchParams - the search parameters

worksheetId - the id of the worksheet

Returns:

the stream of the found elements

createSearchParamsBuilder

ISearchParams.ISearchParamsBuilder createSearchParamsBuilder()

Creates the builder for the ISearchParams

Returns:

the builder