org.teiid.connector.api
Interface ConnectorCapabilities

All Known Implementing Classes:
AccessCapabilities, BasicConnectorCapabilities, DB2Capabilities, DerbyCapabilities, InformixCapabilities, JDBCCapabilities, JMSCapabilities, LDAPConnectorCapabilities, LoopbackCapabilities, MMCapabilities, MySQLCapabilities, ObjectConnectorCapabilities, OracleCapabilities, OracleSpatialCapabilities, PostgreSQLCapabilities, SalesforceCapabilities, SequeLinkOracleCapabilities, SimpleCapabilities, SqlServerCapabilities, SybaseCapabilities, TeradataCapabilities, TextCapabilities, XMLCapabilities, XMLSourceCapabilities

public interface ConnectorCapabilities

Allows a connector to specify the capabilities that a connector supports.


Method Summary
 int getMaxFromGroups()
          The number of groups supported in the from clause.
 int getMaxInCriteriaSize()
          Get the integer value representing the number of values allowed in an IN criteria in the WHERE clause of a query
 java.util.List<java.lang.String> getSupportedFunctions()
          Get list of all supported function names.
 boolean requiresCriteria()
          Whether the source supports queries without criteria.
 boolean supportsAggregates()
          Support indicates connector accepts GROUP BY and HAVING clauses as well as aggregate functions in the SELECT clause.
 boolean supportsAggregatesAvg()
          Support indicates connector can accept the AVG aggregate function
 boolean supportsAggregatesCount()
          Support indicates connector can accept the COUNT aggregate function
 boolean supportsAggregatesCountStar()
          Support indicates connector can accept the COUNT(*) aggregate function
 boolean supportsAggregatesDistinct()
          Support indicates connector can accept DISTINCT within aggregate functions
 boolean supportsAggregatesMax()
          Support indicates connector can accept the MAX aggregate function
 boolean supportsAggregatesMin()
          Support indicates connector can accept the MIN aggregate function
 boolean supportsAggregatesSum()
          Support indicates connector can accept the SUM aggregate function
 boolean supportsAliasedGroup()
          Support indicates connector can accept groups with aliases
 boolean supportsAndCriteria()
          Support indicates connector accepts logical criteria connected by AND
 boolean supportsBatchedUpdates()
          Whether the source supports IBatchedUpdates
 boolean supportsBetweenCriteria()
          Support indicates connector accepts criteria of form (element BETWEEN constant AND constant)
 boolean supportsBulkInsert()
          Whether the source supports IBulkInsert
 boolean supportsCaseExpressions()
          Support indicates connector can accept queries with non-searched CASE WHEN ...
 boolean supportsCompareCriteria()
          Support indicates connector accepts criteria of form (element operator constant)
 boolean supportsCompareCriteriaEquals()
          Support indicates connector accepts criteria of form (element = constant)
 boolean supportsCompareCriteriaGreaterThan()
          Support indicates connector accepts criteria of form (element > constant)
 boolean supportsCompareCriteriaGreaterThanOrEqual()
          Support indicates connector accepts criteria of form (element >= constant)
 boolean supportsCompareCriteriaLessThan()
          Support indicates connector accepts criteria of form (element < constant)
 boolean supportsCompareCriteriaLessThanOrEqual()
          Support indicates connector accepts criteria of form (element <= constant)
 boolean supportsCompareCriteriaNotEquals()
          Support indicates connector accepts criteria of form (element <> constant)
 boolean supportsCorrelatedSubqueries()
          Support indicates connector can accept correalted subqueries wherever subqueries are accepted
 boolean supportsCriteria()
          Support indicates connector can accept a WHERE criteria on queries
 boolean supportsExcept()
          Support indicates that the connector supports the EXCEPT of two queries.
 boolean supportsExistsCriteria()
          Support indicates connector accepts the EXISTS criteria
 boolean supportsFullOuterJoins()
          Support indicates connector can accept full outer joins
 boolean supportsFunctionsInGroupBy()
          Support indicates that the connector supports functions in GROUP BY, such as: SELECT dayofmonth(theDate), COUNT(*) FROM table GROUP BY dayofmonth(theDate)
 boolean supportsInCriteria()
          Support indicates connector accepts criteria of form (element IN set)
 boolean supportsInCriteriaSubquery()
          Support indicates connector accepts IN criteria with a subquery on the right side
 boolean supportsInlineViews()
          Support indicates connector can accept inline views (subqueries in the FROM clause).
 boolean supportsIntersect()
          Support indicates that the connector supports the INTERSECT of two queries.
 boolean supportsIsNullCriteria()
          Support indicates connector accepts criteria of form (element IS NULL)
 boolean supportsJoins()
          Support indicates connector can accept joins
 boolean supportsLikeCriteria()
          Support indicates connector accepts criteria of form (element LIKE constant)
 boolean supportsLikeCriteriaEscapeCharacter()
          Support indicates connector accepts criteria of form (element LIKE constant ESCAPE char) - CURRENTLY NOT USED
 boolean supportsNotCriteria()
          Support indicates connector accepts logical criteria NOT
 boolean supportsOrCriteria()
          Support indicates connector accepts logical criteria connected by OR
 boolean supportsOrderBy()
          Support indicates connector accepts ORDER BY clause, including multiple elements and ascending and descending sorts.
 boolean supportsOuterJoins()
          Support indicates connector can accept right or left outer joins
 boolean supportsQuantifiedCompareCriteria()
          Support indicates connector accepts quantified subquery comparison criteria
 boolean supportsQuantifiedCompareCriteriaAll()
          Support indicates connector accepts the quantified comparison criteria that use ALL
 boolean supportsQuantifiedCompareCriteriaSome()
          Support indicates connector accepts the quantified comparison criteria that use SOME
 boolean supportsRowLimit()
          Gets whether the connector can limit the number of rows returned by a query.
 boolean supportsRowOffset()
          Gets whether the connector supports a SQL clause (similar to the LIMIT with an offset) that can return result sets that start in the middle of the resulting rows returned by a query
 boolean supportsScalarFunctions()
          Support indicates that the connector supports scalar functions.
 boolean supportsScalarSubqueries()
          Support indicates connector can accept scalar subqueries in the SELECT, WHERE, and HAVING clauses
 boolean supportsSearchedCaseExpressions()
          Support indicates connector can accept queries with searched CASE WHEN ...
 boolean supportsSelectDistinct()
          Support indicates connector can accept queries with SELECT DISTINCT
 boolean supportsSelectLiterals()
          Support indicates connector can accept literals in the SELECT clause
 boolean supportsSelfJoins()
          Support indicates connector can accept self-joins where a group is joined to itself with aliases.
 boolean supportsSetQueryOrderBy()
          Support indicates that the connector supports an ORDER BY on a SetQuery.
 boolean supportsUnions()
          Support indicates that the connector supports the UNION of two queries.
 boolean useAnsiJoin()
          Whether the source prefers to use ANSI style joins.
 

