DBFunctionSymbolFactory (ontop-model 4.0.0-beta-2-SNAPSHOT API)

All Known Implementing Classes:

AbstractDBFunctionSymbolFactory, MockupDBFunctionSymbolFactory
```
public interface DBFunctionSymbolFactory
```
Factory for DBFunctionSymbols Accessible through Guice (recommended) or through CoreSingletons.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DBFunctionSymbol`	`getAbs(DBTermType dbTermType)`
`BnodeStringTemplateFunctionSymbol`	`getBnodeStringTemplateFunctionSymbol(String bnodeTemplate)` NB: a functional term using this symbol is producing a NULL or a DB string
`DBFunctionSymbol`	`getCeil(DBTermType dbTermType)`
`DBTypeConversionFunctionSymbol`	`getConversion2RDFLexicalFunctionSymbol(DBTermType inputType, RDFTermType rdfTermType)` The output type is a DB string.
`DBTypeConversionFunctionSymbol`	`getConversionFromRDFLexical2DBFunctionSymbol(DBTermType targetDBType, RDFTermType rdfType)` From a possibly "normalized" DB string to another DB type
`DBAndFunctionSymbol`	`getDBAnd(int arity)` arity must be >= 2
`DBBooleanFunctionSymbol`	`getDBBooleanCase(int arity, boolean doOrderingMatter)`
`DBBooleanFunctionSymbol`	`getDBBooleanIfElseNull()`
`DBBooleanFunctionSymbol`	`getDBBooleanInequality(InequalityLabel inequalityLabel)`
`DBFunctionSymbol`	`getDBCase(int arity, boolean doOrderingMatter)` IF THEN, ELSE IF ..., ELSE Arity must be odd and >= 3 doOrderingMatter: if false, the when pairs can be re-ordered
`DBTypeConversionFunctionSymbol`	`getDBCastFunctionSymbol(DBTermType targetType)`
`DBTypeConversionFunctionSymbol`	`getDBCastFunctionSymbol(DBTermType inputType, DBTermType targetType)`
`DBFunctionSymbol`	`getDBCharLength()`
`DBFunctionSymbol`	`getDBCoalesce(int arity)` Min arity is 1
`DBConcatFunctionSymbol`	`getDBConcatOperator(int arity)` arity must be >= 2 No guarantee on the semantics (dialect-specific!).
`DBBooleanFunctionSymbol`	`getDBContains()` Arity 2, first argument is the string in which to search, second argument is subString
`DBFunctionSymbol`	`getDBCount(int arity, boolean isDistinct)` arity <= 1
`DBBooleanFunctionSymbol`	`getDBDateInequality(InequalityLabel inequalityLabel)`
`DBBooleanFunctionSymbol`	`getDBDatetimeInequality(InequalityLabel inequalityLabel)`
`DBFunctionSymbol`	`getDBDayFromDate()`
`DBFunctionSymbol`	`getDBDayFromDatetime()`
`DBBooleanFunctionSymbol`	`getDBDefaultInequality(InequalityLabel inequalityLabel)`
`DBBooleanFunctionSymbol`	`getDBEndsWith()`
`DBFunctionSymbol`	`getDBHours()`
`DBIfElseNullFunctionSymbol`	`getDBIfElseNull()`
`DBFunctionSymbol`	`getDBIfThenElse()`
`DBFunctionSymbol`	`getDBIntIndex(int nbValues)` The first sub-term encodes the index of the term to return.
`DBIsNullOrNotFunctionSymbol`	`getDBIsNotNull()`
`DBIsNullOrNotFunctionSymbol`	`getDBIsNull()`
`DBBooleanFunctionSymbol`	`getDBIsStringEmpty()`
`DBBooleanFunctionSymbol`	`getDBLike()`
`DBFunctionSymbol`	`getDBLower()`
`DBMathBinaryOperator`	`getDBMathBinaryOperator(String dbMathOperatorName, DBTermType dbNumericType)`
`DBFunctionSymbol`	`getDBMax(DBTermType dbType)`
`DBFunctionSymbol`	`getDBMd5()`
`DBFunctionSymbol`	`getDBMin(DBTermType dbType)`
`DBFunctionSymbol`	`getDBMinutes()`
`DBFunctionSymbol`	`getDBMonthFromDate()`
`DBFunctionSymbol`	`getDBMonthFromDatetime()`
`DBBooleanFunctionSymbol`	`getDBNonStrictDateEquality()`
`DBBooleanFunctionSymbol`	`getDBNonStrictDatetimeEquality()`
`DBBooleanFunctionSymbol`	`getDBNonStrictDefaultEquality()`
`DBBooleanFunctionSymbol`	`getDBNonStrictNumericEquality()`
`DBBooleanFunctionSymbol`	`getDBNonStrictStringEquality()`
`DBNotFunctionSymbol`	`getDBNot()`
`DBFunctionSymbol`	`getDBNow()`
`DBBooleanFunctionSymbol`	`getDBNumericInequality(InequalityLabel inequalityLabel)`
`DBOrFunctionSymbol`	`getDBOr(int arity)` arity must be >= 2
`NonDeterministicDBFunctionSymbol`	`getDBRand(UUID uuid)`
`DBBooleanFunctionSymbol`	`getDBRegexpMatches2()`
`DBBooleanFunctionSymbol`	`getDBRegexpMatches3()`
`DBFunctionSymbol`	`getDBRegexpReplace3()`
`DBFunctionSymbol`	`getDBRegexpReplace4()`
`DBFunctionSymbol`	`getDBReplace()`
`DBFunctionSymbol`	`getDBRight()`
`DBFunctionSymbol`	`getDBSeconds()`
`DBFunctionSymbol`	`getDBSha1()`
`DBFunctionSymbol`	`getDBSha256()`
`DBFunctionSymbol`	`getDBSha512()`
`DBBooleanFunctionSymbol`	`getDBStartsWith()`
`DBFunctionSymbol`	`getDBStrAfter()`
`DBFunctionSymbol`	`getDBStrBefore()`
`DBStrictEqFunctionSymbol`	`getDBStrictEquality(int arity)`
`DBBooleanFunctionSymbol`	`getDBStrictNEquality(int arity)`
`DBBooleanFunctionSymbol`	`getDBStringInequality(InequalityLabel inequalityLabel)`
`DBFunctionSymbol`	`getDBSubString2()`
`DBFunctionSymbol`	`getDBSubString3()`
`DBFunctionSymbol`	`getDBSum(DBTermType dbType, boolean isDistinct)` Semantics not guaranteed (may depend on the dialect)!
`DBFunctionSymbol`	`getDBTz()`
`DBFunctionSymbol`	`getDBUpper()`
`NonDeterministicDBFunctionSymbol`	`getDBUUID(UUID uuid)`
`DBFunctionSymbol`	`getDBYearFromDate()`
`DBFunctionSymbol`	`getDBYearFromDatetime()`
`FalseOrNullFunctionSymbol`	`getFalseOrNullFunctionSymbol(int arity)`
`DBFunctionSymbol`	`getFloor(DBTermType dbTermType)`
`BnodeStringTemplateFunctionSymbol`	`getFreshBnodeStringTemplateFunctionSymbol(int arity)` Returns a fresh Bnode template
`IRIStringTemplateFunctionSymbol`	`getIRIStringTemplateFunctionSymbol(String iriTemplate)` NB: a functional term using this symbol is producing a NULL or a DB string
`DBIsTrueFunctionSymbol`	`getIsTrue()`
`DBFunctionSymbol`	`getNullIgnoringDBAvg(DBTermType dbType, boolean isDistinct)` Ignores nulls.
`DBFunctionSymbol`	`getNullIgnoringDBSum(DBTermType dbType, boolean isDistinct)` Ignores nulls.
`DBConcatFunctionSymbol`	`getNullRejectingDBConcat(int arity)` arity must be >= 2 Returns a function symbol that does NOT tolerate NULLs
`DBFunctionSymbol`	`getR2RMLIRISafeEncode()`
`DBBooleanFunctionSymbol`	`getRegularDBBooleanFunctionSymbol(String nameInDialect, int arity)` A regular function symbol if a function symbol that can be identified by its name in the DB dialect.
`DBFunctionSymbol`	`getRegularDBFunctionSymbol(String nameInDialect, int arity)` A regular function symbol if a function symbol that can be identified by its name in the DB dialect.
`DBFunctionSymbol`	`getRound(DBTermType dbTermType)`
`DBTypeConversionFunctionSymbol`	`getTemporaryConversionToDBStringFunctionSymbol()` Temporary conversion function for the lexical part of an RDF term.
`TrueOrNullFunctionSymbol`	`getTrueOrNullFunctionSymbol(int arity)`
`DBFunctionSymbol`	`getTypedNullFunctionSymbol(DBTermType termType)` The functional term using it may be simplifiable to a regular NULL or not, depending on the DB system.
`DBMathBinaryOperator`	`getUntypedDBMathBinaryOperator(String dbMathOperatorName)` Please use getDBMathBinaryOperator(...) if you know the type

Method Detail

getIRIStringTemplateFunctionSymbol
```
IRIStringTemplateFunctionSymbol getIRIStringTemplateFunctionSymbol(String iriTemplate)
```
NB: a functional term using this symbol is producing a NULL or a DB string

getBnodeStringTemplateFunctionSymbol
```
BnodeStringTemplateFunctionSymbol getBnodeStringTemplateFunctionSymbol(String bnodeTemplate)
```
NB: a functional term using this symbol is producing a NULL or a DB string

getFreshBnodeStringTemplateFunctionSymbol

BnodeStringTemplateFunctionSymbol getFreshBnodeStringTemplateFunctionSymbol(int arity)

Returns a fresh Bnode template

getTemporaryConversionToDBStringFunctionSymbol
```
DBTypeConversionFunctionSymbol getTemporaryConversionToDBStringFunctionSymbol()
```
Temporary conversion function for the lexical part of an RDF term. ONLY for pre-processed mapping assertions (TEMPORARY usage, to be replaced later on in the process by a fully defined cast function)

getDBCastFunctionSymbol

DBTypeConversionFunctionSymbol getDBCastFunctionSymbol(DBTermType targetType)

getDBCastFunctionSymbol

DBTypeConversionFunctionSymbol getDBCastFunctionSymbol(DBTermType inputType,
                                                       DBTermType targetType)

getConversion2RDFLexicalFunctionSymbol

DBTypeConversionFunctionSymbol getConversion2RDFLexicalFunctionSymbol(DBTermType inputType,
                                                                      RDFTermType rdfTermType)

The output type is a DB string. This function symbol MAY also perform some normalization.

getConversionFromRDFLexical2DBFunctionSymbol

DBTypeConversionFunctionSymbol getConversionFromRDFLexical2DBFunctionSymbol(DBTermType targetDBType,
                                                                            RDFTermType rdfType)

From a possibly "normalized" DB string to another DB type

getRegularDBFunctionSymbol
```
DBFunctionSymbol getRegularDBFunctionSymbol(String nameInDialect,
                                            int arity)
