bbopx.barista.response.js

Summary

bbopx.barista.response.js
bbopx.barista.response	Generic BBOP handler for dealing with the gross parsing of responses from the GO Molecular Model Manager REST server JSON responses.
Functions
response	Contructor for a GO MMM REST JSON response object.
user_id	Returns the user id (uid) for a call if it was generated my a known user.
intention	Returns the user intention for a call.
signal	Returns the server’s action signal, if there was one.
commentary	Returns the commentary object (whatever that might be in any given case).
data	Returns the data object (whatever that might be in any given case).
model_id	Returns the model id of the response.
inconsistent_p	Returns true or false on whether or not the returned model is thought to be inconsistent.
facts	Returns a list of the facts in the response.
properties	Returns a list of the properties in the response.
individuals	Returns a list of the individuals in the response.
inferred_individuals	Returns a list of the inferred_individuals in the response.
relations	Returns a list of the relations found in the response.
evidence	Returns a list of the evidence found in the response.
annotations	Returns a list of the (complex) annotations found in the response.
model_ids	Returns a list the model ids found in the response.

bbopx.barista.response

Generic BBOP handler for dealing with the gross parsing of responses from the GO Molecular Model Manager REST server JSON responses.

It will detect if the incoming response is structured correctly and give safe access to fields and properties.

It is not meant to be a model for the parts in the data section.

BUG/NOTE: This is slated to replace the bbop.rest.response.mmm package after it reaches maturity.

Summary

Functions
response	Contructor for a GO MMM REST JSON response object.
user_id	Returns the user id (uid) for a call if it was generated my a known user.
intention	Returns the user intention for a call.
signal	Returns the server’s action signal, if there was one.
commentary	Returns the commentary object (whatever that might be in any given case).
data	Returns the data object (whatever that might be in any given case).
model_id	Returns the model id of the response.
inconsistent_p	Returns true or false on whether or not the returned model is thought to be inconsistent.
facts	Returns a list of the facts in the response.
properties	Returns a list of the properties in the response.
individuals	Returns a list of the individuals in the response.
inferred_individuals	Returns a list of the inferred_individuals in the response.
relations	Returns a list of the relations found in the response.
evidence	Returns a list of the evidence found in the response.
annotations	Returns a list of the (complex) annotations found in the response.
model_ids	Returns a list the model ids found in the response.

Functions

response

Contructor for a GO MMM REST JSON response object.

The constructor argument is an object or a string.

Arguments

raw	the JSON object as a string or object

Returns

response object

user_id

bbopx.barista.response.prototype.user_id = function()

Returns the user id (uid) for a call if it was generated my a known user.

Arguments

n/a

Returns

string or null

intention

bbopx.barista.response.prototype.intention = function()

Returns the user intention for a call.

Arguments

n/a

Returns

string or null

signal

bbopx.barista.response.prototype.signal = function()

Returns the server’s action signal, if there was one.

Arguments

n/a

Returns

string or null

commentary

Returns the commentary object (whatever that might be in any given case).

Arguments

n/a

Returns

copy of commentary object or null

data

Returns the data object (whatever that might be in any given case). This grossly returns all response data, if any.

Arguments

n/a

Returns

copy of data object or null

model_id

Returns the model id of the response.

Arguments

n/a

Returns

string or null

inconsistent_p

Returns true or false on whether or not the returned model is thought to be inconsistent. Starting assumption is that it is not.

Arguments

n/a

Returns

true or false

facts

Returns a list of the facts in the response. Empty list if none.

Arguments

n/a

Returns

list

properties

Returns a list of the properties in the response. Empty list if none.

Arguments

n/a

Returns

list

individuals

Returns a list of the individuals in the response. Empty list if none.

Arguments

n/a

Returns

list

inferred_individuals

Returns a list of the inferred_individuals in the response. Empty list if none.

Arguments

n/a

Returns

list

relations

bbopx.barista.response.prototype.relations = function()

Returns a list of the relations found in the response. Sometimes not there, so check the return.

Arguments

n/a

Returns

list

evidence

bbopx.barista.response.prototype.evidence = function()

Returns a list of the evidence found in the response. Sometimes not there, so check the return.

Arguments

n/a

Returns

list

annotations

bbopx.barista.response.prototype.annotations = function()

Returns a list of the (complex) annotations found in the response. Sometimes not there, so check the return.

Arguments

n/a

Returns

list

model_ids

bbopx.barista.response.prototype.model_ids = function()

Returns a list the model ids found in the response. Sometimes not there, so check the return.

Arguments

n/a

Returns

list