Method Detail

supportsSelectDistinct

boolean supportsSelectDistinct()
Support indicates connector can accept queries with SELECT DISTINCT

Since:
3.1 SP2

supportsSelectLiterals

boolean supportsSelectLiterals()
Support indicates connector can accept literals in the SELECT clause

Since:
4.1.2

supportsAliasedGroup

boolean supportsAliasedGroup()
Support indicates connector can accept groups with aliases

Since:
3.1 SP2

supportsJoins

boolean supportsJoins()
Support indicates connector can accept joins

Since:
3.1 SP2

supportsSelfJoins

boolean supportsSelfJoins()
Support indicates connector can accept self-joins where a group is joined to itself with aliases. Connector must also support supportsAliasedGroup().

Since:
3.1 SP2

supportsOuterJoins

boolean supportsOuterJoins()
Support indicates connector can accept right or left outer joins

Since:
3.1 SP2

supportsFullOuterJoins

boolean supportsFullOuterJoins()
Support indicates connector can accept full outer joins

Since:
3.1 SP2

supportsInlineViews

boolean supportsInlineViews()
Support indicates connector can accept inline views (subqueries in the FROM clause).

Since:
4.1

supportsCriteria

boolean supportsCriteria()
Support indicates connector can accept a WHERE criteria on queries

