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()
QueryEngine	getQueryEngine(PluginConfiguration pluginConfiguration)

Methods inherited from interface org.bimserver.plugins.Plugin

getDefaultName, getDescription, getSettingsDefinition, getVersion, init, isInitialized

Method Detail

getQueryEngine

QueryEngine getQueryEngine(PluginConfiguration pluginConfiguration)

Returns:

A usable QueryEngine implementation

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