com.sindicetech.siren.index.ConstrainedNodesEnum Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of siren-core Show documentation
SIREn core module
The newest version!
/**
 * Copyright (c) 2014, Sindice Limited. All Rights Reserved.
 *
 * This file is part of the SIREn project.
 *
 * SIREn is a free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * SIREn 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this program. If not, see .
 */

package com.sindicetech.siren.index;

import java.io.IOException;

import org.apache.lucene.util.IntsRef;

import com.sindicetech.siren.util.NodeUtils;

/**
 * Abstraction of a {@link DocsNodesAndPositionsEnum} that filters nodes that
 * do not satisfy some constraints.
 *
 * 
 *
 * This {@link DocsNodesAndPositionsEnum} wraps another
 * {@link DocsNodesAndPositionsEnum} and applies the node constraints. It
 * filters all the nodes that do not satisfy the constraints.
 *
 * @see NodeUtils#isConstraintSatisfied(int[], int[], int[], boolean)
 */
public abstract class ConstrainedNodesEnum extends DocsNodesAndPositionsEnum {

  protected final DocsNodesAndPositionsEnum docsEnum;

  public ConstrainedNodesEnum(final DocsNodesAndPositionsEnum docsEnum) {
    this.docsEnum = docsEnum;
  }

  @Override
  public boolean nextDocument() throws IOException {
    return docsEnum.nextDocument();
  }

  @Override
  public abstract boolean nextNode() throws IOException;

  @Override
  public boolean skipTo(final int target) throws IOException {
    return docsEnum.skipTo(target);
  }

  @Override
  public int doc() {
    return docsEnum.doc();
  }

  @Override
  public IntsRef node() {
    return docsEnum.node();
  }

  @Override
  public boolean nextPosition() throws IOException {
    return docsEnum.nextPosition();
  }

  @Override
  public int pos() {
    return docsEnum.pos();
  }

  @Override
  public int termFreqInNode() throws IOException {
    return docsEnum.termFreqInNode();
  }

  @Override
  public int nodeFreqInDoc() throws IOException {
    return docsEnum.nodeFreqInDoc();
  }

}