Package org.teiid.translator.jdbc.pi

Class PIExecutionFactory

java.lang.Object

org.teiid.translator.ExecutionFactory<DataSource,Connection>

org.teiid.translator.jdbc.JDBCExecutionFactory

org.teiid.translator.jdbc.pi.PIExecutionFactory

@Translator(name="osisoft-pi",
            description="A translator for OsiSoft PI database")
public class PIExecutionFactory
extends JDBCExecutionFactory

Nested Class Summary

Nested classes/interfaces inherited from class org.teiid.translator.jdbc.JDBCExecutionFactory

JDBCExecutionFactory.StructRetrieval

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
protected ConvertModifier	convert
static String	PI

Fields inherited from class org.teiid.translator.jdbc.JDBCExecutionFactory

DEFAULT_MAX_DEPENDENT_PREDICATES, DEFAULT_MAX_IN_CRITERIA, DEFAULT_TIME_ZONE, dialect

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
PIExecutionFactory()

Method Summary

Modifier and Type	Method	Description
void	getMetadata(MetadataFactory metadataFactory, Connection conn)
MetadataProcessor<Connection>	getMetadataProcessor()
SQLConversionVisitor	getSQLConversionVisitor()	Create the SQLConversionVisitor that will perform translation.
List<String>	getSupportedFunctions()
Object	retrieveValue(CallableStatement results, int parameterIndex, Class<?> expectedType)	Retrieve the value for the given parameter index
Object	retrieveValue(ResultSet results, int columnIndex, Class<?> expectedType)	Retrieve the value on the current resultset row for the given column index.
void	start()
boolean	supportsBatchedUpdates()
boolean	supportsBulkUpdate()
boolean	supportsConvert(int fromType, int toType)
boolean	supportsFunctionsInGroupBy()
boolean	supportsInlineViews()
boolean	supportsInsertWithQueryExpression()
boolean	supportsLateralJoin()
boolean	supportsLateralJoinCondition()
boolean	supportsOnlyLateralJoinProcedure()
boolean	supportsProcedureTable()
boolean	supportsRowLimit()
boolean	supportsSelectWithoutFrom()
List<?>	translate(LanguageObject obj, ExecutionContext context)	Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.
List<?>	translateLimit(Limit limit, ExecutionContext context)	Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.
String	translateLiteralDate(Date dateValue)	Subclasses should override this method to provide a different sql translation of the literal date value.
String	translateLiteralTime(Time timeValue)	Subclasses should override this method to provide a different sql translation of the literal time value.
String	translateLiteralTimestamp(Timestamp timestampValue)	Subclasses should override this method to provide a different sql translation of the literal timestamp value.
boolean	useAsInGroupAlias()	Indicates whether group alias should be of the form "...FROM groupA AS X" or "...FROM groupA X".
boolean	useSelectLimit()	Returns whether the limit clause is applied to the select clause.

Methods inherited from class org.teiid.translator.jdbc.JDBCExecutionFactory

addSourceComment, afterInitialConnectionObtained, bindValue, closeConnection, convertObject, createDirectExecution, createMetadataProcessor, createProcedureExecution, createResultSetExecution, createTempTable, createUpdateExecution, executeStoredProcedure, formatDateValue, formatDateValue, getCommentFormat, getConnection, getCreateTemporaryTablePostfix, getCreateTemporaryTableString, getCreateTempTableSQL, getDatabaseCalendar, getDatabaseTimeZone, getDatabaseVersion, getDefaultNullOrder, getDefaultSupportedFunctions, getDialect, getFunctionModifiers, getHibernateDialectClassName, getLateralKeyword, getLikeRegexString, getMaxPreparedInsertBatchSize, getRemovePushdownCharacters, getSetOperationString, getSourceComment, getStructRetrieval, getTemporaryTableName, getTimestampNanoPrecision, getVersion, hasTimeType, initCapabilities, intializeConnectionAfterCancel, isCharacterType, isDefaultTimeZone, isEnableDependentJoins, isExtendedAscii, isNonAscii, isNonAscii, isNonAsciiFunction, isSourceRequired, isSourceRequiredForCapabilities, isTrimStrings, loadedTemporaryTable, obtainedConnection, preserveNullTyping, registerFunctionModifier, registerSpecificTypeOfOutParameter, replaceElementName, retrieveGeographyValue, retrieveGeographyValue, retrieveGeometryValue, retrieveGeometryValue, setCommentFormat, setDatabaseTimeZone, setDatabaseVersion, setDatabaseVersion, setEnableDependentJoins, setFetchSize, setMaxPreparedInsertBatchSize, setRemovePushdownCharacters, setStructRetrieval, setTrimStrings, setUseBindingsForDependentJoin, setUseBindVariables, setUseCommentsInSourceQuery, supportsAggregatesAvg, supportsAggregatesCount, supportsAggregatesCountStar, supportsAggregatesDistinct, supportsAggregatesMax, supportsAggregatesMin, supportsAggregatesSum, supportsAliasedTable, supportsBooleanExpressions, supportsCompareCriteriaEquals, supportsCompareCriteriaOrdered, supportsCorrelatedSubqueries, supportsDependentJoins, supportsExistsCriteria, supportsFullDependentJoins, supportsGeneratedKeys, supportsGeneratedKeys, supportsGroupBy, supportsHaving, supportsInCriteria, supportsInCriteriaSubquery, supportsIsNullCriteria, supportsLikeCriteria, supportsLikeCriteriaEscapeCharacter, supportsNotCriteria, supportsOrCriteria, supportsOrderByUnrelated, supportsProcedureParameterExpression, supportsQuantifiedCompareCriteriaAll, supportsQuantifiedCompareCriteriaSome, supportsScalarSubqueries, supportsSearchedCaseExpressions, supportsSelectExpression, supportsSelfJoins, supportsSetQueryOrderBy, supportsUnions, tempTableRequiresTransaction, translateCommand, translateGeographyLiteral, translateGeographyParameter, translateGeographySelect, translateGeometryLiteral, translateGeometryParameter, translateGeometrySelect, translateLiteralBinaryType, translateLiteralBoolean, useBindingsForDependentJoin, useBindVariables, useColumnNamesForGeneratedKeys, useCommentsInSourceQuery, useNBindingType, useParensForJoins, useParensForSetQueries, usePreparedStatements, useScientificNotation, usesDatabaseVersion, useStreamsForLobs, useUnicodePrefix, useWithRollup

