it.unibz.inf.ontop.model.term.functionsymbol

Interface FunctionSymbol

All Superinterfaces:

Predicate

All Known Subinterfaces:

AggregationFunctionSymbol, BnodeStringTemplateFunctionSymbol, BooleanFunctionSymbol, DBAndFunctionSymbol, DBBooleanFunctionSymbol, DBConcatFunctionSymbol, DBFunctionSymbol, DBIfElseNullFunctionSymbol, DBIfThenFunctionSymbol, DBIsNullOrNotFunctionSymbol, DBIsTrueFunctionSymbol, DBMathBinaryOperator, DBNotFunctionSymbol, DBOrFunctionSymbol, DBStrictEqFunctionSymbol, DBTypeConversionFunctionSymbol, FalseOrNullFunctionSymbol, IRIStringTemplateFunctionSymbol, LangSPARQLFunctionSymbol, NonDeterministicDBFunctionSymbol, NotYetTypedEqualityFunctionSymbol, ObjectStringTemplateFunctionSymbol, RDFTermFunctionSymbol, RDFTermTypeFunctionSymbol, SPARQLAggregationFunctionSymbol, SPARQLFunctionSymbol, TrueOrNullFunctionSymbol

All Known Implementing Classes:

AbstractAggregationFunctionSymbol, AbstractArgDependentTypedDBFunctionSymbol, AbstractBinaryBooleanOperatorSPARQLFunctionSymbol, AbstractBinaryComparisonSPARQLFunctionSymbol, AbstractCommonDenominatorFunctionSymbol, AbstractDBAggregationFunctionSymbol, AbstractDBBooleanConnectorFunctionSymbol, AbstractDBConcatFunctionSymbol, AbstractDBIfThenElseFunctionSymbol, AbstractDBIfThenFunctionSymbol, AbstractDBInequalityOperator, AbstractDBIsNullOrNotFunctionSymbol, AbstractDBIsStringEmptyFunctionSymbol, AbstractDBNonStrictEqOperator, AbstractDBStrBeforeOrAfterFunctionSymbol, AbstractDBStrictEqNeqFunctionSymbol, AbstractDBTypeConversionFunctionSymbolImpl, AbstractHashSPARQLFunctionSymbol, AbstractIsASPARQLFunctionSymbol, AbstractLexicalNonStrictEqOrInequalityFunctionSymbol, AbstractOrNullFunctionSymbol, AbstractR2RMLSafeIRIEncodeFunctionSymbol, AbstractSimpleMultitypedDBFunctionSymbol, AbstractStrBeforeOrAfterSPARQLFunctionSymbol, AbstractSubStrSPARQLFunctionSymbol, AbstractTimestampISODenormFunctionSymbol, AbstractTimestampISONormFunctionSymbol, AbstractTypedDBFunctionSymbol, AbstractUnaryBooleanSPARQLFunctionSymbol, AbstractUnaryStringSPARQLFunctionSymbol, AreCompatibleRDFStringFunctionSymbolImpl, AvgSPARQLFunctionSymbolImpl, BinaryNumericLexicalFunctionSymbolImpl, BnodeStringTemplateFunctionSymbolImpl, BooleanDBIfElseNullFunctionSymbolImpl, BooleanFunctionSymbolImpl, BoundSPARQLFunctionSymbolImpl, CoalesceSPARQLFunctionSymbolImpl, CommonDenominatorFunctionSymbolImpl, CommonPropagatedOrSubstitutedNumericTypeFunctionSymbolImpl, ConcatSPARQLFunctionSymbolImpl, ContainsSPARQLFunctionSymbolImpl, CountSPARQLFunctionSymbolImpl, DatatypeSPARQLFunctionSymbolImpl, DBBooleanCaseFunctionSymbolImpl, DBBooleanFunctionSymbolImpl, DBBooleanFunctionSymbolWithSerializerImpl, DBContainsFunctionSymbolImpl, DBCountFunctionSymbolImpl, DBFunctionSymbolWithSerializerImpl, DBHashFunctionSymbolImpl, DBIntIndexFunctionSymbolImpl, DBLikeFunctionSymbolImpl, DBMaxFunctionSymbolImpl, DBMinFunctionSymbolImpl, DBStrAfterFunctionSymbolImpl, DBStrBeforeFunctionSymbolImpl, DefaultBooleanDenormFunctionSymbol, DefaultBooleanNormFunctionSymbol, DefaultCastIntegerToStringFunctionSymbol, DefaultDBAndFunctionSymbol, DefaultDBBooleanInequalityOperator, DefaultDBCaseFunctionSymbol, DefaultDBCoalesceFunctionSymbol, DefaultDBDateInequalityOperator, DefaultDBDatetimeInequalityOperator, DefaultDBDefaultInequalityOperator, DefaultDBIfElseNullFunctionSymbol, DefaultDBIsTrueFunctionSymbol, DefaultDBNonStrictDateEqOperator, DefaultDBNonStrictDatetimeEqOperator, DefaultDBNonStrictDefaultEqOperator, DefaultDBNonStrictNumericEqOperator, DefaultDBNonStrictStringEqOperator, DefaultDBNotFunctionSymbol, DefaultDBNumericInequalityOperator, DefaultDBOrFunctionSymbol, DefaultDBStrEndsWithFunctionSymbol, DefaultDBStrictEqFunctionSymbol, DefaultDBStrictNEqFunctionSymbol, DefaultDBStringInequalityOperator, DefaultDBStrStartsWithFunctionSymbol, DefaultNonDeterministicNullaryFunctionSymbol, DefaultNumberNormAsBooleanFunctionSymbol, DefaultSimpleDBBooleanCastFunctionSymbol, DefaultSimpleDBCastFunctionSymbol, DefaultTimeTzNormalizationFunctionSymbol, DefaultTypedDBMathBinaryOperator, DefaultUntypedDBFunctionSymbol, DefaultUntypedDBMathBinaryOperator, DivideSPARQLFunctionSymbolImpl, DummyGroupConcatSPARQLFunctionSymbol, EBVSPARQLLikeFunctionSymbolImpl, EndsWithSPARQLFunctionSymbolImpl, FalseOrNullFunctionSymbolImpl, ForcingFloatingDBAvgFunctionSymbolImpl, FunctionSymbolImpl, GreaterThanSPARQLFunctionSymbolImpl, IRIStringTemplateFunctionSymbolImpl, IsARDFTermTypeFunctionSymbolImpl, IsBlankSPARQLFunctionSymbolImpl, IsIRISPARQLFunctionSymbolImpl, IsLiteralSPARQLFunctionSymbolImpl, IsNumericSPARQLFunctionSymbolImpl, LangMatchesSPARQLFunctionSymbolImpl, LangSPARQLFunctionSymbolImpl, LangTagFunctionSymbolImpl, LcaseSPARQLFunctionSymbolImpl, LessThanSPARQLFunctionSymbolImpl, LexicalEBVFunctionSymbolImpl, LexicalInequalityFunctionSymbolImpl, LexicalLangMatchesFunctionSymbolImpl, LexicalNonStrictEqualityFunctionSymbolImpl, LogicalAndSPARQLFunctionSymbolImpl, LogicalOrSPARQLFunctionSymbolImpl, Md5SPARQLFunctionSymbolImpl, MinBasedSampleSPARQLFunctionSymbol, MinOrMaxSPARQLFunctionSymbolImpl, MockupDBIfElseNullFunctionSymbol, MockupDBIsNullOrNotFunctionSymbolImpl, MockupR2RMLSafeIRIEncodeFunctionSymbol, MockupSimpleDBBooleanCastFunctionSymbol, MockupSimpleDBCastFunctionSymbol, MultitypedInputUnarySPARQLFunctionSymbolImpl, NonPostProcessedSimpleDBCastFunctionSymbol, NonSimplifiableTypedNullFunctionSymbol, NonStrictEqSPARQLFunctionSymbolImpl, NotSPARQLFunctionSymbolImpl, NotYetTypedEqualityFunctionSymbolImpl, NowSPARQLFunctionSymbolImpl, NullIfDBFunctionSymbolImpl, NullIgnoringDBAvgFunctionSymbol, NullIgnoringDBSumFunctionSymbol, NullRejectingDBConcatFunctionSymbol, NullToleratingDBConcatFunctionSymbol, NumericBinarySPARQLFunctionSymbolImpl, ObjectStringTemplateFunctionSymbolImpl, OneDigitBooleanNormFunctionSymbolImpl, OneDigitDBIsTrueFunctionSymbolImpl, OneLetterBooleanNormFunctionSymbolImpl, OneLetterDBIsTrueFunctionSymbolImpl, RandSPARQLFunctionSymbolImpl, RDF2DBBooleanFunctionSymbolImpl, RDFDatatypeStringFunctionSymbolImpl, RDFTermFunctionSymbolImpl, RDFTermTypeFunctionSymbolImpl, ReduciblePositiveAritySPARQLFunctionSymbolImpl, RegexSPARQLFunctionSymbolImpl, ReplaceSPARQLFunctionSymbolImpl, SameTermSPARQLFunctionSymbolImpl, Sha1SPARQLFunctionSymbolImpl, Sha256SPARQLFunctionSymbolImpl, Sha512SPARQLFunctionSymbolImpl, SimpleTypedDBFunctionSymbolImpl, SimpleUnarySPARQLFunctionSymbolImpl, SimplifiableTypedNullFunctionSymbol, SPARQLFunctionSymbolImpl, SPARQLLikeFunctionSymbolImpl, SQLServerDBIsTrueFunctionSymbolImpl, StandardNotationDBBooleanFunctionSymbolImpl, StartsWithSPARQLFunctionSymbolImpl, StrAfterSPARQLFunctionSymbolImpl, StrBeforeSPARQLFunctionSymbolImpl, StringBooleanBinarySPARQLFunctionSymbolImpl, StrlenSPARQLFunctionSymbolImpl, StrSPARQLFunctionSymbolImpl, StrUUIDSPARQLFunctionSymbolImpl, SubStr2SPARQLFunctionSymbolImpl, SubStr3SPARQLFunctionSymbolImpl, SumLikeSPARQLAggregationFunctionSymbolImpl, SumSPARQLFunctionSymbolImpl, TemporaryDBTypeConversionToStringFunctionSymbolImpl, TrueOrNullFunctionSymbolImpl, UcaseSPARQLFunctionSymbolImpl, UnaryDBFunctionSymbolWithSerializerImpl, UnaryLatelyTypedFunctionSymbolImpl, UnaryLexicalFunctionSymbolImpl, UnaryNumericSPARQLAggregationFunctionSymbolImpl, UnaryNumericSPARQLFunctionSymbolImpl, UUIDSPARQLFunctionSymbolImpl, WrappedDBBooleanCaseFunctionSymbolImpl

