Module Simantics/Search

This module is undocumented. This is a list of its definitions.

createSearchQuery :: String -> SearchQuery

A search query for the given query text, with no flags set. The search functions fill in the flags they need.

getPossibleResourceDB :: NamedResource -> Maybe Resource

The resource behind a search result entry, or Nothing if the entry does not carry one.

getResource :: NameAndTypeRow -> NamedResource

The resource the search result row matched.

getResourceDB :: NamedResource -> Resource

The resource behind a search result entry. Fails if the entry does not carry one.

searchNameAndType :: SearchQuery -> Integer -> <ReadGraph> [NameAndTypeRow]

searchNameAndType query maxResults searches the models that are currently active in the project for resources whose name or type matches the query, and returns at most maxResults rows. The search engines enabled by default are used unless the query names engines itself. An empty list comes back if there is no open project.

searchNameAndTypeScoped :: [Resource] -> SearchQuery -> Integer -> <ReadGraph> [NameAndTypeRow]

As searchNameAndType, but searches the given index roots instead of the active models.