com.metamatrix.query.optimizer.capabilities
Interface SourceCapabilities

All Known Implementing Classes:

BasicSourceCapabilities

public interface SourceCapabilities

Nested Class Summary

static class	SourceCapabilities.Capability
static class	SourceCapabilities.Scope

Method Summary

SourceCapabilities.Scope	getScope() Determine the scope of these capabilities.
java.lang.Object	getSourceProperty(SourceCapabilities.Capability propertyName) This method returns an Object corresponding to the Source Property
boolean	supportsCapability(SourceCapabilities.Capability capability) Returns true if the capability is supported.
boolean	supportsFunction(java.lang.String functionName) This method can be used to check whether a particular function is supported by this connector.

Method Detail

getScope

SourceCapabilities.Scope getScope()

Determine the scope of these capabilities.

supportsCapability

boolean supportsCapability(SourceCapabilities.Capability capability)

Returns true if the capability is supported. The capability constants are all defined in this interface with the meaning of supporting that capability.

Parameters:

capability - Name of capability

Returns:

True if supported, false otherwise

supportsFunction

boolean supportsFunction(java.lang.String functionName)

This method can be used to check whether a particular function is supported by this connector. This method should only be used if the capability FUNCTION is true.

Parameters:

functionName - The function that may be supported (see MetaMatrix documentation for further definition of the functions and their parameters.)

Returns:

True if function is supported.

getSourceProperty

java.lang.Object getSourceProperty(SourceCapabilities.Capability propertyName)

This method returns an Object corresponding to the Source Property

Since:

4.4