dojox.data.GoogleBlogSearchStore — The Dojo Toolkit

Project owner:	Shane O’Sullivan
since:	1.2?

Introduction ¶

dojox.data.GoogleBlogSearchStore is a read only data store that uses Google to search blog posts. It implements the ‘dojo.data.api.Read API <dojo/data/api/Read>’_, which you should refer to for general usage.

Usage ¶

The pattern of using the GoogleBlogSearchStore is

Instantiate the class, passing in whatever variables required, all of which are optional. These include:

label The argument to use as the label. This is used when the getLabel function is called to retrieve the correct part of the data item. You generally shouldn’t set this.

key Your Google API key. This is optional, and should only be used if you for some reason want Google to track the number of requests made by your code (for analytical purposes maybe)

lang The language you want the results returned in. This defaults to the browsers’ language.

urlPreventCache Specifies whether or not to forcibly prevent caching of results. This defaults to true.

Call the fetch method, passing it the search query and the function to call when the query is completed. The only supported attribute of the query is text, the text to search for.
Iterate over the results, calling the getValue function to retrieve values from each result item. The pieces of data in each result item are

title The page title in HTML format

titleNoFormatting The page title in plain text. This is the default field used as the label.

content A snippet of information about the page

blogUrl The URL for the blog on which the post was created.

postUrl The URL for the blog post.

visibleUrl The URL with no protocol specified

cacheUrl The URL to the copy of the document cached by Google

author The author of the blog post.

publishedDate The published date, in RFC-822 format

dojo.require("dojox.data.GoogleSearchStore");
var store = new dojox.data.GoogleBlogSearchStore();

var query = {text: "dojo ajax toolkit"};

var callbackFunction = function(/*Array*/ items){

  console.log("Successfully retrieved " + items.length + " items for the query '" + query.text + "'");
  dojo.forEach(items, function(item){
    console.log ("Title is " + store.getValue(item, "title"));
    console.log ("Blog Url is " + store.getValue(item, "blogUrl"));
    console.log ("Post Url is " + store.getValue(item, "postUrl"));
    console.log ("Summary Content is " + store.getValue(item, "content"));
    console.log ("Author is " + store.getValue(item, "author"));
  })
};

var onErrorFunction = function(){
  console.log("An error occurred getting Google Blog Search data");
}

store.fetch({
  query: query,
  count: 20,
  start: 0,
  onComplete: callbackFunction,
  onError: onErrorFunction
});

Examples ¶

Programmatic example¶

dojo.require("dojox.data.GoogleSearchStore");

function doSearch(){

  var store = new dojox.data.GoogleBlogSearchStore();

  var query = {text: dojo.byId("searchInput").value};

  var callbackFunction = function(/*Array*/ items){

    var table = dojo.byId("resultTable");
    var tableBody = table.tBodies[0];
    dojo.empty(tableBody);

    // Show the table
    dojo.style(table, "display", "");


    dojo.forEach(items, function(item, index){
      var row = dojo.create("tr", {}, tableBody);

      var numberCell = dojo.create("td", {innerHTML: index}, row);

      var titleCell = dojo.create("td", {innerHTML: store.getValue(item, "titleNoFormatting")}, row);

      var urlCell = dojo.create("td", {}, row);
      dojo.create("a", {
                         href: store.getValue(item, "postUrl"),
                         innerHTML: "Post Link ",
                         target: "_blank"
                       }, urlCell);
      dojo.create("a", {
                         href: store.getValue(item, "blogUrl"),
                         style: {paddingLeft: "5px"},
                         innerHTML: " Blog Link",
                         target: "_blank"
                       }, urlCell);
    })
  };

  var onErrorFunction = function(){
    console.log("An error occurred getting Google Search data");
  }

  store.fetch({
    query: query,
    count: 20,
    start: 0,
    onComplete: callbackFunction,
    onError: onErrorFunction
  });
  console.log("called fetch with query", query);

}

dojo.require("dojox.data.GoogleSearchStore");

function doSearch(){

var store = new dojox.data.GoogleBlogSearchStore();

var query = {text: dojo.byId("searchInput").value};

var callbackFunction = function(/*Array*/ items){

var table = dojo.byId("resultTable");
    var tableBody = table.tBodies[0];
    dojo.empty(tableBody);

// Show the table
    dojo.style(table, "display", "");

dojo.forEach(items, function(item, index){
      var row = dojo.create("tr", {}, tableBody);

var numberCell = dojo.create("td", {innerHTML: index}, row);

var titleCell = dojo.create("td", {innerHTML: store.getValue(item, "titleNoFormatting")}, row);

var onErrorFunction = function(){
    console.log("An error occurred getting Google Search data");
  }

store.fetch({
    query: query,
    count: 20,
    start: 0,
    onComplete: callbackFunction,
    onError: onErrorFunction
  });
  console.log("called fetch with query", query);

}

<div>
  <span>Enter Search Text</span>
  <input type="text" value="dojo ajax toolkit" id="searchInput">
  <button onclick="doSearch()">Search</button>
</div>

<table id="resultTable" style="border: 1px solid black; display: none;">
  <thead>
    <th>#</th>
    <th>Title</th>
    <th>URL</th>
  </thead>
  <tbody>
  </tbody>
</table>

dojox.data.GoogleBlogSearchStore ¶

Introduction ¶

Usage ¶

Examples ¶

Programmatic example¶

See also ¶

Table of Contents

dojox.data.GoogleBlogSearchStore¶

Introduction¶

Usage¶

Examples¶

Programmatic example¶

See also¶

Table of Contents

dojox.data.GoogleBlogSearchStore ¶

Introduction ¶

Usage ¶

Examples ¶

See also ¶