BasicIndexingFilterHbase.java

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

package org.apache.nutchbase.indexer.basic;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.apache.lucene.document.DateTools;

import org.apache.nutch.crawl.Inlink;
import org.apache.nutch.indexer.IndexingException;
import org.apache.nutch.indexer.NutchDocument;
import org.apache.nutch.indexer.lucene.LuceneWriter;
import org.apache.nutch.metadata.Nutch;

import org.apache.nutchbase.indexer.IndexingFilterHbase;
import org.apache.nutchbase.util.hbase.ImmutableRowPart;
import org.apache.nutchbase.util.hbase.TableColumns;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashSet;
import java.util.Set;

import org.apache.hadoop.conf.Configuration;

/** Adds basic searchable fields to a document. */
public class BasicIndexingFilterHbase implements IndexingFilterHbase {
  public static final Log LOG = LogFactory.getLog(BasicIndexingFilterHbase.class);

  private int MAX_TITLE_LENGTH;
  private Configuration conf;
  
  private static final Set<String> COLUMNS = new HashSet<String>();
  
  static {
    COLUMNS.add(TableColumns.TITLE_STR);
    COLUMNS.add(TableColumns.TEXT_STR);
    COLUMNS.add(TableColumns.FETCH_TIME_STR);
    COLUMNS.add(TableColumns.INLINKS_STR);
  }

  public NutchDocument filter(NutchDocument doc, String url, ImmutableRowPart row)
    throws IndexingException {

    String reprUrl = null;
    if (row.hasColumn(TableColumns.REPR_URL))
      reprUrl = row.getReprUrl();
    
    String host = null;
    try {
      URL u;
      if (reprUrl!= null) {
        u = new URL(reprUrl);
      } else {
        u = new URL(url);
      }
      host = u.getHost();
    } catch (MalformedURLException e) {
      throw new IndexingException(e);
    }

    if (host != null) {
      // add host as un-stored, indexed and tokenized
      doc.add("host", host);
      // add site as un-stored, indexed and un-tokenized
      doc.add("site", host);
    }

    // url is both stored and indexed, so it's both searchable and returned
    doc.add("url", reprUrl == null ? url : reprUrl);
    
    if (reprUrl != null) {
      // also store original url as both stored and indexes
      doc.add("orig", url);
    }

    // content is indexed, so that it's searchable, but not stored in index
    doc.add("content", row.getText());
    
    // title
    String title = row.getTitle();
    if (title.length() > MAX_TITLE_LENGTH) {      // truncate title if needed
      title = title.substring(0, MAX_TITLE_LENGTH);
    }
    // add title indexed and stored so that it can be displayed
    doc.add("title", title);
    // add cached content/summary display policy, if available
    String caching = row.getMetaAsString(Nutch.CACHING_FORBIDDEN_KEY);
    if (caching != null && !caching.equals(Nutch.CACHING_FORBIDDEN_NONE)) {    
      doc.add("cache", caching);
    }
    
    // add timestamp when fetched, for deduplication
    doc.add("tstamp",
        DateTools.timeToString(row.getFetchTime(), DateTools.Resolution.MILLISECOND));
    
    // TODO: move anchors to its own plugin
    for (Inlink inlink : row.getInlinks()) {
      doc.add("anchor", inlink.getAnchor());
    }
    
    return doc;
  }
  
  public void addIndexBackendOptions(Configuration conf) {

    ///////////////////////////
    //    add lucene options   //
    ///////////////////////////

    // host is un-stored, indexed and tokenized
    LuceneWriter.addFieldOptions("host", LuceneWriter.STORE.NO,
        LuceneWriter.INDEX.TOKENIZED, conf);

    // site is un-stored, indexed and un-tokenized
    LuceneWriter.addFieldOptions("site", LuceneWriter.STORE.NO,
        LuceneWriter.INDEX.UNTOKENIZED, conf);

    // url is both stored and indexed, so it's both searchable and returned
    LuceneWriter.addFieldOptions("url", LuceneWriter.STORE.YES,
        LuceneWriter.INDEX.TOKENIZED, conf);

    // content is indexed, so that it's searchable, but not stored in index
    LuceneWriter.addFieldOptions("content", LuceneWriter.STORE.NO,
        LuceneWriter.INDEX.TOKENIZED, conf);

    // anchors are indexed, so they're searchable, but not stored in index
    LuceneWriter.addFieldOptions("anchor", LuceneWriter.STORE.NO,
        LuceneWriter.INDEX.TOKENIZED, conf);

    // title is indexed and stored so that it can be displayed
    LuceneWriter.addFieldOptions("title", LuceneWriter.STORE.YES,
        LuceneWriter.INDEX.TOKENIZED, conf);

    LuceneWriter.addFieldOptions("cache", LuceneWriter.STORE.YES, LuceneWriter.INDEX.NO, conf);
    LuceneWriter.addFieldOptions("tstamp", LuceneWriter.STORE.YES, LuceneWriter.INDEX.NO, conf);
  }

  public void setConf(Configuration conf) {
    this.conf = conf;
    this.MAX_TITLE_LENGTH = conf.getInt("indexer.max.title.length", 100);
  }

  public Configuration getConf() {
    return this.conf;
  }

  public Set<String> getColumnSet() {
    return COLUMNS;
  }

}