/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.jena.sparql.engine.iterator;

import org.apache.jena.atlas.io.IndentedWriter ;
import org.apache.jena.atlas.lib.Lib ;
import org.apache.jena.graph.Node ;
import org.apache.jena.query.QueryExecException ;
import org.apache.jena.sparql.core.Var ;
import org.apache.jena.sparql.engine.ExecutionContext ;
import org.apache.jena.sparql.engine.QueryIterator ;
import org.apache.jena.sparql.engine.binding.Binding ;
import org.apache.jena.sparql.engine.binding.BindingFactory ;
import org.apache.jena.sparql.serializer.SerializationContext ;
import org.apache.jena.sparql.util.FmtUtils ;

/** Extend each solution by a (var, node) 
 *  When used with mustBeNewVar=false, this is a join.
 *  If the input already has the variable assigned, then
 *  it must be the same (.equals) node and if it is not,
 *  the input row is rejected.
 *  @see QueryIterAssign
 *  @see QueryIterExtendByVar
 */ 

public class QueryIterAssignVarValue extends QueryIterProcessBinding
{
    private final Var var ;
    private final Node node ;
    private final boolean mustBeNewVar ;
    
    public QueryIterAssignVarValue(QueryIterator input, Var var, Node node, ExecutionContext qCxt)
    { 
        this(input, var, node, qCxt, false) ;
    }
    
    public QueryIterAssignVarValue(QueryIterator input, Var var, Node node, ExecutionContext qCxt, boolean mustBeNewVar)
    {
        super(input, qCxt) ;
        this.var = var ;
        this.node = node ;
        this.mustBeNewVar = mustBeNewVar ;
    }
    
    @Override
    public Binding accept(Binding binding)
    {
        if ( binding.contains(var) )
        {
            if ( mustBeNewVar )
                throw new QueryExecException("Already set: "+var) ;
            
            Node n2 = binding.get(var) ;
            if ( ! n2.equals(node) )
                // And filter out.
                return null ;
            else
                // Already in the binding with the value -> nothing to do. 
                return binding ;
        }
        
        return BindingFactory.binding(binding, var, node) ;
    }
    
    @Override
    protected void details(IndentedWriter out, SerializationContext cxt)
    { 
        out.print(Lib.className(this)) ;
        out.print(" ?"+var.toString()+" = "+FmtUtils.stringForNode(node, cxt)) ;
    }
}

@@ -1773,17 +1773,17 @@
 sBinding
-%0A
+ 
 %7B%0A    pr
@@ -1798,20 +1798,23 @@
 nal Var 
+    
 var
- 
 ;%0A    pr
@@ -1830,21 +1830,23 @@
 al Node 
+   
 node
- 
 ;%0A    pr
@@ -1877,23 +1877,18 @@
 BeNewVar
- 
 ;%0A
-    
 %0A    pub
@@ -1978,23 +1978,18 @@
 xt qCxt)
-%0A   
  %7B
- 
 %0A       
@@ -2024,25 +2024,24 @@
 , false)
- 
 ;%0A    %7D%0A
     %0A   
@@ -2028,28 +2028,24 @@
 lse);%0A    %7D%0A
-    
 %0A    public 
@@ -2153,20 +2153,16 @@
 eNewVar)
-%0A   
  %7B%0A     
@@ -2182,17 +2182,16 @@
 t, qCxt)
- 
 ;%0A      
@@ -2206,17 +2206,16 @@
 ar = var
- 
 ;%0A      
@@ -2232,17 +2232,16 @@
 e = node
- 
 ;%0A      
@@ -2274,25 +2274,24 @@
 BeNewVar
- 
 ;%0A    %7D%0A
     %0A   
@@ -2274,36 +2274,32 @@
 BeNewVar;%0A    %7D%0A
-    
 %0A    @Override%0A 
@@ -2339,20 +2339,16 @@
 binding)
-%0A   
  %7B%0A     
@@ -2378,24 +2378,16 @@
 s(var) )
-%0A       
  %7B%0A     
@@ -2477,28 +2477,17 @@
 t: %22
-+
+ + 
 var)
- 
 ;%0A
-            
 %0A   
@@ -2766,17 +2766,8 @@
   %7D%0A
-        %0A
     
@@ -2919,20 +2919,16 @@
 ext cxt)
-%0A   
  %7B %0A    

Tidy up.