dojox/data/SnapLogicStore (version 1.10)

Usage

var foo = new SnapLogicStore(args);
dojox/data/SnapLogicStore
Parameter Type Description
args Object

An object that contains properties for initializing the new data store object. The following properties are understood:

  • url: A URL to the SnapLogic pipeline's output routed through PipeToHttp. Typically, this will look like http://<server-host>:<port>/pipe/<pipeline-url>/<pipeline-output-view>.
  • parameters: An object whose properties define parameters to the pipeline. The values of these properties will be sent to the pipeline as parameters when it run.

See the dojox/data/SnapLogicStore reference documentation for more information.

Property Summary

Method Summary

  • _assertIsAttribute(attribute) This function tests whether the item passed in is indeed a valid 'attribute' like type for the store.
  • _assertIsItem(item) This function tests whether the item passed in is indeed an item in the store.
  • _fetchHandler(request) Process data retrieved via fetch and send it back to requester.
  • _partHandler(request,part,response) Handle the individual replies for both data and length requests.
  • close(request) See dojo/data/api/Read.close()
  • containsValue(item,attribute,value) See dojo/data/api/Read.containsValue()
  • fetch(request) See dojo/data/api/Read.close()
  • getAttributes(item) See dojo/data/api/Read.getAttributes()
  • getFeatures() See dojo/data/api/Read.getFeatures()
  • getLabel(item) See dojo/data/api/Read.getLabel()
  • getLabelAttributes(item) See dojo/data/api/Read.getLabelAttributes()
  • getValue(item,attribute,defaultValue) See dojo/data/api/Read.getValue()
  • getValues(item,attribute) See dojo/data/api/Read.getValue()
  • hasAttribute(item,attribute) See dojo/data/api/Read.hasAttributes()
  • isItem(item) See dojo/data/api/Read.isItem()
  • isItemLoaded(item) See dojo/data/api/Read.isItemLoaded()
  • loadItem(keywordArgs) See dojo/data/api/Read.loadItem()

Properties

Parts
url

Methods

_assertIsAttribute(attribute)

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

Parameter Type Description
attribute attribute-name-string

The attribute to test for being contained by the store.

_assertIsItem(item)

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

Parameter Type Description
item item

The item to test for being contained by the store.

_fetchHandler(request)

Process data retrieved via fetch and send it back to requester.

Parameter Type Description
request Object

The data returned from the I/O transport. In the normal case, it will be an array of result rows from the pipeline. In the special case for record count optimization, response will be an array with a single element containing the total pipeline result row count. See fetch() for details on this optimization.

_partHandler(request,part,response)

Handle the individual replies for both data and length requests.

Parameter Type Description
request Object

The request/handle object used with the original fetch() call.

part String

A value indicating which request this handler call is for (this.Parts).

response Object

Response received from the underlying IO transport.

close(request)

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

Parameter Type Description
request undefined
containsValue(item,attribute,value)

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

Parameter Type Description
item undefined
attribute undefined
value undefined
Returns:boolean
fetch(request)

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

Parameter Type Description
request Object

See dojo/data/api/Read.close() for generic interface.

In addition to the standard Read API fetch support, this store supports an optimization for for retrieving the total count of records in the Pipeline without retrieving the data. To use this optimization, simply provide an onBegin handler without an onItem or onComplete handler.

Returns:Object

See dojo/data/api/Read.close() for generic interface.

In addition to the standard Read API fetch support, this store supports an optimization for for retrieving the total count of records in the Pipeline without retrieving the data. To use this optimization, simply provide an onBegin handler without an onItem or onComplete handler.

getAttributes(item)

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

Parameter Type Description
item undefined
Returns:undefined
getFeatures()

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

Returns:object
getLabel(item)

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

Parameter Type Description
item undefined
Returns:undefined
getLabelAttributes(item)

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

Parameter Type Description
item undefined
Returns:null
getValue(item,attribute,defaultValue)

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

Parameter Type Description
item undefined
attribute undefined
defaultValue undefined
Returns:undefined
getValues(item,attribute)

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

Parameter Type Description
item undefined
attribute undefined
Returns:Array
hasAttribute(item,attribute)

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

Parameter Type Description
item undefined
attribute undefined
Returns:boolean
isItem(item)

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

Parameter Type Description
item undefined
Returns:boolean
isItemLoaded(item)

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

Parameter Type Description
item undefined
Returns:undefined
loadItem(keywordArgs)

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

Parameter Type Description
keywordArgs undefined
Error in the documentation? Can’t find what you are looking for? Let us know!