org.openimaj.tools.twitter.modes.preprocessing

Class TwitterPreprocessingMode<T>

java.lang.Object

org.openimaj.tools.twitter.modes.preprocessing.TwitterPreprocessingMode<T>

Type Parameters:

T - The type of the analysis result

Direct Known Subclasses:

CountryCodeMode, LanguageDetectionMode, NERMode, SentimentExtractionMode, StemmingMode, StopwordMode, TokeniseMode

public abstract class TwitterPreprocessingMode<T>
extends Object

A processing mode that is able to process a tweet and also typed on the data which it analyses from the tweet (so it can return this data if required)

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
TwitterPreprocessingMode()

Method Summary

Modifier and Type	Method and Description
abstract String	getAnalysisKey()
abstract T	process(USMFStatus twitterStatus) Alters the twitter status in place with the analysis that is required to be performed
RDFAnalysisProvider	rdfAnalysisProvider()
static <Q> Q	results(USMFStatus status, TwitterPreprocessingMode<Q> mode) Given a twitter status, attempts to extract the analysis for this mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TwitterPreprocessingMode

public TwitterPreprocessingMode()

Method Detail

process

public abstract T process(USMFStatus twitterStatus)

Alters the twitter status in place with the analysis that is required to be performed

Parameters:

twitterStatus -

Returns:

for conveniance also returns the analysis

rdfAnalysisProvider

public RDFAnalysisProvider rdfAnalysisProvider()

Returns:

by default this adds no analysis and does nothing whatsoever

results

public static <Q> Q results(USMFStatus status,
                            TwitterPreprocessingMode<Q> mode)
                     throws Exception

Given a twitter status, attempts to extract the analysis for this mode. If the analysis does not exist, the provided mode instance is used to create the analysis. If the provided mode is null a new mode is created. This mode creation might be slow, be careful about using this in this way.

Type Parameters:

Q -

Parameters:

status - the twitter status to be analysed

mode - the mode to use if the analysis does no exist in the tweet

Returns:

the analysis results. These results are also injected into the tweet's analysis

Throws:

Exception

getAnalysisKey

public abstract String getAnalysisKey()

Returns:

the keys this mode adds to the twitter analysis map