dojox/data/GoogleSearchStore.js

• Provides:

  • dojox.data.GoogleImageSearchStore

• Requires:

  • dojo.io.script in common

• dojox.data.GoogleSearchStore

  • type

    Function

  • parameters:
    • args: (typeof Object)
  • summary

    A data store for retrieving search results from Google.
    This data store acts as a base class for Google searches,
    and has a number of child data stores that implement different
    searches. This store defaults to searching the web, and is functionally
    identical to the dojox.data.GoogleWebSearchStore object.
    The following attributes are supported on each item:
    <ul>
    <li>url - The URL for the item</li>
    <li>unescapedUrl - The URL for the item, with URL escaping. This is often more readable</li>
    <li>visibleUrl - The URL with no protocol specified.
    <li>cacheUrl - The URL to the copy of the document cached by Google
    <li>title - The page title in HTML format.</li>
    <li>titleNoFormatting - The page title in plain text</li>
    <li>content - A snippet of information about the page</li>
    </ul>
    The query accepts one parameter: text - The string to search for

  • description

    The GoogleSearchStore is a Datastore interface to
    the Google search service. The constructor accepts the following arguments:
    <ul>
    <li>label - the label attribute to use. Defaults to titleNoFormatting</li>
    <li>key - The API key to use. This is optional</li>
    <li>lang - The language locale to use. Defaults to the browser locale</li>
    </ul>

• dojox.data.GoogleSearchStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)
  • summary

    Initializer for the GoogleSearchStore store.

  • description

    The GoogleSearchStore is a Datastore interface to
    the Google search service. The constructor accepts the following arguments:
    <ul>
    <li>label - the label attribute to use. Defaults to titleNoFormatting</li>
    <li>key - The API key to use. This is optional</li>
    <li>lang - The language locale to use. Defaults to the browser locale</li>
    </ul>

• dojox.data.GoogleSearchStore._id

  • type

    Integer

  • summary

    A unique identifier for this store.

• dojox.data.GoogleSearchStore._requestCount

  • type

    Integer

  • summary

    A counter for the number of requests made. This is used to define
    the callback function that GoogleSearchStore will use.

• dojox.data.GoogleSearchStore._googleUrl

  • type

    String

  • summary

    The URL to Googles search web service.

• dojox.data.GoogleSearchStore._storeRef

  • type

    String

  • summary

    The internal reference added to each item pointing at the store which owns it.

• dojox.data.GoogleSearchStore._attributes

  • type

    Array

  • summary

    The list of attributes that this store supports

• dojox.data.GoogleSearchStore._aggregatedAttributes

  • type

    Object

• dojox.data.GoogleSearchStore._aggregatedAttributes.estimatedResultCount

  • type

    String

• dojox.data.GoogleSearchStore.label

  • type

    String

  • summary

    The default attribute which acts as a label for each item.

• dojox.data.GoogleSearchStore._type

  • type

    String

• dojox.data.GoogleSearchStore.urlPreventCache

  • type

    boolean

  • summary

    Sets whether or not to pass preventCache to dojo.io.script.

• dojox.data.GoogleSearchStore._queryAttrs

  • type

    Hash

  • summary

    Maps query hash keys to Google query parameters.

• dojox.data.GoogleSearchStore._queryAttrs.text

  • type

    String

• dojox.data.GoogleSearchStore._assertIsItem

  • parameters:
    • item: (typeof item)

      The item to test for being contained by the store.

  • summary

    This function tests whether the item passed in is indeed an item in the store.

  • type

    Function

• dojox.data.GoogleSearchStore._assertIsAttribute

  • parameters:
    • attribute: (typeof attribute-name-string)

      The attribute to test for being contained by the store.

  • summary

    This function tests whether the item passed in is indeed a valid 'attribute' like type for the store.

  • type

    Function

• dojox.data.GoogleSearchStore.getFeatures

  • summary

    See dojo.data.api.Read.getFeatures()

  • type

    Function

• dojox.data.GoogleSearchStore.getValue

  • parameters:
    • item
    • attribute
    • defaultValue
  • summary

    See dojo.data.api.Read.getValue()

  • type

    Function

• dojox.data.GoogleSearchStore.getAttributes

  • parameters:
    • item
  • summary

    See dojo.data.api.Read.getAttributes()

  • type

    Function

• dojox.data.GoogleSearchStore.hasAttribute

  • parameters:
    • item
    • attribute
  • summary

    See dojo.data.api.Read.hasAttributes()

  • type

    Function

• dojox.data.GoogleSearchStore.isItemLoaded

  • parameters:
    • item
  • summary

    See dojo.data.api.Read.isItemLoaded()

  • type

    Function

• dojox.data.GoogleSearchStore.loadItem

  • parameters:
    • keywordArgs
  • summary

    See dojo.data.api.Read.loadItem()

  • type

    Function

• dojox.data.GoogleSearchStore.getLabel

  • parameters:
    • item
  • summary

    See dojo.data.api.Read.getLabel()

  • type

    Function

• dojox.data.GoogleSearchStore.getLabelAttributes

  • parameters:
    • item
  • summary

    See dojo.data.api.Read.getLabelAttributes()

  • type

    Function

