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.FilterQuery;
037import twitter4j.Status;
038
039/**
040 * A concrete version of the {@link AbstractTwitterStreamDataset} which pushes
041 * the {@link Status}s into the stream.
042 * 
043 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
044 */
045public class TwitterStreamFilterDataset extends AbstractTwitterStatusesFilterDataset<Status> {
046        /**
047         * Construct the dataset from the given API token. The stream is backed by
048         * an {@link ArrayBlockingDroppingQueue} with a single item capacity.
049         * 
050         * @param query
051         *            the query
052         * @param token
053         *            the Twitter api authentication credentials
054         */
055        public TwitterStreamFilterDataset(FilterQuery query, final TwitterAPIToken token) {
056                this(query, token, new ArrayBlockingDroppingQueue<Status>(1));
057        }
058
059        /**
060         * Construct the dataset from the given API token. The stream is backed by
061         * an {@link ArrayBlockingDroppingQueue} with a single item capacity.
062         * 
063         * @param words
064         *            the query terms
065         * @param token
066         *            the Twitter api authentication credentials
067         */
068        public TwitterStreamFilterDataset(String[] words, final TwitterAPIToken token) {
069                this(new FilterQuery(0, null, words), token);
070        }
071
072        /**
073         * Construct the dataset from the given API token and buffer.
074         * 
075         * @param query
076         *            the query
077         * @param token
078         *            the Twitter api authentication credentials
079         * @param buffer
080         *            the buffer to hold {@link Status}s before they are consumed.
081         */
082        public TwitterStreamFilterDataset(FilterQuery query, final TwitterAPIToken token, BlockingDroppingQueue<Status> buffer)
083        {
084                super(query, token, buffer);
085        }
086
087        @Override
088        protected void registerStatus(Status status, String json) throws InterruptedException {
089                register(status);
090        }
091}