Package org.teiid.translator.odata

Class ODataExecutionFactory

java.lang.Object

org.teiid.translator.ExecutionFactory<ConnectionFactory,WSConnection>

org.teiid.translator.odata.ODataExecutionFactory

Direct Known Subclasses:

SAPODataExecutionFactory

@Translator(name="odata",
            description="A translator for making OData data service calls")
public class ODataExecutionFactory
extends ExecutionFactory<ConnectionFactory,WSConnection>

TODO: Type comparison isof(T), isof(x, T) Whether targeted instance can be converted to the specified type. media streams are generally not supported yet. (blobs, clobs)

Nested Class Summary

Nested classes/interfaces inherited from class org.teiid.translator.ExecutionFactory

ExecutionFactory.Format, ExecutionFactory.NullOrder, ExecutionFactory.SupportedJoinCriteria, ExecutionFactory.TransactionSupport

Field Summary

Fields

Modifier and Type	Field	Description
static TimeZone	DEFAULT_TIME_ZONE
protected Map<String,FunctionModifier>	functionModifiers

Fields inherited from class org.teiid.translator.ExecutionFactory

DEFAULT_MAX_FROM_GROUPS, DEFAULT_MAX_IN_CRITERIA_SIZE, DEFAULT_MAX_PROJECTED_COLUMNS

Constructor Summary

Constructors

Constructor	Description
ODataExecutionFactory()

Method Summary

Modifier and Type	Method	Description
void	convertToODataInput(Literal obj, StringBuilder sb)
ProcedureExecution	createProcedureExecution(Call command, ExecutionContext executionContext, RuntimeMetadata metadata, WSConnection connection)
ResultSetExecution	createResultSetExecution(QueryExpression command, ExecutionContext executionContext, RuntimeMetadata metadata, WSConnection connection)
UpdateExecution	createUpdateExecution(Command command, ExecutionContext executionContext, RuntimeMetadata metadata, WSConnection connection)
protected String	escapeString(String str, String quote)
String	getDatabaseTimeZone()
List<String>	getDefaultSupportedFunctions()
Map<String,FunctionModifier>	getFunctionModifiers()	Return a map of function name to FunctionModifier.
void	getMetadata(MetadataFactory metadataFactory, WSConnection conn)
MetadataProcessor<WSConnection>	getMetadataProcessor()
List<String>	getSupportedFunctions()
void	registerFunctionModifier(String name, FunctionModifier modifier)	Add the FunctionModifier to the set of known modifiers.
Object	retrieveValue(Object value, Class<?> expectedType)
void	setDatabaseTimeZone(String databaseTimeZone)
void	setSupportsOdataBooleanFunctionsWithComparison(boolean supports)
void	setSupportsOdataCount(boolean supports)
void	setSupportsOdataFilter(boolean supports)
void	setSupportsOdataOrderBy(boolean supports)
void	setSupportsOdataSkip(boolean supports)
void	setSupportsOdataTop(boolean supports)
void	start()
boolean	supportsAggregatesCount()
boolean	supportsAggregatesCountStar()
boolean	supportsCompareCriteriaEquals()
boolean	supportsCompareCriteriaOrdered()
boolean	supportsIsNullCriteria()
boolean	supportsNotCriteria()
boolean	supportsOdataBooleanFunctionsWithComparison()
boolean	supportsOdataCount()
boolean	supportsOdataFilter()
boolean	supportsOdataOrderBy()
boolean	supportsOdataSkip()
boolean	supportsOdataTop()
boolean	supportsOnlyLiteralComparison()
boolean	supportsOrCriteria()
boolean	supportsOrderBy()
boolean	supportsOrderByUnrelated()
boolean	supportsQuantifiedCompareCriteriaAll()
boolean	supportsQuantifiedCompareCriteriaSome()
boolean	supportsRowLimit()
boolean	supportsRowOffset()
boolean	useAnsiJoin()

Methods inherited from class org.teiid.translator.ExecutionFactory

