TweetSearcher
Runs a search for Twitter™ entries that contain the given query. Access to the Twitter search API is rate-limited. Excessive searching in a given time period will result in search requests being denied. The exact rate limit information for the search API may be found at the search API documentation page: http://dev.twitter.com/docs/api/1.1/get/search/tweets
Output Ports
Upon successful completion of the search, the transformer will output a new feature for each tweet in the search results. Each output feature will contain several attributes:
_tweet_id: The identification number of the search result.
_tweet_user: The name of the Twitter user who created the search result.
_tweet_text: The text of the search result.
_tweet_created_at: The date and time of the status update. This will be formatted in the standard FME date/time format: YYYYMMDDHHMMSS
_tweet_search_result: The JSON text of the search result. This can be further examined via the JSONFragmenter and JSONExtractor transformers.
If the search could not be completed, the feature will be output through the Error output port, and will have the following new attributes:
_twitter_search_result: If a response was received from the Twitter server, it will be stored in this attribute.
_twitter_error: If the Twitter response contained an error message, it will be stored in this attribute.
Parameters
Search Parameters
Type a search query or select the name of an attribute that contains the query.
Select the type of Tweets to search for. The options are Recent, Popular and Mixed. The value of this parameter may affect the number of search results that are returned.
Specifies an upper bound on the number of search results returned, and therefore the maximum number of features output from the transformer.
Authentication Parameters
Note: For access outside of your network using a proxy server, use the Network tools in FME Options. From the Workbench menu, select Tools > FME Options > Network. For more information, see "Network" in the FME Workbench Help.
A valid Twitter username and password are required in order to access the Twitter search API.
Geocode Parameters
If this parameter is set to Yes, the transformer will restrict its search to geocoded tweets. These are tweets which have been tagged with lat/long location data. The center of gravity of the feature’s geometry will be used as the center point of the search area.
Note that Geocoded Tweets may also include non-geocoded tweets if a user has set their location in Twitter settings, and that location falls within the search parameters (but does not have proper lat/long coordinates).
In these cases, the TweetSearcher will add an additional attribute: _tweet_geo. To exclude these results, you can attach a Tester transformer to filter out non-geocoded Tweets. Set the test to _tweet_geo = "null".
When searching for geocoded tweets, these parameters control the radius of the search area. The units may be set to Kilometers or Miles, and only tweets within the search radius from the search center point will be returned.
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more.
When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.
These functions manipulate and format strings. | |
Special Characters |
A set of control characters is available in the Text Editor. |
Math functions are available in both editors. | |
Date/Time Functions | Date and time functions are available in the Text Editor. |
These operators are available in the Arithmetic Editor. | |
These return primarily feature-specific values. | |
FME and workspace-specific parameters may be used. | |
Creating and Modifying User Parameters | Create your own editable parameters. |
Dialog Options - Tables
Transformers with table-style parameters have additional tools for populating and manipulating values.
Row Reordering
|
Enabled once you have clicked on a row item. Choices include:
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
Cut, copy, and paste may be used within a transformer, or between transformers. |
Filter
|
Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output. |
Import
|
Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers. |
Reset/Refresh
|
Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers. |
Note: Not all tools are available in all transformers.
FME Licensing Level
FME Professional edition and above
FME Community
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for samples and information about this transformer on the FME Community.
Keywords: TwitterSearcher