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.Status;
037
038/**
039 * A concrete version of the {@link AbstractTwitterStreamDataset} which pushes
040 * the {@link Status}s into the stream.
041 * 
042 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
043 */
044public class TwitterStreamDataset extends AbstractTwitterStreamDataset<Status> {
045        /**
046         * Construct the dataset from the given API token. The stream is backed by
047         * an {@link ArrayBlockingDroppingQueue} with a single item capacity.
048         * 
049         * @param token
050         *            the Twitter api authentication credentials
051         */
052        public TwitterStreamDataset(final TwitterAPIToken token) {
053                this(token, new ArrayBlockingDroppingQueue<Status>(1));
054        }
055
056        /**
057         * Construct the dataset from the given API token and buffer.
058         * 
059         * @param token
060         *            the Twitter api authentication credentials
061         * @param buffer
062         *            the buffer to hold {@link Status}s before they are consumed.
063         */
064        public TwitterStreamDataset(final TwitterAPIToken token, BlockingDroppingQueue<Status> buffer) {
065                super(token, buffer);
066        }
067
068        @Override
069        protected void registerStatus(Status status, String json) throws InterruptedException {
070                register(status);
071        }
072}