AbstractResourceSearchResultItemImpl.java

/*
 *  Weblounge: Web Content Management System
 *  Copyright (c) 2011 The Weblounge Team
 *  http://weblounge.o2it.ch
 *
 *  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.ResourceMetadata;
import ch.entwine.weblounge.common.content.ResourceSearchResultItem;
import ch.entwine.weblounge.common.content.ResourceURI;
import ch.entwine.weblounge.common.url.WebUrl;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Base implementation for search result items that represent resources.
 */
public abstract class AbstractResourceSearchResultItemImpl extends SearchResultItemImpl implements ResourceSearchResultItem {

  /** The resource uri */
  protected ResourceURI uri = null;

  /** The resource metadata */
  protected Map<String, ResourceMetadata<?>> metadata = null;

  /**
   * Creates a new resource search result item.
   * 
   * @param uri
   *          the resource uri
   * @param url
   *          the resource url
   * @param relevance
   *          the relevance inside the current search
   * @param source
   *          the source of this search result item
   * @param metadata
   *          the search metadata
   */
  public AbstractResourceSearchResultItemImpl(ResourceURI uri, WebUrl url,
      double relevance, Object source, List<ResourceMetadata<?>> metadata) {
    super(uri.getIdentifier(), uri.getSite(), url, relevance, source);
    this.uri = uri;
    this.metadata = new HashMap<String, ResourceMetadata<?>>();
    for (ResourceMetadata<?> m : metadata) {
      this.metadata.put(m.getName(), m);
    }
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.ResourceSearchResultItem#getResourceURI()
   */
  public ResourceURI getResourceURI() {
    return uri;
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.SearchResultItem#getType()
   */
  public String getType() {
    return uri.getType();
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.ResourceSearchResultItem#getMetadata()
   */
  public List<ResourceMetadata<?>> getMetadata() {
    return new ArrayList<ResourceMetadata<?>>(metadata.values());
  }

  /**
   * {@inheritDoc}
   * 
   * @see ch.entwine.weblounge.common.content.ResourceSearchResultItem#getMetadataByKey(java.lang.String)
   */
  public ResourceMetadata<?> getMetadataByKey(String key) {
    return metadata.get(key);
  }

}