it.unibz.inf.ontop.iq.impl

Class IntermediateQueryImpl

java.lang.Object

it.unibz.inf.ontop.iq.impl.IntermediateQueryImpl

All Implemented Interfaces:

IntermediateQuery

public class IntermediateQueryImpl
extends Object
implements IntermediateQuery

TODO: describe BEWARE: this class has a non-trivial mutable internal state!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntermediateQueryImpl.InconsistentIntermediateQueryException Thrown when the internal state of the intermediate query is found to be inconsistent.

Constructor Summary

Constructors

Constructor and Description
IntermediateQueryImpl(DistinctVariableOnlyDataAtom projectionAtom, QueryTreeComponent treeComponent, ExecutorRegistry executorRegistry, IntermediateQueryValidator validator, OntopModelSettings settings, IntermediateQueryFactory iqFactory) For IntermediateQueryBuilders ONLY!!

Method Summary

Modifier and Type	Method and Description
<R extends ProposalResults,P extends QueryOptimizationProposal<R>> R	applyProposal(P propagationProposal) Central method for submitting a proposal.
<R extends ProposalResults,P extends QueryOptimizationProposal<R>> R	applyProposal(P proposal, boolean disableValidationTests) May disable the (possible) validation tests
IntermediateQuery	clone() Not appearing in the interface because users do not have to worry about it.
boolean	contains(QueryNode node)
IntermediateQuery	createSnapshot() Keeps the same query node objects but clones the tree edges (since the latter are mutable by default).
Variable	generateNewVariable() Returns a variable that is not used in the intermediate query.
Variable	generateNewVariable(Variable formerVariable) Returns a variable that is not used in the intermediate query.
it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode>	getAncestors(QueryNode descendantNode) From the parent to the oldest ancestor.
Optional<QueryNode>	getChild(QueryNode currentNode, BinaryOrderedOperatorNode.ArgumentPosition position)
it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode>	getChildren(QueryNode node)
Stream<QueryNode>	getChildrenStream(QueryNode node)
ConstructionNode	getClosestConstructionNode(QueryNode node) Returns itself if is a ConstructionNode or its first ancestor that is a construction node otherwise.
ExecutorRegistry	getExecutorRegistry() Not for end-users! Needed using when using specialized intermediate queries
IntermediateQueryFactory	getFactory()
Optional<QueryNode>	getFirstChild(QueryNode node)
Stream<IntensionalDataNode>	getIntensionalNodes()
it.unibz.inf.ontop.com.google.common.collect.ImmutableSet<Variable>	getKnownVariables()
Optional<QueryNode>	getNextSibling(QueryNode node)
it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode>	getNodesInBottomUpOrder()
it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode>	getNodesInTopDownOrder()
Optional<BinaryOrderedOperatorNode.ArgumentPosition>	getOptionalPosition(QueryNode child)
Optional<BinaryOrderedOperatorNode.ArgumentPosition>	getOptionalPosition(QueryNode parentNode, QueryNode childNode) TODO: explain
Stream<QueryNode>	getOtherChildrenStream(QueryNode parent, QueryNode childToOmit)
Optional<QueryNode>	getParent(QueryNode node)
DistinctVariableOnlyDataAtom	getProjectionAtom()
QueryNode	getRootNode()
IntermediateQuery	getSubquery(QueryNode subQueryRoot, DistinctVariableOnlyDataAtom projectionAtom)
it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode>	getSubTreeNodesInTopDownOrder(QueryNode currentNode) EXCLUDES the root of the sub-tree (currentNode).
Stream<TrueNode>	getTrueNodes()
it.unibz.inf.ontop.com.google.common.collect.ImmutableSet<Variable>	getVariables(QueryNode subTreeRootNode) Set of variables that are returned by the sub-tree.
it.unibz.inf.ontop.com.google.common.collect.ImmutableSet<Variable>	getVariablesRequiredByAncestors(QueryNode queryNode) Minimal set of variables such that a construction node projecting exactly these variables could be inserted just above this node without altering the query semantics.
UUID	getVersionNumber()
boolean	hasAncestor(QueryNode descendantNode, QueryNode ancestorNode) TODO: replace by a more efficient implementation
IntermediateQueryBuilder	newBuilder() Creates a uninitialized query builder.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IntermediateQueryImpl