• dojox.data.GoogleSearchStore.containsValue

  • parameters:
    • item
    • attribute
    • value
  • summary

    See dojo.data.api.Read.containsValue()

  • type

    Function

• dojox.data.GoogleSearchStore.getValues

  • parameters:
    • item
    • attribute
  • summary

    See dojo.data.api.Read.getValue()

  • type

    Function

• dojox.data.GoogleSearchStore.isItem

  • parameters:
    • item
  • summary

    See dojo.data.api.Read.isItem()

  • type

    Function

• dojox.data.GoogleSearchStore.close

  • parameters:
    • request
  • summary

    See dojo.data.api.Read.close()

  • type

    Function

• dojox.data.GoogleSearchStore._format

  • parameters:
    • item
    • name
  • returns

    base implementation does not format any items

  • type

    Function

• dojox.data.GoogleSearchStore.fetch

  • parameters:
    • request: (typeof A)

      request object
      fetchHandler:
      A function to call for fetched items
      errorHandler:
      A function to call on error

  • summary

    Fetch Google search items that match to a query

  • type

    Function

• dojox.data.GoogleSearchStore._getSort

  • type

    Function

• dojox.data.GoogleSearchStore._processItem

  • parameters:
    • item
    • data
  • type

    Function

• dojox.data.GoogleSearchStore._getItems

  • parameters:
    • data
  • type

    Function

• dojox.data.GoogleSearchStore._createContent

  • parameters:
    • query
    • callback
    • request
  • type

    Function

• dojox.data.GoogleSearchStore._key

• dojox.data.GoogleSearchStore._lang

• dojox.data.GoogleWebSearchStore

  • type

    Function

  • chains:
    • dojox.data.GoogleSearchStore: (prototype)
    • dojox.data.GoogleSearchStore: (call)

• dojox.data.GoogleBlogSearchStore

  • type

    Function

  • chains:
    • dojox.data.GoogleSearchStore: (prototype)
    • dojox.data.GoogleSearchStore: (call)

• dojox.data.GoogleBlogSearchStore._type

  • type

    String

• dojox.data.GoogleBlogSearchStore._attributes

  • type

    Array

• dojox.data.GoogleBlogSearchStore._aggregatedAttributes

  • type

    Object

• dojox.data.GoogleLocalSearchStore

  • type

    Function

  • chains:
    • dojox.data.GoogleSearchStore: (prototype)
    • dojox.data.GoogleSearchStore: (call)
  • summary

    A data store for retrieving search results from Google.
    The following attributes are supported on each item:
    <ul>
    <li>title - The blog post title in HTML format.</li>
    <li>titleNoFormatting - The  blog post title in plain text</li>
    <li>content - A snippet of information about the blog post</li>
    <li>url - The URL for the item</li>
    <li>lat - The latitude.</li>
    <li>lng - The longtitude.</li>
    <li>streetAddress - The street address</li>
    <li>city - The city</li>
    <li>region - The region</li>
    <li>country - The country</li>
    <li>phoneNumbers - Phone numbers associated with this address. Can be one or more.</li>
    <li>ddUrl - A URL that can be used to provide driving directions from the center of the search results to this search results</li>
    <li>ddUrlToHere - A URL that can be used to provide driving directions from this search result to a user specified location</li>
    <li>staticMapUrl - The published date, in RFC-822 format</li>
    <li>viewport - Recommended viewport for the query results (same for all results in a query)
    <ul>
    <li>center - contains lat, lng properties</li>
    <li>span - lat, lng properties for the viewport span</li>
    <li>ne, sw - lat, lng properties for the viewport corners<li>
    </ul>
    </li>
    </ul>
    The query accepts the following parameters:
    <ul>
    <li>text - The string to search for</li>
    <li>centerLatLong - Comma-separated lat & long for the center of the search (e.g. "48.8565,2.3509")</li>
    <li>searchSpan - Comma-separated lat & long degrees indicating the size of the desired search area (e.g. "0.065165,0.194149")</li>
    </ul>

• dojox.data.GoogleLocalSearchStore._type

  • type

    String

• dojox.data.GoogleLocalSearchStore._attributes

  • type

    Array

• dojox.data.GoogleLocalSearchStore._aggregatedAttributes

  • type

    Object

• dojox.data.GoogleLocalSearchStore._aggregatedAttributes.viewport

  • type

    String

• dojox.data.GoogleLocalSearchStore._queryAttrs

  • type

    Object

• dojox.data.GoogleLocalSearchStore._queryAttrs.text

  • type

    String

• dojox.data.GoogleLocalSearchStore._queryAttrs.centerLatLong

  • type

    String

• dojox.data.GoogleLocalSearchStore._queryAttrs.searchSpan

  • type

    String