```
A regular function symbol if a function symbol that can be identified by its name in the DB dialect. It can therefore be used in the input mapping document. Not for special DB function symbols such as casts.

getRegularDBBooleanFunctionSymbol
```
DBBooleanFunctionSymbol getRegularDBBooleanFunctionSymbol(String nameInDialect,
                                                          int arity)
```
A regular function symbol if a function symbol that can be identified by its name in the DB dialect. It can therefore be used in the input mapping document. Not for special DB function symbols such as casts.

getDBCase
```
DBFunctionSymbol getDBCase(int arity,
                           boolean doOrderingMatter)
```
IF THEN, ELSE IF ..., ELSE Arity must be odd and >= 3 doOrderingMatter: if false, the when pairs can be re-ordered

getDBBooleanCase

DBBooleanFunctionSymbol getDBBooleanCase(int arity,
                                         boolean doOrderingMatter)

getDBIfElseNull

DBIfElseNullFunctionSymbol getDBIfElseNull()

getDBBooleanIfElseNull

DBBooleanFunctionSymbol getDBBooleanIfElseNull()

getDBIfThenElse
```
DBFunctionSymbol getDBIfThenElse()
```

getDBUpper
```
DBFunctionSymbol getDBUpper()
```

getDBLower
```
DBFunctionSymbol getDBLower()
```

getDBReplace
```
DBFunctionSymbol getDBReplace()
```

getDBRegexpReplace3
```
DBFunctionSymbol getDBRegexpReplace3()
```

getDBRegexpReplace4
```
DBFunctionSymbol getDBRegexpReplace4()
```

getDBSubString2
```
DBFunctionSymbol getDBSubString2()
```

getDBSubString3
```
DBFunctionSymbol getDBSubString3()
```

getDBRight
```
DBFunctionSymbol getDBRight()
```

getDBCharLength
```
DBFunctionSymbol getDBCharLength()
```

getR2RMLIRISafeEncode

DBFunctionSymbol getR2RMLIRISafeEncode()

getNullRejectingDBConcat
```
DBConcatFunctionSymbol getNullRejectingDBConcat(int arity)
```
arity must be >= 2 Returns a function symbol that does NOT tolerate NULLs

getDBConcatOperator
```
DBConcatFunctionSymbol getDBConcatOperator(int arity)
```
arity must be >= 2 No guarantee on the semantics (dialect-specific!). Please consider the use of getNullRejectingDBConcat(...) Intended to be used by the mapping parser

getDBAnd

DBAndFunctionSymbol getDBAnd(int arity)

arity must be >= 2

getDBOr
```
DBOrFunctionSymbol getDBOr(int arity)
```
arity must be >= 2

getDBNot
```
DBNotFunctionSymbol getDBNot()
```

getDBIsNull

DBIsNullOrNotFunctionSymbol getDBIsNull()

getDBIsNotNull

DBIsNullOrNotFunctionSymbol getDBIsNotNull()

getDBCoalesce

DBFunctionSymbol getDBCoalesce(int arity)

Min arity is 1

getFalseOrNullFunctionSymbol

FalseOrNullFunctionSymbol getFalseOrNullFunctionSymbol(int arity)

getTrueOrNullFunctionSymbol

TrueOrNullFunctionSymbol getTrueOrNullFunctionSymbol(int arity)

getDBStrictEquality

DBStrictEqFunctionSymbol getDBStrictEquality(int arity)

getDBStrictNEquality

DBBooleanFunctionSymbol getDBStrictNEquality(int arity)

getDBNonStrictNumericEquality

DBBooleanFunctionSymbol getDBNonStrictNumericEquality()

getDBNonStrictStringEquality

DBBooleanFunctionSymbol getDBNonStrictStringEquality()

getDBNonStrictDatetimeEquality

DBBooleanFunctionSymbol getDBNonStrictDatetimeEquality()

getDBNonStrictDateEquality

DBBooleanFunctionSymbol getDBNonStrictDateEquality()

getDBNonStrictDefaultEquality

DBBooleanFunctionSymbol getDBNonStrictDefaultEquality()

getDBNumericInequality

DBBooleanFunctionSymbol getDBNumericInequality(InequalityLabel inequalityLabel)

getDBBooleanInequality

DBBooleanFunctionSymbol getDBBooleanInequality(InequalityLabel inequalityLabel)

getDBStringInequality

DBBooleanFunctionSymbol getDBStringInequality(InequalityLabel inequalityLabel)

getDBDatetimeInequality

DBBooleanFunctionSymbol getDBDatetimeInequality(InequalityLabel inequalityLabel)

getDBDateInequality

DBBooleanFunctionSymbol getDBDateInequality(InequalityLabel inequalityLabel)

getDBDefaultInequality

DBBooleanFunctionSymbol getDBDefaultInequality(InequalityLabel inequalityLabel)

getDBStartsWith

DBBooleanFunctionSymbol getDBStartsWith()

getDBEndsWith

DBBooleanFunctionSymbol getDBEndsWith()

getDBIsStringEmpty

DBBooleanFunctionSymbol getDBIsStringEmpty()

getIsTrue
```
DBIsTrueFunctionSymbol getIsTrue()
```

getDBContains
```
DBBooleanFunctionSymbol getDBContains()
```
Arity 2, first argument is the string in which to search, second argument is subString

getDBRand

NonDeterministicDBFunctionSymbol getDBRand(UUID uuid)

getDBUUID

NonDeterministicDBFunctionSymbol getDBUUID(UUID uuid)

getDBRegexpMatches2

DBBooleanFunctionSymbol getDBRegexpMatches2()

getDBRegexpMatches3

DBBooleanFunctionSymbol getDBRegexpMatches3()

getDBLike
```
DBBooleanFunctionSymbol getDBLike()
```

getDBStrBefore
```
DBFunctionSymbol getDBStrBefore()
```

getDBStrAfter
```
DBFunctionSymbol getDBStrAfter()
```

getDBMd5
```
DBFunctionSymbol getDBMd5()
```

getDBSha1
```
DBFunctionSymbol getDBSha1()
```

getDBSha256
```
DBFunctionSymbol getDBSha256()
```

getDBSha512
```
DBFunctionSymbol getDBSha512()
```

getDBMathBinaryOperator

DBMathBinaryOperator getDBMathBinaryOperator(String dbMathOperatorName,
                                             DBTermType dbNumericType)

getUntypedDBMathBinaryOperator
```
DBMathBinaryOperator getUntypedDBMathBinaryOperator(String dbMathOperatorName)
```
Please use getDBMathBinaryOperator(...) if you know the type

getAbs

DBFunctionSymbol getAbs(DBTermType dbTermType)

getCeil

DBFunctionSymbol getCeil(DBTermType dbTermType)

getFloor

DBFunctionSymbol getFloor(DBTermType dbTermType)

getRound

DBFunctionSymbol getRound(DBTermType dbTermType)

getDBYearFromDatetime

DBFunctionSymbol getDBYearFromDatetime()

getDBYearFromDate
```
DBFunctionSymbol getDBYearFromDate()
```

getDBMonthFromDatetime

DBFunctionSymbol getDBMonthFromDatetime()

getDBMonthFromDate
```
DBFunctionSymbol getDBMonthFromDate()
```

getDBDayFromDatetime

DBFunctionSymbol getDBDayFromDatetime()

getDBDayFromDate
```
DBFunctionSymbol getDBDayFromDate()
```

getDBHours
```
DBFunctionSymbol getDBHours()
```

getDBMinutes
```
DBFunctionSymbol getDBMinutes()
```

getDBSeconds
```
DBFunctionSymbol getDBSeconds()
```

getDBTz
```
DBFunctionSymbol getDBTz()
```

getDBNow
```
DBFunctionSymbol getDBNow()
```

getTypedNullFunctionSymbol
```
DBFunctionSymbol getTypedNullFunctionSymbol(DBTermType termType)
```
The functional term using it may be simplifiable to a regular NULL or not, depending on the DB system. Useful for PostgreSQL which has limited type inference capabilities when it comes to NULL and UNION (ALL).

getDBCount

DBFunctionSymbol getDBCount(int arity,
                            boolean isDistinct)

arity <= 1

getNullIgnoringDBSum

DBFunctionSymbol getNullIgnoringDBSum(DBTermType dbType,
                                      boolean isDistinct)

Ignores nulls. Returns NULL if the bag/set does not contain any non-null value.

getDBSum

DBFunctionSymbol getDBSum(DBTermType dbType,
                          boolean isDistinct)

Semantics not guaranteed (may depend on the dialect)!

getNullIgnoringDBAvg

DBFunctionSymbol getNullIgnoringDBAvg(DBTermType dbType,
                                      boolean isDistinct)

Ignores nulls. Returns NULL if the bag/set does not contain any non-null value.

getDBMin

DBFunctionSymbol getDBMin(DBTermType dbType)

getDBMax

DBFunctionSymbol getDBMax(DBTermType dbType)

getDBIntIndex
```
DBFunctionSymbol getDBIntIndex(int nbValues)
```
The first sub-term encodes the index of the term to return. Such values correspond to the following sub-terms For instance DB_IDX(1, "roger", "francis", "ernest") returns "francis" TODO: find a better name

Interface DBFunctionSymbolFactory

Method Summary

Method Detail

getIRIStringTemplateFunctionSymbol

getBnodeStringTemplateFunctionSymbol

getFreshBnodeStringTemplateFunctionSymbol

getTemporaryConversionToDBStringFunctionSymbol

getDBCastFunctionSymbol

getDBCastFunctionSymbol

getConversion2RDFLexicalFunctionSymbol

getConversionFromRDFLexical2DBFunctionSymbol

getRegularDBFunctionSymbol

getRegularDBBooleanFunctionSymbol

getDBCase

getDBBooleanCase

getDBIfElseNull

getDBBooleanIfElseNull

getDBIfThenElse

getDBUpper

getDBLower

getDBReplace

getDBRegexpReplace3

getDBRegexpReplace4

getDBSubString2

getDBSubString3

getDBRight

getDBCharLength

getR2RMLIRISafeEncode

getNullRejectingDBConcat

getDBConcatOperator

getDBAnd

getDBOr

getDBNot

getDBIsNull

getDBIsNotNull

getDBCoalesce

getFalseOrNullFunctionSymbol

getTrueOrNullFunctionSymbol

getDBStrictEquality

getDBStrictNEquality

getDBNonStrictNumericEquality

getDBNonStrictStringEquality

getDBNonStrictDatetimeEquality

getDBNonStrictDateEquality

getDBNonStrictDefaultEquality

getDBNumericInequality

getDBBooleanInequality

getDBStringInequality

getDBDatetimeInequality

getDBDateInequality

getDBDefaultInequality

getDBStartsWith

getDBEndsWith

getDBIsStringEmpty

getIsTrue

getDBContains

getDBRand

getDBUUID

getDBRegexpMatches2

getDBRegexpMatches3

getDBLike

getDBStrBefore

getDBStrAfter

getDBMd5

getDBSha1

getDBSha256

getDBSha512

getDBMathBinaryOperator

getUntypedDBMathBinaryOperator

getAbs

getCeil

getFloor

getRound

getDBYearFromDatetime

getDBYearFromDate

getDBMonthFromDatetime

getDBMonthFromDate

getDBDayFromDatetime

getDBDayFromDate

getDBHours