awa.mvc.Collection

Extends Backbone.Collection

Defined in: /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:12

Module: awa.mvc

"Small" overrides and extras added to the Backbone.Collection class to better work with the system. You can also add anything extra you know about the code that is not explained in backbones documentation.

See the following for parent class information: http://backbonejs.org/#Collection

Creating a new collection

var collection = new Collection([], {
    model: PatientModel,
    url: window.BAREBONES + 'V1/patients'
});

Chaining of collection parameters

collection.setOrderBy('pat_fname')
    .setSortBy('DESC')
    .setLimit(10);

Fetching and using data

var promise = collection.fetch();
promise.then(function(){
    collection.each(function(model){
        //some logic
    });
});

Fetching without promises

collection.fetch({success: function(){}});

Although filtering support raw sql and attribute|comparator|value approach, the recommended standard now is key value pairs. This approach prevents sql injection and requires that filters be predefined in the backend API.

collection.setFilter('pat_phy_id', [3, 25, 6]);
collection.setFilter('pat_dob_from', '19851128');

Sometimes you'll need to fetch an entire collection that doesn't change often (rendering providers). Use the fetchAll function in this case. It will only fetch on the first request but still call success with the exist in data for subsequent calls.

Constructor

`awa.mvc.Collection`

(

[models]
[options.model]
[options.filters]
[options.params]
[options.limit]
[options.offset]
[options.order_by]
[options.sort_by]
[options.columns]
[options.total_rows]
[options.postGet]

)

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:12

Parameters:

[models] Array optional

initial set of models, usually you can just pass an empty array
[options.model] Constructor optional

Model class to use for collection
[options.filters] Array | Object optional

Set of initial filters
[options.params] Array | Object optional

Set of initial parameters
[options.limit] String | Integer optional

Initial collection limit
[options.offset] String | Integer optional

Initial collection offset
[options.order_by] String optional

Initial collection ordering
[options.sort_by] String optional

Initial collection sort
[options.columns] Array optional

array of strings dictating return columns
[options.total_rows] Boolean optional

dictate if you want to receive total rows. defaults to true in most cases
[options.postGet] String optional

In the case that you need to use post instead of get to grab a collection, provider the sub action i.e. barebones/V1/patients is the regular path for get, barebones/V1/patients/filtered can be your post version. Only provide the word "filtered"

Item Index

Methods

Properties

Events

filters

Methods

`_logLastUpdatedOnSync`

() Undefined

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:161

When sync is triggered, this method updates the lastUpdated value

Returns:

Undefined:

undefined

`addFilter`

(

attr
comp
val

)

awa.mvc.Collection deprecated chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:674

Deprecated: Using this means you are using string based filter and that is bad Remove when all string based filters are gone Adds one filter to the array of filters that is sent to the server on fetch.

Parameters:

attr String

filter to add
comp String

comparator to use (> < = != IN BETWEEN)
val String | Array

filter to add

Returns:

awa.mvc.Collection:

this

`addParams`

