001/**
002 * Copyright (c) 2012, 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.hadoop.tools.twitter.utils;
031
032import java.io.DataInput;
033import java.io.DataOutput;
034import java.io.IOException;
035
036import org.openimaj.io.ReadWriteableBinary;
037
038/**
039 * Class encapsulating a number of tweets across which certain words were seen
040 * 
041 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
042 *
043 */
044public class TimeperiodTweetCountWordCount implements ReadWriteableBinary{
045        
046        /**
047         * The timeperiod of these counts
048         */
049        public long timeperiod;
050        /**
051         * The word counts (of an implicitly defined individual word) in this time period
052         */
053        public long wordcount;
054        /**
055         * The total number of tweets in this time period
056         */
057        public long tweetcount;
058        /**
059         * empty words and 0 tweets
060         */
061        public TimeperiodTweetCountWordCount() {
062        }
063        
064        /**
065         * @param timeperiod
066         * @param wordcount
067         * @param tweetcount
068         */
069        public TimeperiodTweetCountWordCount(long timeperiod, long wordcount,long tweetcount) {
070                this.timeperiod = timeperiod;
071                this.wordcount = wordcount;
072                this.tweetcount = tweetcount;
073        }
074
075        @Override
076        public void readBinary(DataInput in) throws IOException {
077                this.timeperiod = in.readLong();
078                this.wordcount = in.readLong();
079                this.tweetcount =in.readLong();
080        }
081
082        @Override
083        public byte[] binaryHeader() {
084                return "".getBytes();
085        }
086
087        @Override
088        public void writeBinary(final DataOutput out) throws IOException {
089                out.writeLong(timeperiod);
090                out.writeLong(wordcount);
091                out.writeLong(tweetcount);
092        }
093        
094        @Override
095        public boolean equals(Object other){
096                if(!(other instanceof TimeperiodTweetCountWordCount))return false;
097                TimeperiodTweetCountWordCount that = (TimeperiodTweetCountWordCount)other;
098                return this.timeperiod == that.timeperiod && this.tweetcount == that.tweetcount && this.wordcount == that.wordcount;
099                
100        }
101}