Interface EngineCapabilities
- All Known Implementing Classes:
EngineCapabilitiesSnapshot
public interface EngineCapabilities
What a query engine supports, used to filter query options in the Designer and the
historian.query binding and to filter the aggregate catalog. Engines override
QueryEngine.capabilities(); the default is minimal(String). Implementations must be
immutable.-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final recordDetails of what each capability supports.static enumThe query features an engine can declare. -
Method Summary
Modifier and TypeMethodDescriptionReturns the declared capability flags; immutable, without nulls.details()Returns the details of what each capability supports.engineId()Returns the engine type identifier, such as"core"or"csv".static EngineCapabilitiesReturns capabilities declaring onlyEngineCapabilities.QueryCapability.NATIVE_RAWandEngineCapabilities.CapabilityDetails.MINIMAL; the default for engines that do not override.
-
Method Details
-
engineId
String engineId()Returns the engine type identifier, such as"core"or"csv". -
capabilities
Set<EngineCapabilities.QueryCapability> capabilities()Returns the declared capability flags; immutable, without nulls. -
details
EngineCapabilities.CapabilityDetails details()Returns the details of what each capability supports. -
minimal
Returns capabilities declaring onlyEngineCapabilities.QueryCapability.NATIVE_RAWandEngineCapabilities.CapabilityDetails.MINIMAL; the default for engines that do not override.- Parameters:
engineId- the engine type identifier.- Returns:
- the minimal capabilities.
-