Since:
3.1 SP2

supportsBetweenCriteria

boolean supportsBetweenCriteria()
Support indicates connector accepts criteria of form (element BETWEEN constant AND constant)

Since:
4.0

supportsCompareCriteria

boolean supportsCompareCriteria()
Support indicates connector accepts criteria of form (element operator constant)

Since:
3.1 SP2

supportsCompareCriteriaEquals

boolean supportsCompareCriteriaEquals()
Support indicates connector accepts criteria of form (element = constant)

Since:
3.1 SP2

supportsCompareCriteriaNotEquals

boolean supportsCompareCriteriaNotEquals()
Support indicates connector accepts criteria of form (element <> constant)

Since:
3.1 SP2

supportsCompareCriteriaLessThan

boolean supportsCompareCriteriaLessThan()
Support indicates connector accepts criteria of form (element < constant)

Since:
3.1 SP2

supportsCompareCriteriaLessThanOrEqual

boolean supportsCompareCriteriaLessThanOrEqual()
Support indicates connector accepts criteria of form (element <= constant)

Since:
3.1 SP2

supportsCompareCriteriaGreaterThan

boolean supportsCompareCriteriaGreaterThan()
Support indicates connector accepts criteria of form (element > constant)

Since:
3.1 SP2

supportsCompareCriteriaGreaterThanOrEqual

boolean supportsCompareCriteriaGreaterThanOrEqual()
Support indicates connector accepts criteria of form (element >= constant)

Since:
3.1 SP2

supportsLikeCriteria

boolean supportsLikeCriteria()
Support indicates connector accepts criteria of form (element LIKE constant)

Since:
3.1 SP2

supportsLikeCriteriaEscapeCharacter

boolean supportsLikeCriteriaEscapeCharacter()
Support indicates connector accepts criteria of form (element LIKE constant ESCAPE char) - CURRENTLY NOT USED

Since:
3.1 SP2

supportsInCriteria

boolean supportsInCriteria()
Support indicates connector accepts criteria of form (element IN set)

Since:
3.1 SP2

supportsInCriteriaSubquery

boolean supportsInCriteriaSubquery()
Support indicates connector accepts IN criteria with a subquery on the right side

Since:
4.0

supportsIsNullCriteria

boolean supportsIsNullCriteria()
Support indicates connector accepts criteria of form (element IS NULL)

Since:
3.1 SP2

supportsAndCriteria

boolean supportsAndCriteria()
Support indicates connector accepts logical criteria connected by AND

Since:
3.1 SP2

supportsOrCriteria

boolean supportsOrCriteria()
Support indicates connector accepts logical criteria connected by OR

Since:
3.1 SP2

supportsNotCriteria

boolean supportsNotCriteria()
Support indicates connector accepts logical criteria NOT

Since:
3.1 SP2

supportsExistsCriteria

boolean supportsExistsCriteria()
Support indicates connector accepts the EXISTS criteria

Since:
4.0

supportsQuantifiedCompareCriteria

boolean supportsQuantifiedCompareCriteria()
Support indicates connector accepts quantified subquery comparison criteria

Since:
4.0

supportsQuantifiedCompareCriteriaSome

boolean supportsQuantifiedCompareCriteriaSome()
Support indicates connector accepts the quantified comparison criteria that use SOME

Since:
4.0

supportsQuantifiedCompareCriteriaAll

boolean supportsQuantifiedCompareCriteriaAll()
Support indicates connector accepts the quantified comparison criteria that use ALL

Since:
4.0

supportsOrderBy

boolean supportsOrderBy()
Support indicates connector accepts ORDER BY clause, including multiple elements and ascending and descending sorts.

Since:
3.1 SP2

supportsAggregates

boolean supportsAggregates()
Support indicates connector accepts GROUP BY and HAVING clauses as well as aggregate functions in the SELECT clause.

Since:
3.1 SP2

supportsAggregatesSum

boolean supportsAggregatesSum()
Support indicates connector can accept the SUM aggregate function

Since:
3.1 SP2

supportsAggregatesAvg