Methods inherited from class org.teiid.translator.ExecutionFactory

addPushDownFunction, areLobsUsableAfterClose, createExecution, getCacheDirective, getCollationLocale, getConnection, getDirectQueryProcedureName, getExcludedCommonTableExpressionName, getInstance, getLanguageFactory, getMaxDependentInPredicates, getMaxFromGroups, getMaxInCriteriaSize, getMaxProjectedColumns, getNativeQueryProcedureName, getPushDownFunctions, getRequiredLikeEscape, getSupportedJoinCriteria, getTransactionSupport, getTypeFacility, isCopyLobs, isForkable, isImmutable, 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, supportsAggregatesCountBig, supportsAggregatesEnhancedNumeric, supportsArrayAgg, supportsArrayType, supportsCommonTableExpressions, supportsCompareCriteriaOrderedExclusive, supportsCorrelatedSubqueryLimit, supportsDirectQueryProcedure, supportsElementaryOlapOperations, supportsExcept, supportsFormatLiteral, supportsFullOuterJoins, supportsGeographyType, supportsGroupByMultipleDistinctAggregates, supportsGroupByRollup, supportsInnerJoins, supportsIntersect, supportsIsDistinctCriteria, supportsLikeRegex, supportsListAgg, supportsMultipleOpenExecutions, supportsNativeQueries, supportsOnlyCorrelatedSubqueries, supportsOnlyFormatLiterals, supportsOnlyLiteralComparison, supportsOnlySingleTableGroupBy, supportsOnlyTimestampAddLiteral, supportsOrderBy, supportsOrderByNullOrdering, supportsOrderByWithExtendedGrouping, supportsOuterJoins, supportsPartialFiltering, supportsRecursiveCommonTableExpressions, supportsRowOffset, supportsScalarSubqueryProjection, supportsSelectDistinct, supportsSelectExpressionArrayType, supportsSetQueryLimitOffset, supportsSimilarTo, supportsStringAgg, supportsSubqueryCommonTableExpressions, supportsSubqueryInOn, supportsUpsert, supportsWindowDistinctAggregates, supportsWindowFrameClause, supportsWindowFunctionCumeDist, supportsWindowFunctionNthValue, supportsWindowFunctionNtile, supportsWindowFunctionPercentRank, supportsWindowOrderByWithAggregates, useAnsiJoin

Methods inherited from class java.lang.Object

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

Field Detail

PI

public static String PI

convert

protected ConvertModifier convert

Constructor Detail

PIExecutionFactory

public PIExecutionFactory()

Method Detail

start

public void start()
           throws TranslatorException

Overrides:

start in class JDBCExecutionFactory

Throws:

TranslatorException

supportsSelectWithoutFrom

public boolean supportsSelectWithoutFrom()

Overrides:

supportsSelectWithoutFrom in class ExecutionFactory<DataSource,Connection>

supportsInlineViews

public boolean supportsInlineViews()

Overrides:

supportsInlineViews in class JDBCExecutionFactory

supportsRowLimit

public boolean supportsRowLimit()

Overrides:

supportsRowLimit in class ExecutionFactory<DataSource,Connection>

supportsFunctionsInGroupBy

public boolean supportsFunctionsInGroupBy()

Overrides:

supportsFunctionsInGroupBy in class ExecutionFactory<DataSource,Connection>

supportsInsertWithQueryExpression

public boolean supportsInsertWithQueryExpression()

Overrides:

supportsInsertWithQueryExpression in class JDBCExecutionFactory

supportsBatchedUpdates

public boolean supportsBatchedUpdates()

Overrides:

supportsBatchedUpdates in class JDBCExecutionFactory

supportsBulkUpdate

public boolean supportsBulkUpdate()

Overrides:

supportsBulkUpdate in class JDBCExecutionFactory

