SimpleFacetHandler.java

package com.browseengine.bobo.facets.impl;

import java.io.IOException;
import java.util.Map;
import java.util.Properties;
import java.util.Set;

import org.apache.lucene.search.Explanation;

import com.browseengine.bobo.api.BoboSegmentReader;
import com.browseengine.bobo.api.BrowseSelection;
import com.browseengine.bobo.api.FacetSpec;
import com.browseengine.bobo.facets.FacetCountCollector;
import com.browseengine.bobo.facets.FacetCountCollectorSource;
import com.browseengine.bobo.facets.FacetHandler;
import com.browseengine.bobo.facets.data.FacetDataCache;
import com.browseengine.bobo.facets.data.TermListFactory;
import com.browseengine.bobo.facets.filter.AdaptiveFacetFilter;
import com.browseengine.bobo.facets.filter.AdaptiveFacetFilter.FacetDataCacheBuilder;
import com.browseengine.bobo.facets.filter.EmptyFilter;
import com.browseengine.bobo.facets.filter.FacetFilter;
import com.browseengine.bobo.facets.filter.FacetOrFilter;
import com.browseengine.bobo.facets.filter.RandomAccessFilter;
import com.browseengine.bobo.facets.filter.RandomAccessNotFilter;
import com.browseengine.bobo.query.scoring.BoboDocScorer;
import com.browseengine.bobo.query.scoring.FacetScoreable;
import com.browseengine.bobo.query.scoring.FacetTermScoringFunctionFactory;
import com.browseengine.bobo.sort.DocComparatorSource;
import com.browseengine.bobo.util.BigIntArray;

public class SimpleFacetHandler extends FacetHandler<FacetDataCache<?>> implements FacetScoreable {
  @SuppressWarnings("rawtypes")
  protected TermListFactory _termListFactory;
  protected final String _indexFieldName;

  public SimpleFacetHandler(String name, String indexFieldName, TermListFactory<?> termListFactory,
      Set<String> dependsOn) {
    super(name, dependsOn);
    _indexFieldName = indexFieldName;
    _termListFactory = termListFactory;
  }

  public SimpleFacetHandler(String name, TermListFactory<?> termListFactory, Set<String> dependsOn) {
    this(name, name, termListFactory, dependsOn);
  }

  public SimpleFacetHandler(String name, String indexFieldName, TermListFactory<?> termListFactory) {
    this(name, indexFieldName, termListFactory, null);
  }

  public SimpleFacetHandler(String name, TermListFactory<?> termListFactory) {
    this(name, name, termListFactory);
  }

  public SimpleFacetHandler(String name) {
    this(name, name, null);
  }

  public SimpleFacetHandler(String name, String indexFieldName) {
    this(name, indexFieldName, null);
  }

  @Override
  public int getNumItems(BoboSegmentReader reader, int id) {
    FacetDataCache<?> data = getFacetData(reader);
    if (data == null) return 0;
    return data.getNumItems(id);
  }

  @Override
  public DocComparatorSource getDocComparatorSource() {
    return new FacetDataCache.FacetDocComparatorSource(this);
  }

  @Override
  public String[] getFieldValues(BoboSegmentReader reader, int id) {
    FacetDataCache<?> dataCache = getFacetData(reader);
    if (dataCache != null) {
      return new String[] { dataCache.valArray.get(dataCache.orderArray.get(id)) };
    }
    return new String[0];
  }

  @Override
  public Object[] getRawFieldValues(BoboSegmentReader reader, int id) {
    FacetDataCache<?> dataCache = getFacetData(reader);
    if (dataCache != null) {
      return new Object[] { dataCache.valArray.getRawValue(dataCache.orderArray.get(id)) };
    }
    return new String[0];
  }

  @Override
  public RandomAccessFilter buildRandomAccessFilter(String value, Properties prop)
      throws IOException {
    FacetFilter f = new FacetFilter(this, value);
    AdaptiveFacetFilter af = new AdaptiveFacetFilter(new FacetDataCacheBuilder() {

      @Override
      public FacetDataCache<?> build(BoboSegmentReader reader) {
        return getFacetData(reader);
      }

      @Override
      public String getName() {
        return SimpleFacetHandler.this.getName();
      }

      @Override
      public String getIndexFieldName() {
        return _indexFieldName;
      }

    }, f, new String[] { value }, false);
    return af;
  }

  @Override
  public RandomAccessFilter buildRandomAccessAndFilter(String[] vals, Properties prop)
      throws IOException {
    if (vals.length > 1) {
      return EmptyFilter.getInstance();
    } else {
      return buildRandomAccessFilter(vals[0], prop);
    }
  }