public interface FunctionSymbol
extends Predicate

FunctionSymbols are the functors needed to build ImmutableFunctionalTerms

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FunctionSymbol.FunctionalTermNullability

Method Summary

Modifier and Type	Method and Description
Optional<ImmutableFunctionalTerm.FunctionalTermDecomposition>	analyzeInjectivity(com.google.common.collect.ImmutableList<? extends ImmutableTerm> arguments, com.google.common.collect.ImmutableSet<Variable> nonFreeVariables, VariableNullability variableNullability, VariableGenerator variableGenerator, TermFactory termFactory)
boolean	canBePostProcessed(com.google.common.collect.ImmutableList<? extends ImmutableTerm> arguments) 1.
IncrementalEvaluation	evaluateIsNotNull(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms, TermFactory termFactory, VariableNullability variableNullability)
FunctionSymbol.FunctionalTermNullability	evaluateNullability(com.google.common.collect.ImmutableList<? extends NonFunctionalTerm> arguments, VariableNullability childNullability, TermFactory termFactory)
IncrementalEvaluation	evaluateStrictEq(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms, ImmutableTerm otherTerm, TermFactory termFactory, VariableNullability variableNullability)
TermType	getExpectedBaseType(int index)
Optional<TermTypeInference>	inferType(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms)
boolean	isAggregation() Returns true for SUM, AVG, etc.
boolean	isDeterministic()
boolean	isNullable(com.google.common.collect.ImmutableSet<Integer> nullableIndexes)
Stream<Variable>	proposeProvenanceVariables(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms) Returns some variables are required to non-null for the functional term to be non-null.
ImmutableTerm	simplify(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms, TermFactory termFactory, VariableNullability variableNullability)
FunctionalTermSimplification	simplifyAsGuaranteedToBeNonNull(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms, TermFactory termFactory) See ImmutableFunctionalTerm.simplifyAsGuaranteedToBeNonNull() for an explanation