boolean supportsAggregatesAvg()
Support indicates connector can accept the AVG aggregate function

Since:
3.1 SP2

supportsAggregatesMin

boolean supportsAggregatesMin()
Support indicates connector can accept the MIN aggregate function

Since:
3.1 SP2

supportsAggregatesMax

boolean supportsAggregatesMax()
Support indicates connector can accept the MAX aggregate function

Since:
3.1 SP2

supportsAggregatesCount

boolean supportsAggregatesCount()
Support indicates connector can accept the COUNT aggregate function

Since:
3.1 SP2

supportsAggregatesCountStar

boolean supportsAggregatesCountStar()
Support indicates connector can accept the COUNT(*) aggregate function

Since:
3.1 SP2

supportsAggregatesDistinct

boolean supportsAggregatesDistinct()
Support indicates connector can accept DISTINCT within aggregate functions

Since:
3.1 SP2

supportsScalarSubqueries

boolean supportsScalarSubqueries()
Support indicates connector can accept scalar subqueries in the SELECT, WHERE, and HAVING clauses

Since:
4.0

supportsCorrelatedSubqueries

boolean supportsCorrelatedSubqueries()
Support indicates connector can accept correalted subqueries wherever subqueries are accepted

Since:
4.0

supportsCaseExpressions

boolean supportsCaseExpressions()
Support indicates connector can accept queries with non-searched CASE WHEN ... END

Since:
4.0

supportsSearchedCaseExpressions

boolean supportsSearchedCaseExpressions()
Support indicates connector can accept queries with searched CASE WHEN ... END

Since:
4.0

supportsScalarFunctions

boolean supportsScalarFunctions()
Support indicates that the connector supports scalar functions.

Since:
3.1 SP3

supportsUnions

boolean supportsUnions()
Support indicates that the connector supports the UNION of two queries.

Since:
4.2

supportsSetQueryOrderBy

boolean supportsSetQueryOrderBy()
Support indicates that the connector supports an ORDER BY on a SetQuery.

Since:
5.6

supportsIntersect

boolean supportsIntersect()
Support indicates that the connector supports the INTERSECT of two queries.

Since:
5.6

supportsExcept

boolean supportsExcept()
Support indicates that the connector supports the EXCEPT of two queries.

Since:
5.6

getSupportedFunctions

java.util.List<java.lang.String> getSupportedFunctions()
Get list of all supported function names. Arithmetic functions have names like "+".

Since:
3.1 SP3

getMaxInCriteriaSize

int getMaxInCriteriaSize()
Get the integer value representing the number of values allowed in an IN criteria in the WHERE clause of a query

Since:
5.0

supportsFunctionsInGroupBy

boolean supportsFunctionsInGroupBy()

Support indicates that the connector supports functions in GROUP BY, such as: SELECT dayofmonth(theDate), COUNT(*) FROM table GROUP BY dayofmonth(theDate)

This capability requires both supportsAggregates() and supportsScalarFunctions() to be true as well to take effective.

Since:
5.0

supportsRowLimit

boolean supportsRowLimit()
Gets whether the connector can limit the number of rows returned by a query.

Since:
5.0 SP1

supportsRowOffset

boolean supportsRowOffset()
Gets whether the connector supports a SQL clause (similar to the LIMIT with an offset) that can return result sets that start in the middle of the resulting rows returned by a query

Since:
5.0 SP1

getMaxFromGroups

int getMaxFromGroups()
The number of groups supported in the from clause. Added for a Sybase limitation.

Returns:
the number of groups supported in the from clause, or -1 if there is no limit
Since:
5.6

useAnsiJoin

boolean useAnsiJoin()
Whether the source prefers to use ANSI style joins.

Since:
6.0

requiresCriteria

boolean requiresCriteria()
Whether the source supports queries without criteria.

Since:
6.0

supportsBatchedUpdates

boolean supportsBatchedUpdates()
Whether the source supports IBatchedUpdates

Since:
6.0

supportsBulkInsert

boolean supportsBulkInsert()
Whether the source supports IBulkInsert

Since:
6.0


Copyright © 2009. All Rights Reserved.