home | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Lucene example source code file (AbstractAllTermDocs.java)

This example Lucene source code file (AbstractAllTermDocs.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Lucene tags/keywords

abstractalltermdocs, abstractalltermdocs, io, ioexception, ioexception, termdocs, termdocs, unsupportedoperationexception, unsupportedoperationexception

The Lucene AbstractAllTermDocs.java source code

 * 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,
 * See the License for the specific language governing permissions and
 * limitations under the License.

package org.apache.lucene.index;

import java.io.IOException;

/** Base class for enumerating all but deleted docs.
 * <p>NOTE: this class is meant only to be used internally
 * by Lucene; it's only public so it can be shared across
 * packages.  This means the API is freely subject to
 * change, and, the class could be removed entirely, in any
 * Lucene release.  Use directly at your own risk! */
public abstract class AbstractAllTermDocs implements TermDocs {

  protected int maxDoc;
  protected int doc = -1;

  protected AbstractAllTermDocs(int maxDoc) {
    this.maxDoc = maxDoc;

  public void seek(Term term) throws IOException {
    if (term==null) {
      doc = -1;
    } else {
      throw new UnsupportedOperationException();

  public void seek(TermEnum termEnum) throws IOException {
    throw new UnsupportedOperationException();

  public int doc() {
    return doc;

  public int freq() {
    return 1;

  public boolean next() throws IOException {
    return skipTo(doc+1);

  public int read(int[] docs, int[] freqs) throws IOException {
    final int length = docs.length;
    int i = 0;
    while (i < length && doc < maxDoc) {
      if (!isDeleted(doc)) {
        docs[i] = doc;
        freqs[i] = 1;
    return i;

  public boolean skipTo(int target) throws IOException {
    doc = target;
    while (doc < maxDoc) {
      if (!isDeleted(doc)) {
        return true;
    return false;

  public void close() throws IOException {

  public abstract boolean isDeleted(int doc);

Other Lucene examples (source code examples)

Here is a short list of links related to this Lucene AbstractAllTermDocs.java source code file:

my book on functional programming


new blog posts


Copyright 1998-2019 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.