public IntermediateQueryImpl(DistinctVariableOnlyDataAtom projectionAtom,
                             QueryTreeComponent treeComponent,
                             ExecutorRegistry executorRegistry,
                             IntermediateQueryValidator validator,
                             OntopModelSettings settings,
                             IntermediateQueryFactory iqFactory)

For IntermediateQueryBuilders ONLY!!

Method Detail

getProjectionAtom

public DistinctVariableOnlyDataAtom getProjectionAtom()

Specified by:

getProjectionAtom in interface IntermediateQuery

getKnownVariables

public it.unibz.inf.ontop.com.google.common.collect.ImmutableSet<Variable> getKnownVariables()

Specified by:

getKnownVariables in interface IntermediateQuery

createSnapshot

public IntermediateQuery createSnapshot()

Description copied from interface: IntermediateQuery

Keeps the same query node objects but clones the tree edges (since the latter are mutable by default). TODO: return an immutable Intermediate Query

Specified by:

createSnapshot in interface IntermediateQuery

getOtherChildrenStream

public Stream<QueryNode> getOtherChildrenStream(QueryNode parent,
                                                QueryNode childToOmit)

Specified by:

getOtherChildrenStream in interface IntermediateQuery

hasAncestor

public boolean hasAncestor(QueryNode descendantNode,
                           QueryNode ancestorNode)

TODO: replace by a more efficient implementation

Specified by:

hasAncestor in interface IntermediateQuery

getVariables

public it.unibz.inf.ontop.com.google.common.collect.ImmutableSet<Variable> getVariables(QueryNode subTreeRootNode)

Description copied from interface: IntermediateQuery

Set of variables that are returned by the sub-tree.

Specified by:

getVariables in interface IntermediateQuery

getVersionNumber

public UUID getVersionNumber()

Specified by:

getVersionNumber in interface IntermediateQuery

newBuilder

public IntermediateQueryBuilder newBuilder()

Description copied from interface: IntermediateQuery

Creates a uninitialized query builder.

Specified by:

newBuilder in interface IntermediateQuery

getRootNode

public QueryNode getRootNode()
                      throws IntermediateQueryImpl.InconsistentIntermediateQueryException

Specified by:

getRootNode in interface IntermediateQuery

Throws:

IntermediateQueryImpl.InconsistentIntermediateQueryException

getNodesInBottomUpOrder

public it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode> getNodesInBottomUpOrder()
                                                                                              throws IntermediateQueryImpl.InconsistentIntermediateQueryException

Specified by:

getNodesInBottomUpOrder in interface IntermediateQuery

Throws:

IntermediateQueryImpl.InconsistentIntermediateQueryException

getNodesInTopDownOrder

public it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode> getNodesInTopDownOrder()

Specified by:

getNodesInTopDownOrder in interface IntermediateQuery

getChildren

public it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode> getChildren(QueryNode node)

Specified by:

getChildren in interface IntermediateQuery

getChildrenStream

public Stream<QueryNode> getChildrenStream(QueryNode node)

Specified by:

getChildrenStream in interface IntermediateQuery

getChild

public Optional<QueryNode> getChild(QueryNode currentNode,
                                    BinaryOrderedOperatorNode.ArgumentPosition position)

Specified by:

getChild in interface IntermediateQuery

getSubTreeNodesInTopDownOrder

public it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode> getSubTreeNodesInTopDownOrder(QueryNode currentNode)

Description copied from interface: IntermediateQuery

EXCLUDES the root of the sub-tree (currentNode). TODO: find a better name

Specified by:

getSubTreeNodesInTopDownOrder in interface IntermediateQuery

getIntensionalNodes

public Stream<IntensionalDataNode> getIntensionalNodes()

Specified by:

getIntensionalNodes in interface IntermediateQuery

getTrueNodes

public Stream<TrueNode> getTrueNodes()

Specified by:

getTrueNodes in interface IntermediateQuery

contains

public boolean contains(QueryNode node)

Specified by:

contains in interface IntermediateQuery

applyProposal