addPushDownFunction, areLobsUsableAfterClose, closeConnection, createDirectExecution, createExecution, getCacheDirective, getCollationLocale, getConnection, getConnection, getDefaultNullOrder, getDirectQueryProcedureName, getExcludedCommonTableExpressionName, getInstance, getLanguageFactory, getMaxDependentInPredicates, getMaxFromGroups, getMaxInCriteriaSize, getMaxProjectedColumns, getNativeQueryProcedureName, getPushDownFunctions, getRequiredLikeEscape, getSupportedJoinCriteria, getTransactionSupport, getTypeFacility, initCapabilities, isCopyLobs, isForkable, isImmutable, isSourceRequired, isSourceRequiredForCapabilities, isSourceRequiredForMetadata, isThreadBound, requiresCriteria, returnsSingleUpdateCount, setCollationLocale, setCopyLobs, setDirectQueryProcedureName, setExcludedCommonTableExpressionName, setImmutable, setMaxDependentInPredicates, setMaxInCriteriaSize, setNativeQueryProcedureName, setRequiresCriteria, setSourceRequired, setSourceRequiredForMetadata, setSupportedJoinCriteria, setSupportsDirectQueryProcedure, setSupportsFullOuterJoins, setSupportsInnerJoins, setSupportsNativeQueries, setSupportsOrderBy, setSupportsOuterJoins, setSupportsSelectDistinct, setThreadBound, setTransactionSupport, supportsAdvancedOlapOperations, supportsAggregatesAvg, supportsAggregatesCountBig, supportsAggregatesDistinct, supportsAggregatesEnhancedNumeric, supportsAggregatesMax, supportsAggregatesMin, supportsAggregatesSum, supportsAliasedTable, supportsArrayAgg, supportsArrayType, supportsBatchedUpdates, supportsBulkUpdate, supportsCommonTableExpressions, supportsCompareCriteriaOrderedExclusive, supportsConvert, supportsCorrelatedSubqueries, supportsCorrelatedSubqueryLimit, supportsDependentJoins, supportsDirectQueryProcedure, supportsElementaryOlapOperations, supportsExcept, supportsExistsCriteria, supportsFormatLiteral, supportsFullDependentJoins, supportsFullOuterJoins, supportsFunctionsInGroupBy, supportsGeographyType, supportsGroupBy, supportsGroupByMultipleDistinctAggregates, supportsGroupByRollup, supportsHaving, supportsInCriteria, supportsInCriteriaSubquery, supportsInlineViews, supportsInnerJoins, supportsInsertWithQueryExpression, supportsIntersect, supportsIsDistinctCriteria, supportsLateralJoin, supportsLateralJoinCondition, supportsLikeCriteria, supportsLikeCriteriaEscapeCharacter, supportsLikeRegex, supportsListAgg, supportsMultipleOpenExecutions, supportsNativeQueries, supportsOnlyCorrelatedSubqueries, supportsOnlyFormatLiterals, supportsOnlyLateralJoinProcedure, supportsOnlyRelationshipStyleJoins, supportsOnlySingleTableGroupBy, supportsOnlyTimestampAddLiteral, supportsOrderByNullOrdering, supportsOrderByWithExtendedGrouping, supportsOuterJoins, supportsPartialFiltering, supportsProcedureParameterExpression, supportsProcedureTable, supportsRecursiveCommonTableExpressions, supportsScalarSubqueries, supportsScalarSubqueryProjection, supportsSearchedCaseExpressions, supportsSelectDistinct, supportsSelectExpression, supportsSelectExpressionArrayType, supportsSelectWithoutFrom, supportsSelfJoins, supportsSetQueryLimitOffset, supportsSetQueryOrderBy, supportsSimilarTo, supportsStringAgg, supportsSubqueryCommonTableExpressions, supportsSubqueryInOn, supportsUnions, supportsUpsert, supportsWindowDistinctAggregates, supportsWindowFrameClause, supportsWindowFunctionCumeDist, supportsWindowFunctionNthValue, supportsWindowFunctionNtile, supportsWindowFunctionPercentRank, supportsWindowOrderByWithAggregates, useBindingsForDependentJoin

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIME_ZONE

public static final TimeZone DEFAULT_TIME_ZONE

functionModifiers

protected Map<String,FunctionModifier> functionModifiers

Constructor Detail

ODataExecutionFactory

public ODataExecutionFactory()

Method Detail

start

public void start()
           throws TranslatorException

Overrides:

start in class ExecutionFactory<ConnectionFactory,WSConnection>

Throws:

TranslatorException

getDatabaseTimeZone

@TranslatorProperty(display="Database time zone",
                    description="Time zone of the database, if different than Integration Server",
                    advanced=true)
public String getDatabaseTimeZone()

setDatabaseTimeZone

public void setDatabaseTimeZone(String databaseTimeZone)

getMetadata

public void getMetadata(MetadataFactory metadataFactory,
                        WSConnection conn)
                 throws TranslatorException

Overrides:

getMetadata in class ExecutionFactory<ConnectionFactory,WSConnection>

Throws:

TranslatorException

getMetadataProcessor

public MetadataProcessor<WSConnection> getMetadataProcessor()

Overrides:

getMetadataProcessor in class ExecutionFactory<ConnectionFactory,WSConnection>

createResultSetExecution

public ResultSetExecution createResultSetExecution(QueryExpression command,
                                                   ExecutionContext executionContext,
                                                   RuntimeMetadata metadata,
                                                   WSConnection connection)
                                            throws TranslatorException

Overrides:

createResultSetExecution in class ExecutionFactory<ConnectionFactory,WSConnection>

Throws:

TranslatorException

createProcedureExecution

public ProcedureExecution createProcedureExecution(Call command,
                                                   ExecutionContext executionContext,
                                                   RuntimeMetadata metadata,
                                                   WSConnection connection)
                                            throws TranslatorException

Overrides:

createProcedureExecution in class ExecutionFactory<ConnectionFactory,WSConnection>

Throws:

TranslatorException

createUpdateExecution