  @Override
  public RandomAccessFilter buildRandomAccessOrFilter(String[] vals, Properties prop, boolean isNot)
      throws IOException {
    RandomAccessFilter filter = null;

    if (vals.length > 1) {
      RandomAccessFilter f = new FacetOrFilter(this, vals, false);
      filter = new AdaptiveFacetFilter(new FacetDataCacheBuilder() {

        @Override
        public FacetDataCache<?> build(BoboSegmentReader reader) {
          return getFacetData(reader);
        }

        @Override
        public String getName() {
          return SimpleFacetHandler.this.getName();
        }

        @Override
        public String getIndexFieldName() {
          return _indexFieldName;
        }

      }, f, vals, isNot);
    } else if (vals.length == 1) {
      filter = buildRandomAccessFilter(vals[0], prop);
    } else {
      filter = EmptyFilter.getInstance();
    }

    if (isNot) {
      filter = new RandomAccessNotFilter(filter);
    }

    return filter;
  }

  @Override
  public FacetCountCollectorSource getFacetCountCollectorSource(final BrowseSelection sel,
      final FacetSpec ospec) {
    return getFacetCountCollectorSource(sel, ospec, false);
  }

  @Override
  public FacetCountCollectorSource getFacetCountCollectorSource(final BrowseSelection sel,
      final FacetSpec ospec, final boolean groupMode) {
    if (groupMode) {
      return new FacetCountCollectorSource() {
        @Override
        public FacetCountCollector getFacetCountCollector(BoboSegmentReader reader, int docBase) {
          FacetDataCache<?> dataCache = SimpleFacetHandler.this.getFacetData(reader);
          return new SimpleGroupByFacetCountCollector(_name, dataCache, docBase, sel, ospec);
        }
      };
    } else {
      return new FacetCountCollectorSource() {
        @Override
        public FacetCountCollector getFacetCountCollector(BoboSegmentReader reader, int docBase) {
          FacetDataCache<?> dataCache = SimpleFacetHandler.this.getFacetData(reader);
          return new SimpleFacetCountCollector(_name, dataCache, docBase, sel, ospec);
        }
      };
    }
  }

  @SuppressWarnings({ "unchecked", "rawtypes" })
  @Override
  public FacetDataCache load(BoboSegmentReader reader) throws IOException {
    FacetDataCache<?> dataCache = new FacetDataCache();
    dataCache.load(_indexFieldName, reader, _termListFactory);
    return dataCache;
  }

  @Override
  public BoboDocScorer getDocScorer(BoboSegmentReader reader,
      FacetTermScoringFunctionFactory scoringFunctionFactory, Map<String, Float> boostMap) {
    FacetDataCache<?> dataCache = getFacetData(reader);
    float[] boostList = BoboDocScorer.buildBoostList(dataCache.valArray, boostMap);
    return new SimpleBoboDocScorer(dataCache, scoringFunctionFactory, boostList);
  }

  public static final class SimpleFacetCountCollector extends DefaultFacetCountCollector {
    public SimpleFacetCountCollector(String name, FacetDataCache<?> dataCache, int docBase,
        BrowseSelection sel, FacetSpec ospec) {
      super(name, dataCache, docBase, sel, ospec);
    }

    @Override
    public final void collect(int docid) {
      int index = _array.get(docid);
      _count.add(index, _count.get(index) + 1);
    }

    @Override
    public final void collectAll() {
      _count = BigIntArray.fromArray(_dataCache.freqs);
    }
  }

  public static final class SimpleGroupByFacetCountCollector extends GroupByFacetCountCollector {
    protected int _totalGroups;

    public SimpleGroupByFacetCountCollector(String name, FacetDataCache<?> dataCache, int docBase,
        BrowseSelection sel, FacetSpec ospec) {
      super(name, dataCache, docBase, sel, ospec);
      _totalGroups = 0;
    }

    @Override
    public final void collect(int docid) {
      int index = _array.get(docid);
      int newValue = _count.get(index) + 1;
      _count.add(index, newValue);
      if (newValue <= 1) ++_totalGroups;
    }

    @Override
    public final void collectAll() {
      _count = BigIntArray.fromArray(_dataCache.freqs);
      _totalGroups = -1;
    }

    @Override
    public final int getTotalGroups() {
      if (_totalGroups >= 0) return _totalGroups;

      // If the user calls collectAll instead of collect, we have to collect all the groups here:
      _totalGroups = 0;
      for (int i = 0; i < _count.size(); i++) {
        int c = _count.get(i);
        if (c > 0) ++_totalGroups;
      }
      return _totalGroups;
    }
  }

  public static final class SimpleBoboDocScorer extends BoboDocScorer {
    protected final FacetDataCache<?> _dataCache;

    public SimpleBoboDocScorer(FacetDataCache<?> dataCache,
        FacetTermScoringFunctionFactory scoreFunctionFactory, float[] boostList) {
      super(scoreFunctionFactory.getFacetTermScoringFunction(dataCache.valArray.size(),
        dataCache.orderArray.size()), boostList);
      _dataCache = dataCache;
    }

    @Override
    public Explanation explain(int doc) {
      int idx = _dataCache.orderArray.get(doc);
      return _function.explain(_dataCache.freqs[idx], _boostList[idx]);
    }

    @Override
    public final float score(int docid) {
      int idx = _dataCache.orderArray.get(docid);
      return _function.score(_dataCache.freqs[idx], _boostList[idx]);
    }
  }
}