001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.stream.provider.twitter;
031
032import org.openimaj.util.api.auth.common.TwitterAPIToken;
033import org.openimaj.util.concurrent.ArrayBlockingDroppingQueue;
034import org.openimaj.util.concurrent.BlockingDroppingQueue;
035
036import twitter4j.Query;
037import twitter4j.Status;
038
039/**
040 * A concrete version of the {@link AbstractTwitterSearchDataset} which pushes
041 * the {@link Status}s into the stream.
042 * 
043 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
044 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
045 */
046public class TwitterSearchDataset extends AbstractTwitterSearchDataset<Status> {
047        /**
048         * Construct the dataset from the given API token and query. The stream is
049         * backed by an {@link ArrayBlockingDroppingQueue} with a single item
050         * capacity.
051         * 
052         * @param query
053         *            the Twitter search query
054         * @param token
055         *            the Twitter api authentication credentials
056         */
057        public TwitterSearchDataset(Query query, final TwitterAPIToken token) {
058                this(query, token, new ArrayBlockingDroppingQueue<Status>(1));
059        }
060
061        /**
062         * Construct the dataset from the given API token, query and buffer.
063         * 
064         * @param query
065         *            the Twitter search query
066         * @param token
067         *            the Twitter api authentication credentials
068         * @param buffer
069         *            the buffer to hold {@link Status}s before they are consumed.
070         */
071        public TwitterSearchDataset(Query query, final TwitterAPIToken token, BlockingDroppingQueue<Status> buffer) {
072                super(token, buffer, query);
073        }
074
075        @Override
076        protected void registerStatus(Query query, Status status, String rawjson) throws InterruptedException {
077                register(status);
078        }
079
080        @Override
081        public Query getQuery() {
082                return this.query;
083        }
084}