Methods inherited from interface it.unibz.inf.ontop.model.term.functionsymbol.Predicate

getArity, getName

Method Detail

analyzeInjectivity

Optional<ImmutableFunctionalTerm.FunctionalTermDecomposition> analyzeInjectivity(com.google.common.collect.ImmutableList<? extends ImmutableTerm> arguments,
                                                                                 com.google.common.collect.ImmutableSet<Variable> nonFreeVariables,
                                                                                 VariableNullability variableNullability,
                                                                                 VariableGenerator variableGenerator,
                                                                                 TermFactory termFactory)

evaluateNullability

FunctionSymbol.FunctionalTermNullability evaluateNullability(com.google.common.collect.ImmutableList<? extends NonFunctionalTerm> arguments,
                                                             VariableNullability childNullability,
                                                             TermFactory termFactory)

inferType

Optional<TermTypeInference> inferType(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms)

simplify

ImmutableTerm simplify(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms,
                       TermFactory termFactory,
                       VariableNullability variableNullability)

getExpectedBaseType

TermType getExpectedBaseType(int index)

evaluateStrictEq

IncrementalEvaluation evaluateStrictEq(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms,
                                       ImmutableTerm otherTerm,
                                       TermFactory termFactory,
                                       VariableNullability variableNullability)

