/*
 * @(#)NextDocGenerator.java	1.6 06/10/30
 * 
 * Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 * 
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 * 
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

/**
 * @date   1/13/98
 * @author Jacek R. Ambroziak
 * @group  Sun Microsystems Laboratories
 */

package com.sun.java.help.search;

class NextDocGenerator
{
  private int                   _document;
  private final int              _concept;
  private final int              _queryMask;
  private final ConceptData      _terms;
  private final NonnegativeIntegerGenerator  _iterator;

  public NextDocGenerator(ConceptData cd, SearchEnvironment env)
  {
    _document = 0;
    _concept = cd.getConcept();
    _queryMask = cd.getQueryMask();
    _terms = cd;
    _iterator = env.getDocumentIterator(_concept);
  }
  
  public int first() throws Exception {
    return _document =
      _iterator != null ? _iterator.first() : NonnegativeIntegerGenerator.END;
  }
  
  public int next() throws Exception {
    return _document = _iterator.next();
  }
  
  public int getDocument() {
    return _document;
  }
  
  public int getConcept() {
    return _concept;
  }
  
  public ConceptData getTerms() {
    return _terms;
  }
  
  public int getQueryMask() {
    return _queryMask;
  }
  
  // for sorting
  public boolean compareWith(NextDocGenerator other)
  {
    return _document > other._document  
      || _document == other._document && _concept > other._concept;
  }

  public boolean smallerThan(NextDocGenerator other)
  {
    return _document < other._document  
      || _document == other._document && _concept < other._concept;
  }
}
