Twitter Adapter Sample

About This Sample

This sample demonstrates the use of the Spotfire Streaming Twitter input and output adapters. This sample demonstrates listening to the current user's Twitter stream; other streams are available.

Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

  • From the top-level menu, select File>Import Samples and Community Content.

  • Enter tw to narrow the list of options.

  • Select Twitter adapter from the StreamBase Standard Adapters category.

  • Click Import Now.

StreamBase Studio creates a single project containing the sample files.

Setup

Edit the streambase.conf file in the src/main/configurations folder to add these four required values:

Please view the documentation on how to get OAuth credentials for Twitter API described in Spotfire Streaming Twitter Input Adapter:

  1. consumerKey

  2. consumerSecret

  3. accessToken

  4. accessTokenSecret

You must also configure the sample with appropriate OAuth tokens. See Twitter Input Adapter for instructions.

Running This Sample in StreamBase Studio

  1. In the Project Explorer view, open the sample you just loaded.

    If you see red marks on a project folder, wait a moment for the project to load its features.

    If the red marks do not resolve themselves after a minute, select the project, right-click, and select Maven>Update Project from the context menu.

  2. Open the src/main/eventflow/packageName folder.

  3. Open the Twitter.sbapp file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

  4. In the Manual Input view, switch the stream to ControlInput, enter user into the Command field and then click Send Data to send the control tuple.

  5. In the Output Streams view, observe the InputStatus tuple which gives details about the connection to the User stream which this sample starts by default on application start up.

  6. In the Manual Input view, switch the stream to ControlOutput, enter tweet into the Command field and then a short status into the Tweet\Status field and then click Send Data to send the control tuple.

  7. In the Output Streams view, observe tuples emitted on the OutputStatus and Tweets output streams.

  8. Select the tuple emitted from the Tweets stream, then use the triangles next to the data fields displayed to analyze and understand their structure.

  9. Experiment with other commands on the ControlOutput and ControlInput streams as shown by notes included in the module.

  10. Press F9 or click the Terminate EventFlow Fragment button.

Sample Location

When you load the sample into StreamBase® Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

Important

Load this sample in StreamBase® Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:

studio-workspace/sample_twitter

See Default Installation Directories for the default location of studio-workspace on your system.