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