public <R extends ProposalResults,P extends QueryOptimizationProposal<R>> R applyProposal(P proposal,
                                                                                          boolean disableValidationTests)
                                                                                   throws InvalidQueryOptimizationProposalException,
                                                                                          EmptyQueryException

Description copied from interface: IntermediateQuery

May disable the (possible) validation tests

Specified by:

applyProposal in interface IntermediateQuery

Throws:

InvalidQueryOptimizationProposalException

EmptyQueryException

applyProposal

public <R extends ProposalResults,P extends QueryOptimizationProposal<R>> R applyProposal(P propagationProposal)
                                                                                   throws InvalidQueryOptimizationProposalException,
                                                                                          EmptyQueryException

Description copied from interface: IntermediateQuery

Central method for submitting a proposal. Throws a InvalidQueryOptimizationProposalException if the proposal is rejected. The current intermediate query will most likely be modified (SIDE-EFFECT). The proposal is expected TO optimize the query WITHOUT CHANGING ITS SEMANTICS. In principle, the proposal could be carefully checked, beware!

Specified by:

applyProposal in interface IntermediateQuery

Throws:

InvalidQueryOptimizationProposalException

EmptyQueryException

getOptionalPosition

public Optional<BinaryOrderedOperatorNode.ArgumentPosition> getOptionalPosition(QueryNode parentNode,
                                                                                QueryNode childNode)

Description copied from interface: IntermediateQuery

TODO: explain

Specified by:

getOptionalPosition in interface IntermediateQuery

getOptionalPosition

public Optional<BinaryOrderedOperatorNode.ArgumentPosition> getOptionalPosition(QueryNode child)

Specified by:

getOptionalPosition in interface IntermediateQuery

getAncestors

public it.unibz.inf.ontop.com.google.common.collect.ImmutableList<QueryNode> getAncestors(QueryNode descendantNode)

Description copied from interface: IntermediateQuery

From the parent to the oldest ancestor.

Specified by:

getAncestors in interface IntermediateQuery

getParent

public Optional<QueryNode> getParent(QueryNode node)

Specified by:

getParent in interface IntermediateQuery

getNextSibling

public Optional<QueryNode> getNextSibling(QueryNode node)

Specified by:

getNextSibling in interface IntermediateQuery

getFirstChild

public Optional<QueryNode> getFirstChild(QueryNode node)

Specified by:

getFirstChild in interface IntermediateQuery

getClosestConstructionNode

public ConstructionNode getClosestConstructionNode(QueryNode node)

Description copied from interface: IntermediateQuery

Returns itself if is a ConstructionNode or its first ancestor that is a construction node otherwise.

Specified by:

getClosestConstructionNode in interface IntermediateQuery

generateNewVariable

public Variable generateNewVariable()

Description copied from interface: IntermediateQuery

Returns a variable that is not used in the intermediate query.

Specified by:

generateNewVariable in interface IntermediateQuery

generateNewVariable

public Variable generateNewVariable(Variable formerVariable)

Description copied from interface: IntermediateQuery

Returns a variable that is not used in the intermediate query. The new variable always differs from the former one.

Specified by:

generateNewVariable in interface IntermediateQuery

clone

public IntermediateQuery clone()

Not appearing in the interface because users do not have to worry about it.

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

getExecutorRegistry

public ExecutorRegistry getExecutorRegistry()

Description copied from interface: IntermediateQuery

Not for end-users! Needed using when using specialized intermediate queries

Specified by:

getExecutorRegistry in interface IntermediateQuery

getFactory

public IntermediateQueryFactory getFactory()

Specified by:

getFactory in interface IntermediateQuery

getVariablesRequiredByAncestors

public it.unibz.inf.ontop.com.google.common.collect.ImmutableSet<Variable> getVariablesRequiredByAncestors(QueryNode queryNode)

Description copied from interface: IntermediateQuery

Minimal set of variables such that a construction node projecting exactly these variables could be inserted just above this node without altering the query semantics. The assumption is made that the query is consistent. Therefore this method should not be used for validation.

Specified by:

getVariablesRequiredByAncestors in interface IntermediateQuery

getSubquery

public IntermediateQuery getSubquery(QueryNode subQueryRoot,
                                     DistinctVariableOnlyDataAtom projectionAtom)

Specified by:

getSubquery in interface IntermediateQuery