/*
 * #!
 * Ontopia Navigator
 * #-
 * Copyright (C) 2001 - 2013 The Ontopia Project
 * #-
 * Licensed 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 net.ontopia.topicmaps.nav2.taglibs.TMvalue;

import java.util.Collection;
import javax.servlet.jsp.JspTagException;
import net.ontopia.infoset.fulltext.core.SearcherIF;
import net.ontopia.infoset.fulltext.topicmaps.TopicMapSearchResult;
import net.ontopia.topicmaps.core.TopicMapIF;
import net.ontopia.topicmaps.nav2.core.NavigatorRuntimeException;
import net.ontopia.topicmaps.nav2.taglibs.logic.ContextTag;
import net.ontopia.topicmaps.nav2.taglibs.value.BaseValueProducingTag;
import net.ontopia.topicmaps.nav2.utils.FrameworkUtils;
import net.ontopia.utils.OntopiaRuntimeException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * INTERNAL: Tag used for executing fulltext queries and producing
 * ranked list of topic map objects.
 */
public class FulltextTag extends BaseValueProducingTag {

  // initialization of logging facility
  protected static Logger log = LoggerFactory.getLogger(FulltextTag.class.getName());

  // tag attributes
  protected String index_path;
  protected String query;
  protected String idfield;
  
  public Collection process(Collection tmObjects) throws JspTagException {

    // Get topic map
    ContextTag contextTag = FrameworkUtils.getContextTag(pageContext);    

    // Get topic map from context
    TopicMapIF topicmap = contextTag.getTopicMap();
    String tmid = contextTag.getTopicMapId();
    
    if (topicmap == null)
      throw new NavigatorRuntimeException("FulltextTag found no topic map.");

    try {
      // Output debugging information
      if (log.isDebugEnabled()) {
        log.debug("Query: '" + query + "'");
      }
      
      // Create search engine
      SearcherIF sengine = (SearcherIF) topicmap.getIndex(SearcherIF.class.getName());
      if (sengine == null) {
        throw new NavigatorRuntimeException("Topicmap " + tmid + " has no SearcherIF index");
      }

      // Perform search
      TopicMapSearchResult result = new TopicMapSearchResult(topicmap, sengine.search(query));

      // Set object id field
      if (idfield != null) result.setObjectIdField(idfield);

      // Return search result
      return result;
    } catch (java.io.IOException e) {
      throw new OntopiaRuntimeException(e);
    }
  }

  // -----------------------------------------------------------------
  // Set methods for tag attributes
  // -----------------------------------------------------------------

  /**
   * INTERNAL: Set fulltext query.
   */
  public void setQuery(String query) {
    this.query = query;
  }
  
  /**
   * INTERNAL: Set fulltext index object id field.
   */
  public void setIdField(String idfield) {
    this.idfield = idfield;
  }
  
}