org.apache.lucene.facet.taxonomy.writercache.cl2o.Cl2oTaxonomyWriterCache Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of lucene-facet Show documentation
Package for Faceted Indexing and Search
There is a newer version: 9.11.1
package org.apache.lucene.facet.taxonomy.writercache.cl2o;

import org.apache.lucene.facet.taxonomy.CategoryPath;
import org.apache.lucene.facet.taxonomy.writercache.TaxonomyWriterCache;

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

/**
 * {@link TaxonomyWriterCache} using {@link CompactLabelToOrdinal}. Although
 * called cache, it maintains in memory all the mappings from category to
 * ordinal, relying on that {@link CompactLabelToOrdinal} is an efficient
 * mapping for this purpose.
 * 
 * @lucene.experimental
 */
public class Cl2oTaxonomyWriterCache implements TaxonomyWriterCache {  

  private CompactLabelToOrdinal cache;

  public Cl2oTaxonomyWriterCache(int initialCapcity, float loadFactor, int numHashArrays) {
    this.cache = new CompactLabelToOrdinal(initialCapcity, loadFactor, numHashArrays);
  }

  public void close() {
    cache=null;
  }

  public boolean hasRoom(int n) {
    // This cache is unlimited, so we always have room for remembering more:
    return true;
  }

  public int get(CategoryPath categoryPath) {
    return cache.getOrdinal(categoryPath);
  }

  public int get(CategoryPath categoryPath, int length) {
    if (length<0 || length>categoryPath.length()) {
      length = categoryPath.length();
    }
    return cache.getOrdinal(categoryPath, length);
  }

  public boolean put(CategoryPath categoryPath, int ordinal) {
    cache.addLabel(categoryPath, ordinal);
    // Tell the caller we didn't clear part of the cache, so it doesn't
    // have to flush its on-disk index now
    return false;
  }

  public boolean put(CategoryPath categoryPath, int prefixLen, int ordinal) {
    cache.addLabel(categoryPath, prefixLen, ordinal);
    // Tell the caller we didn't clear part of the cache, so it doesn't
    // have to flush its on-disk index now
    return false;
  }

  /**
   * Returns the number of bytes in memory used by this object.
   * @return Number of bytes in memory used by this object.
   */
  public int getMemoryUsage() {
    int memoryUsage = (this.cache == null) ? 0 : this.cache.getMemoryUsage();
    return memoryUsage;
  }

}