org.bimserver.plugins.queryengine

Interface QueryEnginePlugin

All Superinterfaces:

Plugin

public interface QueryEnginePlugin
extends Plugin

Method Summary

Modifier and Type	Method and Description
String	getExample(String key)
Collection<String>	getExampleKeys()
default SPluginType	getPluginType()
QueryEngine	getQueryEngine(PluginConfiguration pluginConfiguration)

Methods inherited from interface org.bimserver.plugins.Plugin

getSettingsDefinition, init

Method Detail

getQueryEngine

QueryEngine getQueryEngine(PluginConfiguration pluginConfiguration)
                    throws PluginException

Returns:

A usable QueryEngine implementation

Throws:

PluginException

getExampleKeys

Collection<String> getExampleKeys()

Returns:

Return a list of keys (usually file names) corresponding to code examples for this plugin

getExample

String getExample(String key)

Parameters:

key -

Returns:

Return the code example for the given key

getPluginType

default SPluginType getPluginType()

Specified by:

getPluginType in interface Plugin

Returns:

Returns the type of plugin, should be implemented by all underlying interfaces, and not by the actual plugins