public UpdateExecution createUpdateExecution(Command command,
                                             ExecutionContext executionContext,
                                             RuntimeMetadata metadata,
                                             WSConnection connection)
                                      throws TranslatorException

Overrides:

createUpdateExecution in class ExecutionFactory<ConnectionFactory,WSConnection>

Throws:

TranslatorException

getSupportedFunctions

public List<String> getSupportedFunctions()

Overrides:

getSupportedFunctions in class ExecutionFactory<ConnectionFactory,WSConnection>

getFunctionModifiers

public Map<String,FunctionModifier> getFunctionModifiers()

Return a map of function name to FunctionModifier.

Returns:

Map of function name to FunctionModifier.

registerFunctionModifier

public void registerFunctionModifier(String name,
                                     FunctionModifier modifier)

Add the FunctionModifier to the set of known modifiers.

Parameters:

name -

modifier -

getDefaultSupportedFunctions

public List<String> getDefaultSupportedFunctions()

supportsOdataFilter

@TranslatorProperty(display="Supports $Filter",
                    description="True, $filter is supported",
                    advanced=true)
public boolean supportsOdataFilter()

setSupportsOdataFilter

public void setSupportsOdataFilter(boolean supports)

supportsOdataOrderBy

@TranslatorProperty(display="Supports $OrderBy",
                    description="True, $orderby is supported",
                    advanced=true)
public boolean supportsOdataOrderBy()

setSupportsOdataOrderBy

public void setSupportsOdataOrderBy(boolean supports)

supportsOdataCount

@TranslatorProperty(display="Supports $count",
                    description="True, $count is supported",
                    advanced=true)
public boolean supportsOdataCount()

setSupportsOdataCount

public void setSupportsOdataCount(boolean supports)

supportsOdataSkip

@TranslatorProperty(display="Supports $skip",
                    description="True, $skip is supported",
                    advanced=true)
public boolean supportsOdataSkip()

setSupportsOdataSkip

public void setSupportsOdataSkip(boolean supports)

supportsOdataTop

@TranslatorProperty(display="Supports $top",
                    description="True, $top is supported",
                    advanced=true)
public boolean supportsOdataTop()

setSupportsOdataTop

public void setSupportsOdataTop(boolean supports)

supportsOdataBooleanFunctionsWithComparison

@TranslatorProperty(display="Supports boolean functions with comparison",
                    description="True, you can use \'substringsof(a, b) eq true\' for instance",
                    advanced=true)
public boolean supportsOdataBooleanFunctionsWithComparison()

setSupportsOdataBooleanFunctionsWithComparison

public void setSupportsOdataBooleanFunctionsWithComparison(boolean supports)

supportsCompareCriteriaEquals

public boolean supportsCompareCriteriaEquals()

Overrides:

supportsCompareCriteriaEquals in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsCompareCriteriaOrdered

public boolean supportsCompareCriteriaOrdered()

Overrides:

supportsCompareCriteriaOrdered in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsIsNullCriteria

public boolean supportsIsNullCriteria()

Overrides:

supportsIsNullCriteria in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsOrCriteria

public boolean supportsOrCriteria()

Overrides:

supportsOrCriteria in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsNotCriteria

public boolean supportsNotCriteria()

Overrides:

supportsNotCriteria in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsQuantifiedCompareCriteriaSome

public boolean supportsQuantifiedCompareCriteriaSome()

Overrides:

supportsQuantifiedCompareCriteriaSome in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsQuantifiedCompareCriteriaAll

public boolean supportsQuantifiedCompareCriteriaAll()

Overrides:

supportsQuantifiedCompareCriteriaAll in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsOrderBy

@TranslatorProperty(display="Supports ORDER BY",
                    description="True, if this connector supports ORDER BY",
                    advanced=true)
public boolean supportsOrderBy()

Overrides:

supportsOrderBy in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsOrderByUnrelated

public boolean supportsOrderByUnrelated()

Overrides:

supportsOrderByUnrelated in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsAggregatesCount

public boolean supportsAggregatesCount()

Overrides:

supportsAggregatesCount in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsAggregatesCountStar

public boolean supportsAggregatesCountStar()

Overrides:

supportsAggregatesCountStar in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsRowLimit

public boolean supportsRowLimit()

Overrides:

supportsRowLimit in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsRowOffset

public boolean supportsRowOffset()

Overrides:

supportsRowOffset in class ExecutionFactory<ConnectionFactory,WSConnection>

supportsOnlyLiteralComparison

public boolean supportsOnlyLiteralComparison()

Overrides:

supportsOnlyLiteralComparison in class ExecutionFactory<ConnectionFactory,WSConnection>

useAnsiJoin

public boolean useAnsiJoin()

Overrides:

useAnsiJoin in class ExecutionFactory<ConnectionFactory,WSConnection>

retrieveValue

public Object retrieveValue(Object value,
                            Class<?> expectedType)

Parameters:

value -

expectedType -

Returns:

convertToODataInput

public void convertToODataInput(Literal obj,
                                StringBuilder sb)

escapeString

protected String escapeString(String str,
                              String quote)