proj.zoie.api.DocIDMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zoie-core Show documentation
zoie core library
There is a newer version: 3.3.0

package proj.zoie.api;

import java.util.Arrays;

import proj.zoie.api.impl.util.MemoryManager;

/**
 * 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.
 */

/**
 * Maps a UID to the internal docid.
 */
public interface DocIDMapper
{
  /**
   * doc id not found indicator
   */
  public static final int NOT_FOUND = -1;
  /**
   * maps uid to a lucene docid
   * @param uid UID to be mapped.
   * @return {@link #NOT_FOUND} if uid is not found
   */
  int getDocID(long uid);
  
  int quickGetDocID(long uid);
  public int getReaderIndex(long uid);
  public ZoieIndexReader[] getSubReaders();
  public int[] getStarts();

  public T getDocIDArray(long[] uids);
  public T getDocIDArray(int [] uids);
  
  public static final class DocIDArray
  {
    public static final MemoryManager memMgr = new MemoryManager(new MemoryManager.Initializer()
        {

      public void init(int[] buf)
      {
        Arrays.fill(buf, DocIDMapper.NOT_FOUND);
      }

      public int[] newInstance(int size)
      {
        int[] ret = new int[size];
        init(ret);
        return ret;
      }

      public int size(int[] buf)
      {
        assert buf!=null;
        return buf.length;
      }
        });

    public int[] docids;
    public int size;

    public DocIDArray(int size)
    {
      this.size = size;
      docids = memMgr.get(size);
    }
    
    public static DocIDArray newInstance(int size)
    {
      return new DocIDArray(size);
    }
    public void close()
    {
      memMgr.release(docids);
      docids = null;
    }
  }
}