(

params

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:777

Adds hashmap params to current params

Parameters:

params Object

Full parameter set

Returns:

awa.mvc.Collection:

this

`addReturnColumn`

(

col

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:487

Adds a column to the collection option for the return that is sent to the server on fetch.

Parameters:

col String

attribute to return

Returns:

awa.mvc.Collection:

this

`canDoLocalQuery`

() Boolean

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:537

Returns:

Boolean:

Can locally query

`clearFilters`

() awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:660

Clears all collection filters

Returns:

awa.mvc.Collection:

this

`displayMethod`

(

val
id
source

)

String

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:178

Parameters:

val String

Value
id String

Attribute id
source awa.mvc.Collection | awa.mvc.Model

Source collection or model

Returns:

String:

brief string summary of the collection as a whole

`fetchAll`

(

[options]

)

Promise

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:868

Gets all of the collection records. Returns a promise that is already resolved if cache is available. Cleared with reset.

Parameters:

[options] Object optional

xhr options. Use the other methods instead

Returns:

Promise:

promise for when fetch is complete

`fetchTotalRows`

(

get_total_rows

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:384

Instructs server to calculate total row count

Parameters:

get_total_rows Boolean

Flag

Returns:

awa.mvc.Collection:

this

`filterReject`

(

predicate

)

awa.mvc.Collection

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:1351

A version of reject to return a modified version of this collection.

Parameters:

predicate Function

A function that returns true when an item should be removed from the collection. It takes one argument, the model it should test against. Defaults to _.noop

Returns:

awa.mvc.Collection:

This collection without models rejected by predicate.

`findWhere`

(

[list]
props

)

awa.mvc.Model

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:1307

Overridden version of findWhere to be less typesafe. ID changes from string or int based on if model is new which causes several issues when doing a search

Parameters:

[list] Array optional

not used
props Object

Properties to match against

Returns:

awa.mvc.Model:

returns matches model

`get`

(

attr

)

Mixed

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:262

Get the current value of an attribute from the model Overwritten to create collections and sub models only when needed.

Parameters:

attr String

supports dot notation to get properties of individual models

Returns:

Mixed:

model or attribute of sub model

`getArgument`

(

key
filter

)

String | Array | Object

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:622

Gets an argument based on the key

Parameters:

key String

Argument key
filter String | Array | Object

or array of filters

Returns:

String | Array | Object:

Argument value

`getDisplay`

(

attr

)

Mixed

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:236

Parameters:

attr String

supports dot notation to get properties of individual models

Returns:

Mixed:

Like get, but this uses the displayMethod.

`getDisplayMethod`

(

attr

)

Function

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:212

Parameters:

attr String

attribute of model

Returns:

Function:

returns the displayMethod for a given attribute

`getFetchData`

() Object

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:812

Get the entire data object {with the exception of the ahis session id} that is sent to the server.

Returns:

Object:

object fo data sent when fetching

`getFilters`

() Array | Object

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:731

Gets the array of filters that is sent to the server.

Returns:

Array | Object:

All filters

`getFilters`

(

key

)

Mixed

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:740

Gets the array of filters that is sent to the server.

Parameters:

key String

Filter key

Returns:

Mixed:

filter value

`getLimit`

() Integer

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:464

Returns:

Integer:

collection option for the maximum returned results that is sent to the server on fetch.

`getName`

(

attr

)

String

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:189

Gets the name of an attribute. This can be set by and attribute's attributeProp name. returns the attribute if not set.

Parameters:

attr String

attribute of model

Returns:

String:

attribute Name of attribute

`getOffset`

() Integer

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:520

Returns:

Integer:

collection option for the offset that is sent to the server on fetch.

`getOrderBy`

() String

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:418

Returns:

String:

collection option for ordering that is sent to the server on fetch.

`getParam`

(

key

)

Mixed

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:802

Gets a parameter that are sent to the server by key.

Parameters:

key String

Paramter key

Returns:

Mixed:

selected param

`getParams`

() Object

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:793

Gets all of the parameters that are sent to the server.

Returns:

Object:

all params

`getQuery`

() String | Object

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:576

Gets the collection option for searching that is sent to the server on fetch.

Returns:

String | Object:

Query value

`getReturnColumns`

() Array

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:500

Returns:

Array:

collection option for the return that is sent to the server on fetch.

`getSortBy`

() String

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:443

Returns:

String:

collection option for sorting ascending or descending that is sent to the server on fetch. Can be ASC or DESC

`hasAPIPagination`

() Boolean

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:1413

Api will return meta data to indicate pagination for grids/lists. The collection will gain properties such as currentPage, nextPage, etc.

Returns:

Boolean:

True if api supports pagination

`idAttribute`

() String

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:170

Returns:

String:

Specifies the key/id of the models in this collection.

`isFetchingTotalRows`

() Boolean

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:396

Returns:

Boolean:

Indicates collection will request total rows on next fetch

`load`

(

id
[options]

)

Promise

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:821

Get the entire data object {with the exception of the ahis session id} that is sent to the server.

Parameters:

id Integer | String

id of single model
[options] Object optional

set of options

Returns:

Promise:

promise when fetch is complete

`makeCollectionFromPrimitiveArray`

(

arr

)

awa.mvc.Collection static

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:1424

Parameters:

arr Array

Array of primitive data types (string, number, boolean, etc)

Returns:

awa.mvc.Collection:

Collection with models that have the primitive as id and name

`onQuery`

(

query

)

Array

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:528

Override this method and return a list of models if you want to implement local querying

Parameters:

query String

string to search

Returns:

Array:

query string to search

`save`

(

models
options

)

Promise

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:1376

Saves several models at a time. Not always supported by backend

Parameters:

models Array

just pass undefined for now
options Object

configuration object with various properties

Returns:

Promise:

sometimes its a promise

`setArgument`

(

key
value

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:604

Sets one collection argument. params, options, and filters will be ignored this is the preferred way of handling "filters"

Parameters:

key String

or array of filters
value String | Array | Object

or array of filters

Returns:

awa.mvc.Collection:

this

`setArguments`

(

obj

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:585

Sets the collection arguments. This must be an object and is the preferred way of handling "filters" The object properties options, filters, and params will overwritten by their pre-existing values.

Parameters:

obj Object

Argument object

Returns:

awa.mvc.Collection:

this

`setFilter`

(

attr
val
comp

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:698

Adds one filter to the array of filters that is sent to the server on fetch.

Used to accept (attr, comp, val) this has been changed for new filtering for hermes and in consideration of deprecating the old addFilter method

Parameters:

attr String

attribute to filter
val String | Array

value(s) to filter
comp String

comparator to use "=",">",">=","<","<=","!=","~" (Only works with hermes)

Returns:

awa.mvc.Collection:

this

`setFilters`

(

filters

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:642

Sets the collection option for all filtering strings that is sent to the server on fetch.

Parameters:

filters String | Array | Object

object or array of filters

Returns:

awa.mvc.Collection:

this

`setLimit`

(

limit

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:452

Sets the collection option for the maximum returned results that is sent to the server on fetch.

Parameters:

limit String | Integer

amount to limit by

Returns:

awa.mvc.Collection:

this

`setOffset`

(

offset

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:508

Sets the collection option for the offset that is sent to the server on fetch.

Parameters:

offset String | Integer

number to start at in a list

Returns:

awa.mvc.Collection:

this

`setOrderBy`

(

order_by

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:338

Sets the collection option for ordering that is sent to the server on fetch.

Parameters:

order_by String

attribute to order by

Returns:

awa.mvc.Collection:

this

`setOrderBy`

(

order_by
sort_by

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:355

Sets the collection option for ordering that is sent to the server on fetch.

Parameters:

order_by String

attribute to order by
sort_by String

ASC or DESC

Returns:

awa.mvc.Collection:

this

`setParam`

(

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:752

Sets the parameter value that is sent to the server

Parameters:

k String

Paramter key
v String

Paramter value

Returns:

awa.mvc.Collection:

this

`setParams`

(

params

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:765

Sets all of the parameters that are sent to the server

Parameters:

params Object

Full parameter set

Returns:

awa.mvc.Collection:

this

`setQuery`

(

query

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:545

Sets the collection option for searching that is sent to the server on fetch. What this is matched against is api/controller dependent.

Parameters:

query String

string to search

Returns:

awa.mvc.Collection:

this

`setReturnColumns`

(

cols

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:472

Sets the collection option for the return that is sent to the server on fetch.

Parameters:

cols Array

Array of attributes

Returns:

awa.mvc.Collection:

this

`setSortBy`

(

sort_by

)

awa.mvc.Collection chainable

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:426

Sets the collection option for sorting ascending or descending that is sent to the server on fetch. Can be ASC or DESC

Parameters:

sort_by String

attribute to sort by

Returns:

awa.mvc.Collection:

this

`sync`

(

method
collection
options

)

Promise

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:1391

Overridden from Backbone.Collection.fetch to handle not so restful backend.

Parameters:

method String

read update or create
collection awa.mvc.Collection

collection this is called on
options Object

xhr options

Returns:

Promise:

sometimes its a promise

`toDisplayJSON`

() Array

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:1042

Uses the displayRules/Methods that are set in either the displayRules property or the attributeProps to generate a javascript object (w/o getters and setters) that represents the model's data in a displayable format.

Returns:

Array:

array of objects

`toJSON`

(

options

)

Array

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:1030

Override of collections toJSON to handle empty indexes

Parameters:

options Object

configuration object with various properties

Returns:

Array:

array of objects

`where`

(

props

)

Array

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:1279

Overridden version of where to be less typesafe and to handle undefined. ID changes from string or int based on if model is new which causes several issues when doing a search

Parameters:

props Object

configuration object with various properties to match on

Returns:

Array:

returns array of matched models

Properties

`_localCache`

Boolean

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:147

Default: false

`api`

String

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:140

Default: barebones

`controller`

awa.mvc.View | Object

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:318

Used to prevent developers from sharing collections among grids.

Default: undefined

`filters`

awa.mvc.View | Object

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:329

Default: object

`lastUpdated`

Date

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:154

Default: null

Events

`filters`

Defined in /var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/Collection.js:633

Gets an argument based on the key

Event Payload:

source awa.mvc.Collection

This collection
args Object

object of arguments
- filters Object
  
  Object of current filters

APIs

awa.mvc.Collection Class

Constructor

awa.mvc.Collection

Parameters:

Item Index

Methods

Properties

Events

Methods

_logLastUpdatedOnSync

Returns:

addFilter

Parameters:

Returns:

addParams

Parameters:

Returns:

addReturnColumn

Parameters:

Returns:

canDoLocalQuery

Returns:

clearFilters

Returns:

displayMethod

Parameters:

Returns:

fetchAll

Parameters:

Returns:

fetchTotalRows

Parameters:

Returns:

filterReject

Parameters:

Returns:

findWhere

Parameters:

Returns:

get

Parameters:

Returns:

getArgument

Parameters:

Returns:

getDisplay

Parameters:

Returns:

getDisplayMethod

Parameters:

Returns:

getFetchData

Returns:

getFilters

Returns:

getFilters

Parameters:

Returns:

getLimit

Returns:

getName

Parameters:

Returns:

getOffset

Returns:

getOrderBy

Returns:

getParam

Parameters:

Returns:

getParams

Returns:

getQuery

Returns:

getReturnColumns

Returns:

getSortBy

Returns:

hasAPIPagination

`awa.mvc.Collection`

`_logLastUpdatedOnSync`

`addFilter`

`addParams`

`addReturnColumn`

`canDoLocalQuery`

`clearFilters`

`displayMethod`

`fetchAll`

`fetchTotalRows`

`filterReject`

`findWhere`

`get`

`getArgument`

`getDisplay`

`getDisplayMethod`

`getFetchData`

`getFilters`

`getFilters`

`getLimit`

`getName`

`getOffset`

`getOrderBy`

`getParam`

`getParams`

`getQuery`

`getReturnColumns`

`getSortBy`

`hasAPIPagination`

`idAttribute`

`isFetchingTotalRows`

`load`

`makeCollectionFromPrimitiveArray`

`onQuery`

`save`

`setArgument`

`setArguments`

`setFilter`

`setFilters`

`setLimit`

`setOffset`

`setOrderBy`

`setOrderBy`

`setParam`

`setParams`

`setQuery`

`setReturnColumns`

`setSortBy`

`sync`

`toDisplayJSON`

`toJSON`

`where`

`_localCache`