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.tools.twitter.modes.preprocessing;
031
032import org.apache.jena.rdf.model.Model;
033import org.apache.jena.rdf.model.Resource;
034import org.openimaj.twitter.GeneralJSON;
035import org.openimaj.twitter.RDFAnalysisProvider;
036import org.openimaj.twitter.USMFStatus;
037
038/**
039 * A processing mode that is able to process a tweet and also typed on the data
040 * which it analyses from the tweet (so it can return this data if required)
041 *
042 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
043 * @param <T>
044 *            The type of the analysis result
045 *
046 */
047public abstract class TwitterPreprocessingMode<T> {
048
049        /**
050         * Alters the twitter status in place with the analysis that is required to
051         * be performed
052         *
053         * @param twitterStatus
054         * @return for conveniance also returns the analysis
055         */
056        public abstract T process(USMFStatus twitterStatus);
057
058        /**
059         * @return by default this adds no analysis and does nothing whatsoever
060         */
061        public RDFAnalysisProvider rdfAnalysisProvider() {
062                return new RDFAnalysisProvider() {
063
064                        @Override
065                        public void init() {
066                                // TODO Auto-generated method stub
067
068                        }
069
070                        @Override
071                        public void addAnalysis(Model m, Resource analysis, GeneralJSON analysisSource) {
072                                // TODO Auto-generated method stub
073
074                        }
075                };
076        }
077
078        /**
079         * Given a twitter status, attempts to extract the analysis for this mode.
080         * If the analysis does not exist, the provided mode instance is used to
081         * create the analysis. If the provided mode is null a new mode is created.
082         * This mode creation might be slow, be careful about using this in this
083         * way.
084         *
085         * @param <Q>
086         * @param status
087         *            the twitter status to be analysed
088         * @param mode
089         *            the mode to use if the analysis does no exist in the tweet
090         * @return the analysis results. These results are also injected into the
091         *         tweet's analysis
092         * @throws Exception
093         */
094        public static <Q> Q results(USMFStatus status, TwitterPreprocessingMode<Q> mode) throws Exception {
095                Q result = status.getAnalysis(mode.getAnalysisKey());
096                if (result == null) {
097                        result = mode.process(status);
098                }
099                return result;
100        }
101
102        /**
103         * @return the keys this mode adds to the twitter analysis map
104         */
105        public abstract String getAnalysisKey();
106}