com.signalcollect.triplerush.vertices.Binding.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of triplerush_2.11 Show documentation
triplerush
The newest version!
/*
 *  @author Philip Stutz
 *  @author Mihaela Verman
 *
 *  Copyright 2013 University of Zurich
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package com.signalcollect.triplerush.vertices

import com.signalcollect.{ Edge, GraphEditor }
import com.signalcollect.triplerush.{ IndexStructure, OperationIds }
import com.signalcollect.triplerush.QueryParticle.arrayToParticle

trait Binding extends IndexVertex[Any] {

  def bindIndividualQuery(childDelta: Int, queryParticle: Array[Int]): Array[Int]

  def processQuery(query: Array[Int], graphEditor: GraphEditor[Long, Any]): Unit = {
    bindQueryToAllTriples(query, graphEditor)
  }

  def bindQueryToAllTriples(query: Array[Int], graphEditor: GraphEditor[Long, Any]): Unit = {
    if (!query.isBindingQuery &&
      query.numberOfPatterns == 1 &&
      query.isSimpleToBind) {
      // Take a shortcut and don't actually do the binding, just send the result count.
      // The isSimpleToBind check excludes complicated cases, where a binding might fail.
      val queryVertexId = OperationIds.embedInLong(query.queryId)
      graphEditor.sendSignal(edgeCount, queryVertexId)
      graphEditor.sendSignal(query.tickets, queryVertexId)
    } else {
      val edges = edgeCount
      val totalTickets = query.tickets
      val absoluteValueOfTotalTickets = if (totalTickets < 0) -totalTickets else totalTickets // inlined math.abs
      val avg = absoluteValueOfTotalTickets / edges
      val complete = avg > 0 && totalTickets > 0
      var extras = absoluteValueOfTotalTickets % edges
      val averageTicketQuery = query.copyWithTickets(avg, complete)
      val aboveAverageTicketQuery = query.copyWithTickets(avg + 1, complete)
      def bind(childDelta: Int): Unit = {
        if (extras > 0) {
          extras -= 1
          handleQueryBinding(childDelta, aboveAverageTicketQuery, graphEditor)
        } else if (avg > 0) {
          handleQueryBinding(childDelta, averageTicketQuery, graphEditor)
        }
      }
      foreachChildDelta(bind)
    }
  }

  def handleQueryBinding(
    childDelta: Int,
    query: Array[Int],
    graphEditor: GraphEditor[Long, Any]): Unit = {
    val boundParticle = bindIndividualQuery(childDelta, query)
    if (boundParticle != null) {
      routeSuccessfullyBound(boundParticle, graphEditor)
    } else {
      // Failed to bind, send to query vertex.
      val queryVertexId = OperationIds.embedInLong(query.queryId)
      graphEditor.sendSignal(query.tickets, queryVertexId)
    }
  }

  def routeSuccessfullyBound(
    boundParticle: Array[Int],
    graphEditor: GraphEditor[Long, Any]): Unit = {
    if (boundParticle.isResult) {
      // Query successful, send to query vertex.
      val queryVertexId = OperationIds.embedInLong(boundParticle.queryId)
      if (boundParticle.isBindingQuery) {
        graphEditor.sendSignal(boundParticle, queryVertexId)
      } else {
        graphEditor.sendSignal(1, queryVertexId)
        graphEditor.sendSignal(boundParticle.tickets, queryVertexId)
      }
    } else {
      graphEditor.sendSignal(boundParticle, boundParticle.routingAddress)
    }
  }

}