SearchResultImpl.java

/*
 *  Weblounge: Web Content Management System
 *  Copyright (c) 2003 - 2011 The Weblounge Team
 *  http://entwinemedia.com/weblounge
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software Foundation
 *  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

package ch.entwine.weblounge.common.impl.content;

import ch.entwine.weblounge.common.content.SearchQuery;
import ch.entwine.weblounge.common.content.SearchResult;
import ch.entwine.weblounge.common.content.SearchResultItem;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * Default implementation for a search result.
 */
public class SearchResultImpl implements SearchResult {

  /** The query that led to this search result */
  protected SearchQuery query = null;

  /** The search offset */
  protected long offset = 0;

  /** The search limit */
  protected long limit = 0;

  /** The total number of appearances of the search criteria */
  protected long hitCount = 0;

  /** The total size of the search result set */
  protected long documentCount = 0;

  /** The time it took to do the search in ms */
  protected long time = 0;

  /** Flag to indicate the sorted state */
  protected boolean sorted = true;

  /** The search result */
  protected List<SearchResultItem> result = null;

  /**
   * Creates a search result that was created using the given query. Note that
   * <code>hits</code> indicates the overall number of appearances of the search
   * term, while size is equal to the number of documents that contain those
   * <code>hits</code> hits.
   * 
   * @param query
   *          the query
   * @param hitCount
   *          the number of hits
   * @param documentCount
   *          the total size of the result set
   */
  public SearchResultImpl(SearchQuery query, long hitCount, long documentCount) {
    this.query = query;
    this.offset = query.getOffset();
    this.limit = query.getLimit();
    this.hitCount = hitCount;
    this.documentCount = documentCount;
  }

  /**
   * Adds the given search result item to the result set.
   * 
   * @param item
   *          the result item
   */
  public void addResultItem(SearchResultItem item) {
    if (result == null)
      result = new ArrayList<SearchResultItem>();
    result.add(item);
    sorted = false;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#getItems()
   */
  public SearchResultItem[] getItems() {
    if (result == null)
      return new SearchResultItem[] {};
    if (!sorted) {
      Collections.sort(result);
      sorted = true;
    }
    return result.toArray(new SearchResultItem[result.size()]);
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#getLimit()
   */
  public long getLimit() {
    return limit;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#getOffset()
   */
  public long getOffset() {
    return offset;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#getPage()
   */
  public long getPage() {
    if (offset == 0 || limit == 0)
      return 1;
    return (long) Math.floor(offset / limit) + 1;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#getPageSize()
   */
  public long getPageSize() {
    return result != null ? result.size() : 0;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#getQuery()
   */
  public SearchQuery getQuery() {
    return query;
  }

  /**
   * Sets the search time in milliseconds.
   * 
   * @param time
   *          the time
   */
  public void setSearchTime(long time) {
    this.time = time;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#getSearchTime()
   */
  public long getSearchTime() {
    return time;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#getHitCount()
   */
  public long getHitCount() {
    return hitCount;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#getDocumentCount()
   */
  public long getDocumentCount() {
    return result != null ? result.size() : documentCount;
  }

  /**
   * Sets the document count.
   * 
   * @param count
   *          the number of documents in this search result
   */
  public void setDocumentCount(long count) {
    this.documentCount = count;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResult#toXml()
   */
  public String toXml() {
    StringBuffer buf = new StringBuffer();
    buf.append("<searchresult ");
    buf.append("documents=\"").append(getDocumentCount()).append("\" ");
    buf.append("hits=\"").append(getHitCount()).append("\" ");
    buf.append("offset=\"").append(getOffset()).append("\" ");
    if (limit > 0)
      buf.append("limit=\"").append(getLimit()).append("\" ");
    buf.append("page=\"").append(getPage()).append("\" ");
    buf.append("pagesize=\"").append(getPageSize()).append("\"");
    buf.append(">");

    // Query and execution time
    buf.append("<time>").append(getSearchTime()).append("</time>");
    buf.append("<query>").append(getQuery()).append("</query>");

    // Result items
    for (SearchResultItem item : getItems()) {
      buf.append(item.toXml());
    }

    buf.append("</searchresult>");
    return buf.toString();
  }

}