evaluateIsNotNull

IncrementalEvaluation evaluateIsNotNull(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms,
                                        TermFactory termFactory,
                                        VariableNullability variableNullability)

canBePostProcessed

boolean canBePostProcessed(com.google.common.collect.ImmutableList<? extends ImmutableTerm> arguments)

1. When a functional term simplifies itself in a BOTTOM-UP manner: Returns true if is guaranteed to "simplify itself" as a Constant when receiving Constants as arguments (outside the optimization phase) . 2. When a functional term simplifies itself in a TOP-DOWN manner (e.g. IF-THEN-ELSE functional terms): The permission for post-processing may depend on the ability of sub-functional terms to be post-processed or safely evaluated by the DB engine. (Recall that top-down evaluation allows some arguments not to be evaluated when their pre-conditions are not met. This is particularly valuable for preventing fatal errors).

isDeterministic

boolean isDeterministic()

isAggregation

boolean isAggregation()

Returns true for SUM, AVG, etc.

isNullable

boolean isNullable(com.google.common.collect.ImmutableSet<Integer> nullableIndexes)

proposeProvenanceVariables

Stream<Variable> proposeProvenanceVariables(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms)

Returns some variables are required to non-null for the functional term to be non-null. The stream is NOT guaranteed to be COMPLETE TODO: find a better name

simplifyAsGuaranteedToBeNonNull

FunctionalTermSimplification simplifyAsGuaranteedToBeNonNull(com.google.common.collect.ImmutableList<? extends ImmutableTerm> terms,
                                                             TermFactory termFactory)

See ImmutableFunctionalTerm.simplifyAsGuaranteedToBeNonNull() for an explanation