service.tut.pori.twitterjazz

Class TwitterExtractor

java.lang.Object

service.tut.pori.twitterjazz.TwitterExtractor

public class TwitterExtractor
extends java.lang.Object

High-level client for extracting profile details from Twitter. This class is NOT thread-safe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TwitterExtractor.ContentType Valid content types for a profile

Method Summary

Modifier and Type	Method and Description
static TwitterExtractor	getExtractor(UserIdentity userId)
java.util.List<TwitterPhotoDescription>	getPhotoDescriptions()
java.util.List<TwitterPhotoDescription>	getPhotoDescriptions(boolean generatedTags, java.util.Collection<java.lang.String> twitterUserIdFilter)
TwitterProfile	getProfile(java.util.EnumSet<TwitterExtractor.ContentType> contentTypes)
java.util.List<TwitterProfile>	getProfiles(java.util.EnumSet<TwitterExtractor.ContentType> contentTypes, java.lang.String[] screenNames)
java.util.List<TwitterStatusMessage>	getStatusMessages()
UserIdentity	getUserId()
java.util.List<TwitterVideoDescription>	getVideoDescriptions()
java.util.List<TwitterVideoDescription>	getVideoDescriptions(java.util.Collection<java.lang.String> twitterUserIdFilter)
boolean	isAbortOnRateLimit()
boolean	isFilterDescriptions() filter video and photo descriptions for descriptions not belonging to the profile owner
void	setAbortOnRateLimit(boolean abortOnRateLimit)
void	setFilterDescriptions(boolean filterDescriptions) filter video and photo descriptions for descriptions not belonging to the profile owner

Methods inherited from class java.lang.Object

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

Method Detail

getExtractor

public static TwitterExtractor getExtractor(UserIdentity userId)

Parameters:

userId -

Returns:

the extractor or null on failure

getProfiles

public java.util.List<TwitterProfile> getProfiles(java.util.EnumSet<TwitterExtractor.ContentType> contentTypes,
                                                  java.lang.String[] screenNames)

Parameters:

contentTypes -

screenNames -

Returns:

list of found profiles or null on failure

getProfile

public TwitterProfile getProfile(java.util.EnumSet<TwitterExtractor.ContentType> contentTypes)
                          throws java.lang.IllegalArgumentException

Parameters:

contentTypes -

Returns:

the profile or null on failure

Throws:

java.lang.IllegalArgumentException - on bad content types

getPhotoDescriptions

public java.util.List<TwitterPhotoDescription> getPhotoDescriptions()

Returns:

all photo descriptions found on the current user's timeline without generated tags

getPhotoDescriptions

public java.util.List<TwitterPhotoDescription> getPhotoDescriptions(boolean generatedTags,
                                                                    java.util.Collection<java.lang.String> twitterUserIdFilter)

Parameters:

generatedTags - if true the generated tags will be retrieved from the database

twitterUserIdFilter - if given, only descriptions from the given users will be returned

Returns:

list of photo descriptions or null if none was found

getVideoDescriptions

public java.util.List<TwitterVideoDescription> getVideoDescriptions()

Returns:

all video descriptions found on user's timeline

getVideoDescriptions

public java.util.List<TwitterVideoDescription> getVideoDescriptions(java.util.Collection<java.lang.String> twitterUserIdFilter)

Parameters:

twitterUserIdFilter - if given, only descriptions from these users will be returned

Returns:

list of video descriptions or null if none was found

getStatusMessages

public java.util.List<TwitterStatusMessage> getStatusMessages()

Returns:

list of status messages or null if none is available

getUserId

public UserIdentity getUserId()

Returns:

the userId

isFilterDescriptions

public boolean isFilterDescriptions()

filter video and photo descriptions for descriptions not belonging to the profile owner

Returns:

the filterDescriptions

setFilterDescriptions

public void setFilterDescriptions(boolean filterDescriptions)

filter video and photo descriptions for descriptions not belonging to the profile owner

Parameters:

filterDescriptions - the filterDescriptions to set

isAbortOnRateLimit

public boolean isAbortOnRateLimit()

Returns:

the abortOnRateLimit

setAbortOnRateLimit

public void setAbortOnRateLimit(boolean abortOnRateLimit)

Parameters:

abortOnRateLimit - the abortOnRateLimit to set