org.opencastproject.episode.api.SearchResultImpl.java Source code

Introduction

Here is the source code for org.opencastproject.episode.api.SearchResultImpl.java

Source

/**
 *  Copyright 2009, 2010 The Regents of the University of California
 *  Licensed under the Educational Community 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.osedu.org/licenses/ECL-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.opencastproject.episode.api;

import org.apache.commons.io.IOUtils;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;

/**
 * The search result represents a set of result items that has been compiled as a result for a search operation.
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "search-results", namespace = "http://search.opencastproject.org", propOrder = { "query",
        "resultSet" })
@XmlRootElement(name = "search-results", namespace = "http://search.opencastproject.org")
public class SearchResultImpl implements SearchResult {

    /** Context for serializing and deserializing */
    private static final JAXBContext context;

    static {
        try {
            context = JAXBContext.newInstance("org.opencastproject.episode.api",
                    SearchResultImpl.class.getClassLoader());
        } catch (JAXBException e) {
            throw new IllegalStateException(e);
        }
    }

    /**
     * Reads the search result from the input stream.
     * 
     * @param xml
     *          the input stream
     * @return the deserialized search result
     */
    public static SearchResultImpl valueOf(InputStream xml) {
        try {
            Unmarshaller unmarshaller = context.createUnmarshaller();
            Source source = new StreamSource(xml);
            return unmarshaller.unmarshal(source, SearchResultImpl.class).getValue();
        } catch (JAXBException e) {
            throw new IllegalStateException(e.getLinkedException() != null ? e.getLinkedException() : e);
        } finally {
            IOUtils.closeQuietly(xml);
        }
    }

    /** A list of search items. */
    @XmlElement(name = "result")
    private List<SearchResultItemImpl> resultSet = null;

    /** The query that yielded the result set */
    @XmlElement(name = "query")
    private String query = null;

    /** The pagination offset. */
    @XmlAttribute
    private long offset = 0;

    /** The pagination limit. Default is 10. */
    @XmlAttribute
    private long limit = 10;

    /** The number of hits total, regardless of the limit */
    @XmlAttribute
    private long total = 0;

    /** The search time in milliseconds */
    @XmlAttribute
    private long searchTime = 0;

    /**
     * A no-arg constructor needed by JAXB
     */
    public SearchResultImpl() {
        this.resultSet = new ArrayList<SearchResultItemImpl>();
    }

    /**
     * Creates a new and empty search result.
     * 
     * @param query
     *          the query
     */
    public SearchResultImpl(String query) {
        this();
        if (query == null)
            throw new IllegalArgumentException("Query cannot be null");
        this.query = query;
    }

    public SearchResultItem[] getItems() {
        return resultSet.toArray(new SearchResultItem[resultSet.size()]);
    }

    /**
     * Adds an item to the result set.
     * 
     * @param item
     *          the item to add
     */
    public void addItem(SearchResultItemImpl item) {
        if (item == null)
            throw new IllegalArgumentException("Parameter item cannot be null");
        resultSet.add(item);
    }

    public String getQuery() {
        return query;
    }

    public long size() {
        return resultSet != null ? resultSet.size() : 0;
    }

    public long getOffset() {
        return offset;
    }

    /**
     * Set the offset.
     * 
     * @param offset
     *          The offset.
     */
    public void setOffset(long offset) {
        this.offset = offset;
    }

    public long getLimit() {
        return limit;
    }

    /**
     * Set the limit.
     * 
     * @param limit
     *          The limit.
     */
    public void setLimit(long limit) {
        this.limit = limit;
    }

    public long getSearchTime() {
        return searchTime;
    }

    /**
     * Set the search time.
     * 
     * @param searchTime
     *          The time in ms.
     */
    public void setSearchTime(long searchTime) {
        this.searchTime = searchTime;
    }

    /**
     * Sets the total hit count.
     * 
     * @param total
     *          the total hit count
     */
    public void setTotal(long total) {
        this.total = total;
    }

    public long getTotalSize() {
        return total;
    }

    public long getPage() {
        if (limit != 0)
            return offset / limit;
        return 0;
    }

}