com.metamatrix.query.optimizer.capabilities
Class BasicSourceCapabilities

java.lang.Object
  com.metamatrix.query.optimizer.capabilities.BasicSourceCapabilities

All Implemented Interfaces:

SourceCapabilities, java.io.Serializable

public class BasicSourceCapabilities
extends java.lang.Object
implements SourceCapabilities, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.metamatrix.query.optimizer.capabilities.SourceCapabilities

SourceCapabilities.Capability, SourceCapabilities.Scope

Constructor Summary

BasicSourceCapabilities()
Construct a basic capabilities object.

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
void	setCapabilitySupport(SourceCapabilities.Capability capability, boolean supports)
void	setFunctionSupport(java.lang.String function, boolean supports)
void	setScope(SourceCapabilities.Scope scope)
void	setSourceProperty(SourceCapabilities.Capability propertyName, java.lang.Object value) This method adds the Source Property to the Property Map
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicSourceCapabilities

public BasicSourceCapabilities()

Construct a basic capabilities object.

Method Detail

supportsCapability

public boolean supportsCapability(SourceCapabilities.Capability capability)

Description copied from interface: SourceCapabilities

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

Specified by:

supportsCapability in interface SourceCapabilities

Parameters:

capability - Name of capability

Returns:

True if supported, false otherwise

See Also:

com.metamatrix.server.datatier.ConnectorCapabilities#supportsCapability(java.lang.String)

supportsFunction

public boolean supportsFunction(java.lang.String functionName)

Description copied from interface: SourceCapabilities

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.

Specified by:

supportsFunction in interface SourceCapabilities

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.

See Also:

com.metamatrix.server.datatier.ConnectorCapabilities#supportsFunction(java.lang.String)

setCapabilitySupport

public void setCapabilitySupport(SourceCapabilities.Capability capability,
                                 boolean supports)

setFunctionSupport

public void setFunctionSupport(java.lang.String function,
                               boolean supports)

getScope

public SourceCapabilities.Scope getScope()

Description copied from interface: SourceCapabilities

Determine the scope of these capabilities.

Specified by:

getScope in interface SourceCapabilities

setScope

public void setScope(SourceCapabilities.Scope scope)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setSourceProperty

public void setSourceProperty(SourceCapabilities.Capability propertyName,
                              java.lang.Object value)

This method adds the Source Property to the Property Map

Parameters:

propertyName -

value -

Since:

4.4

getSourceProperty

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

Description copied from interface: SourceCapabilities

This method returns an Object corresponding to the Source Property

Specified by:

getSourceProperty in interface SourceCapabilities

Since:

4.2

See Also:

com.metamatrix.query.optimizer.capabilities.SourceCapabilities#getSourceProperty(java.lang.String)