Package com.inductiveautomation.ignition.gateway.web.search

Interface QueryContext

public interface QueryContext

Method Summary

Modifier and Type	Method	Description
default GatewayContext	getGatewayContext()
RequestContext	getRequestContext()
Optional<Integer>	matches(String string)
default Stream<ItemResult>	matchItemName(String name)	Intended for use by ItemSearchDelegate implementations to match item names.

Method Details

getRequestContext

RequestContext getRequestContext()

getGatewayContext

default GatewayContext getGatewayContext()

matches

Optional<Integer> matches(String string)

Returns:

relative match strength score (higher is better) or empty if not a match

matchItemName

default Stream<ItemResult> matchItemName(String name)

Intended for use by ItemSearchDelegate implementations to match item names. Example:

     public Stream<ItemResult> search(QueryContext context) {
         return getItemNames(context).stream().flatMap(context::matchItemName);
     }
 

Parameters:

name - the name of the item to match

Returns:

a stream of zero or one ItemResult