/*
 * 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.solr.client.solrj.io.stream;

import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

import org.apache.solr.client.solrj.io.Tuple;
import org.apache.solr.client.solrj.io.comp.StreamComparator;
import org.apache.solr.client.solrj.io.stream.expr.Explanation;
import org.apache.solr.client.solrj.io.stream.expr.Explanation.ExpressionType;
import org.apache.solr.client.solrj.io.stream.expr.Expressible;
import org.apache.solr.client.solrj.io.stream.expr.StreamExplanation;
import org.apache.solr.client.solrj.io.stream.expr.StreamExpression;
import org.apache.solr.client.solrj.io.stream.expr.StreamFactory;


/**
 *  The NullStream Iterates over a TupleStream and eats the tuples. It returns the tuple count in the EOF tuple.
 *  Because the NullStreaam eats all the Tuples it see's it can be used as a simple tool for performance analysis of
 *  underlying streams.
 **/

public class CalculatorStream extends TupleStream implements Expressible {

  private static final long serialVersionUID = 1;
  private boolean finished;



  public CalculatorStream() throws IOException {
  }

  public CalculatorStream(StreamExpression expression, StreamFactory factory) throws IOException {
  }


  @Override
  public StreamExpression toExpression(StreamFactory factory) throws IOException{
    return toExpression(factory, true);
  }

  private StreamExpression toExpression(StreamFactory factory, boolean includeStreams) throws IOException {
    // function name
    StreamExpression expression = new StreamExpression(factory.getFunctionName(this.getClass()));

    return expression;
  }

  @Override
  public Explanation toExplanation(StreamFactory factory) throws IOException {

    return new StreamExplanation(getStreamNodeId().toString())
        .withFunctionName(factory.getFunctionName(this.getClass()))
        .withImplementingClass(this.getClass().getName())
        .withExpressionType(ExpressionType.STREAM_DECORATOR)
        .withExpression(toExpression(factory, false).toString());
  }

  public void setStreamContext(StreamContext context) {
  }

  public List<TupleStream> children() {
    List<TupleStream> l =  new ArrayList<TupleStream>();
    return l;
  }

  public void open() throws IOException {

  }

  public void close() throws IOException {
  }

  public Tuple read() throws IOException {

    if(finished) {
      HashMap m = new HashMap();
      m.put("EOF", true);
      Tuple tuple = new Tuple(m);
      return tuple;
    } else {
      HashMap m = new HashMap();
      Tuple tuple = new Tuple(m);
      finished = true;
      return tuple;
    }
  }

  /** Return the stream sort - ie, the order in which records are returned */
  public StreamComparator getStreamSort(){
    return null;
  }

  public int getCost() {
    return 0;
  }


}
@@ -1475,273 +1475,8 @@
 y;%0A%0A
-%0A/**%0A *  The NullStream Iterates over a TupleStream and eats the tuples. It returns the tuple count in the EOF tuple.%0A *  Because the NullStreaam eats all the Tuples it see's it can be used as a simple tool for performance analysis of%0A *  underlying streams.%0A **/%0A%0A
 publ

Remove incorrect code comment