translateLimit

public List<?> translateLimit(Limit limit,
                              ExecutionContext context)

Description copied from class: JDBCExecutionFactory

Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation.

Overrides:

translateLimit in class JDBCExecutionFactory

Returns:

a list of translated parts

useSelectLimit

public boolean useSelectLimit()

Description copied from class: JDBCExecutionFactory

Returns whether the limit clause is applied to the select clause.

Overrides:

useSelectLimit in class JDBCExecutionFactory

Returns:

true if the limit clause is part of the select

getSupportedFunctions

public List<String> getSupportedFunctions()

Overrides:

getSupportedFunctions in class JDBCExecutionFactory

translateLiteralDate

public String translateLiteralDate(Date dateValue)

Description copied from class: JDBCExecutionFactory

Subclasses should override this method to provide a different sql translation of the literal date value. By default, a date literal is represented as: {d '2002-12-31'}

Overrides:

translateLiteralDate in class JDBCExecutionFactory

Parameters:

dateValue - Date value, never null

Returns:

Translated string

translateLiteralTime

public String translateLiteralTime(Time timeValue)

Description copied from class: JDBCExecutionFactory

Subclasses should override this method to provide a different sql translation of the literal time value. By default, a time literal is represented as: {t '23:59:59'} See JDBCExecutionFactory.hasTimeType() to represent literal times as timestamps.

Overrides:

translateLiteralTime in class JDBCExecutionFactory

Parameters:

timeValue - Time value, never null

Returns:

Translated string

translateLiteralTimestamp

public String translateLiteralTimestamp(Timestamp timestampValue)

Description copied from class: JDBCExecutionFactory

Subclasses should override this method to provide a different sql translation of the literal timestamp value. By default, a timestamp literal is represented as: {ts '2002-12-31 23:59:59'}. See JDBCExecutionFactory.getTimestampNanoPrecision() to control the literal precision.

Overrides:

translateLiteralTimestamp in class JDBCExecutionFactory

Parameters:

timestampValue - Timestamp value, never null

Returns:

Translated string

getMetadata

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

Overrides:

getMetadata in class JDBCExecutionFactory

Throws:

TranslatorException

getMetadataProcessor

public MetadataProcessor<Connection> getMetadataProcessor()

Overrides:

getMetadataProcessor in class JDBCExecutionFactory

useAsInGroupAlias

public boolean useAsInGroupAlias()

Description copied from class: JDBCExecutionFactory

Indicates whether group alias should be of the form "...FROM groupA AS X" or "...FROM groupA X". Certain data sources (such as Oracle) may not support the first form.

Overrides:

useAsInGroupAlias in class JDBCExecutionFactory

Returns:

boolean

translate

public List<?> translate(LanguageObject obj,
                         ExecutionContext context)

Description copied from class: JDBCExecutionFactory

Return a List of translated parts (LanguageObjects and Objects), or null if to rely on the default translation. Override with care.

Overrides:

translate in class JDBCExecutionFactory

Returns:

list of translated parts

getSQLConversionVisitor

public SQLConversionVisitor getSQLConversionVisitor()

Description copied from class: JDBCExecutionFactory

Create the SQLConversionVisitor that will perform translation. Typical custom JDBC connectors will not need to create custom conversion visitors, rather implementors should override existing JDBCExecutionFactory methods.

Overrides:

getSQLConversionVisitor in class JDBCExecutionFactory

Returns:

the SQLConversionVisitor

supportsLateralJoin

public boolean supportsLateralJoin()

Overrides:

supportsLateralJoin in class ExecutionFactory<DataSource,Connection>

Returns:

true if the source supports lateral join

supportsLateralJoinCondition

public boolean supportsLateralJoinCondition()

Overrides:

supportsLateralJoinCondition in class ExecutionFactory<DataSource,Connection>

Returns:

true if the source supports lateral join conditions

supportsOnlyLateralJoinProcedure

public boolean supportsOnlyLateralJoinProcedure()

Overrides:

supportsOnlyLateralJoinProcedure in class ExecutionFactory<DataSource,Connection>

supportsProcedureTable

public boolean supportsProcedureTable()

Overrides:

supportsProcedureTable in class ExecutionFactory<DataSource,Connection>

Returns:

retrieveValue

public Object retrieveValue(ResultSet results,
                            int columnIndex,
                            Class<?> expectedType)
                     throws SQLException

Description copied from class: JDBCExecutionFactory

Retrieve the value on the current resultset row for the given column index.

Overrides:

retrieveValue in class JDBCExecutionFactory

Returns:

the value

Throws:

SQLException

retrieveValue

public Object retrieveValue(CallableStatement results,
                            int parameterIndex,
                            Class<?> expectedType)
                     throws SQLException

Description copied from class: JDBCExecutionFactory

Retrieve the value for the given parameter index

Overrides:

retrieveValue in class JDBCExecutionFactory

Returns:

the value

Throws:

SQLException

supportsConvert

public boolean supportsConvert(int fromType,
                               int toType)

Overrides:

supportsConvert in class ExecutionFactory<DataSource,Connection>