• dojox.data.GoogleVideoSearchStore

  • type

    Function

  • chains:
    • dojox.data.GoogleSearchStore: (prototype)
    • dojox.data.GoogleSearchStore: (call)
  • summary

    A data store for retrieving search results from Google.
    The following attributes are supported on each item:
    <ul>
    <li>title - The blog post title in HTML format.</li>
    <li>titleNoFormatting - The  blog post title in plain text</li>
    <li>content - A snippet of information about the blog post</li>
    <li>url - The URL for the item</li>
    <li>published - The published date, in RFC-822 format.</li>
    <li>publisher - The name of the publisher.</li>
    <li>duration - The approximate duration, in seconds, of the video.</li>
    <li>tbWidth - The width in pixels of the video.</li>
    <li>tbHeight - The height in pixels of the video</li>
    <li>tbUrl - The URL to a thumbnail representation of the video.</li>
    <li>playUrl - If present, supplies the url of the flash version of the video that can be played inline on your page. To play this video simply create and <embed> element on your page using this value as the src attribute and using application/x-shockwave-flash as the type attribute. If you want the video to play right away, make sure to append &autoPlay=true to the url..</li>
    </ul>
    The query accepts one parameter: text - The string to search for

• dojox.data.GoogleVideoSearchStore._type

  • type

    String

• dojox.data.GoogleVideoSearchStore._attributes

  • type

    Array

• dojox.data.GoogleVideoSearchStore._aggregatedAttributes

  • type

    Object

• dojox.data.GoogleNewsSearchStore

  • type

    Function

  • chains:
    • dojox.data.GoogleSearchStore: (prototype)
    • dojox.data.GoogleSearchStore: (call)
  • summary

    A data store for retrieving search results from Google.
    The following attributes are supported on each item:
    <ul>
    <li>title - The news story title in HTML format.</li>
    <li>titleNoFormatting - The news story title in plain text</li>
    <li>content - A snippet of information about the news story</li>
    <li>url - The URL for the item</li>
    <li>unescapedUrl - The URL for the item, with URL escaping. This is often more readable</li>
    <li>publisher - The name of the publisher</li>
    <li>clusterUrl - A URL pointing to a page listing related storied.</li>
    <li>location - The location of the news story.</li>
    <li>publishedDate - The date of publication, in RFC-822 format.</li>
    <li>relatedStories - An optional array of objects specifying related stories.
    Each object has the following subset of properties:
    "title", "titleNoFormatting", "url", "unescapedUrl", "publisher", "location", "publishedDate".
    </li>
    </ul>
    The query accepts one parameter: text - The string to search for

• dojox.data.GoogleNewsSearchStore._type

  • type

    String

• dojox.data.GoogleNewsSearchStore._attributes

  • type

    Array

• dojox.data.GoogleNewsSearchStore._aggregatedAttributes

  • type

    Object

• dojox.data.GoogleBookSearchStore

  • type

    Function

  • chains:
    • dojox.data.GoogleSearchStore: (prototype)
    • dojox.data.GoogleSearchStore: (call)
  • summary

    A data store for retrieving search results from Google.
    The following attributes are supported on each item:
    <ul>
    <li>title - The book title in HTML format.</li>
    <li>titleNoFormatting - The book title in plain text</li>
    <li>authors - An array of authors</li>
    <li>url - The URL for the item</li>
    <li>unescapedUrl - The URL for the item, with URL escaping. This is often more readable</li>
    <li>bookId - An identifier for the book, usually an ISBN.</li>
    <li>pageCount - The number of pages in the book.</li>
    <li>publishedYear - The year of publication.</li>
    </ul>
    The query accepts one parameter: text - The string to search for

• dojox.data.GoogleBookSearchStore._type

  • type

    String

• dojox.data.GoogleBookSearchStore._attributes

  • type

    Array

• dojox.data.GoogleBookSearchStore._aggregatedAttributes

  • type

    Object

• dojox.data.GoogleImageSearchStore

  • type

    Function

  • chains:
    • dojox.data.GoogleSearchStore: (prototype)
    • dojox.data.GoogleSearchStore: (call)
  • summary

    A data store for retrieving search results from Google.
    The following attributes are supported on each item:
    <ul>
    <li>title - The image title in HTML format.</li>
    <li>titleNoFormatting - The image title in plain text</li>
    <li>url - The URL for the image</li>
    <li>unescapedUrl - The URL for the image, with URL escaping. This is often more readable</li>
    <li>tbUrl - The URL for the image thumbnail</li>
    <li>visibleUrl - A shortened version of the URL associated with the result, stripped of a protocol and path</li>
    <li>originalContextUrl - The URL of the page containing the image.</li>
    <li>width - The width of the image in pixels.</li>
    <li>height - The height of the image in pixels.</li>
    <li>tbWidth - The width of the image thumbnail in pixels.</li>
    <li>tbHeight - The height of the image thumbnail in pixels.</li>
    <li>content - A snippet of information about the image, in HTML format</li>
    <li>contentNoFormatting - A snippet of information about the image, in plain text</li>
    </ul>
    The query accepts one parameter: text - The string to search for

• dojox.data.GoogleImageSearchStore._type

  • type

    String

• dojox.data.GoogleImageSearchStore._attributes

  • type

    Array

• dojox.data.GoogleImageSearchStore._aggregatedAttributes

  • type

    Object

• dojox.data

  • type

    Object

• dojox

  • type

    Object