Class: Query

Constant Summary

JOIN_STYLES =

['INNER', 'OUTER']

BIO_FORMATS =

['gff3', 'fasta', 'bed']

NULL_OPS =

['IS NULL', 'IS NOT NULL']

ATTRIBUTE_VALUE_OPS =

["=", "!=", ">", ">=", "<", "<=", "CONTAINS", "LIKE", "NOT LIKE"]

MULTIVALUE_OPS =

['ONE OF', 'NONE OF']

TERNARY_OPS =

['LOOKUP']

LOOP_OPS =

['=', '!=']

LIST_OPS =

['IN', 'NOT IN']

OP_DICT =

{
  '=': '=',
  '==': '==',
  'eq': '=',
  'eqq': '==',
  '!=': '!=',
  'ne': '!=',
  '>': '>',
  'gt': '>',
  '>=': '>=',
  'ge': '>=',
  '<': '<',
  'lt': '<',
  '<=': '<=',
  'le': '<=',
  'contains': 'CONTAINS',
  'CONTAINS': 'CONTAINS',
  'does not contain': 'DOES NOT CONTAIN',
  'DOES NOT CONTAIN': 'DOES NOT CONTAIN',
  'like': 'LIKE',
  'LIKE': 'LIKE',
  'not like': 'NOT LIKE',
  'NOT LIKE': 'NOT LIKE',
  'lookup': 'LOOKUP',
  'IS NULL': 'IS NULL',
  'is null': 'IS NULL',
  'IS NOT NULL': 'IS NOT NULL',
  'is not null': 'IS NOT NULL',
  'ONE OF': 'ONE OF',
  'one of': 'ONE OF',
  'NONE OF': 'NONE OF',
  'none of': 'NONE OF',
  'in': 'IN',
  'not in': 'NOT IN',
  'IN': 'IN',
  'NOT IN': 'NOT IN',
  'WITHIN': 'WITHIN',
  'within': 'WITHIN',
  'OVERLAPS': 'OVERLAPS',
  'overlaps': 'OVERLAPS',
  'DOES NOT OVERLAP': 'DOES NOT OVERLAP',
  'does not overlap': 'DOES NOT OVERLAP',
  'OUTSIDE': 'OUTSIDE',
  'outside': 'OUTSIDE',
  'ISA': 'ISA',
  'isa': 'ISA'
}

Class Method Summary

• + (Object) fromXML(xml) Load the first query found in the XML.

Instance Method Summary

• - (Query) on(events, callback, context) Bind a callback to an event.
• - (void) bind(args...) alias for #on
• - (void) off(events, callback, context) Remove a particular event handler, or a more general collection.
• - (void) unbind(args...) alias for #off
• - (Query) once(events, callback, context) Bind an event to be executed once, and then unbound.
• - (void) emit(args...) Alias for #trigger
• - (Query) trigger(events, rest...) Trigger a given set of events.
• - (void) constructor(properties, service, undefined = {}) Constructor Construct a new Query object from a set of properties.
• - (Query) removeFromSelect(unwanted = []) Remove the given paths from the select list.
• - (void) removeConstraint(con, silent = false)
• - (void) addToSelect(views = []) Add an element to the select list.
• - (void) select(views) Bound Replace the existing select list with the one passed as an argument.
• - (void) adjustPath(path) Bound Interpret an argument as resolve the canonical path it refers to.
• - (void) getPossiblePaths(depth = 3)
• - (void) getPathInfo(path)
• - (void) getSubclasses()
• - (void) getType(path) Get the type of a path.
• - (void) getViewNodes() Get all the nodes present in the view.
• - (void) isInView(path) Check to see whether a path is in the view.
• - (?) isConstrained(path, includeAttrs = false) Check to see whether a path is constrained to a value.
• - (void) canHaveMultipleValues(path) Return true is the path passed as an argument could possibly represent multiple values (this is true when any of the nodes that the path descends from represents a collection of values.
• - (void) getQueryNodes() Get all the nodes present to the query, whether they are in the views, or the constraints.
• - (void) isInQuery(p)
• - (void) isRelevant(path)
• - (void) expandStar(path) Bound Interpret a path that might end in '' or '*' as the set of default paths it represent.
• - (void) isOuterJoin(p)
• - (void) hasView(v)
• - (Promise<Number>) count(cont) Get a promise to yield a count.
• - (void) appendToList(target, cb) Add the results of this query to a list on the server.
• - (Query) selectPreservingImpliedConstraints(paths = []) Get a clone of this query with the given paths selected.
• - (Query) makeListQuery() Get a clone of this query that can be used for list operations.
• - (void) saveAsList(options, cb)
• - (Promise<Array<Object>, Object>) summarise(path, limit, cont) Get a summary for a single column in the results.
• - (Promise<Array<Object>, Object>) summarize(args...) Get a summary for a single column in the results.
• - (Promise<Array<Object>, Object>) filterSummary(path, term, limit, cont = (function() {})) Get a summary for a single column in the results, filtered by a given value.
• - (Query) clone(cloneEvents) Get an unconnected, deep clone of this query.
• - (Query) next() Get the query for the next page of results.
• - (Query) previous() Get the query for the previous page of results.
• - (void) getSortDirection(sorted)
• - (void) isOuterJoined(path)
• - (void) getOuterJoin(path)
• - (void) _parse_sort_order(input)
• - (void) addOrSetSortOrder(so)
• - (void) addSortOrder(so)
• - (void) orderBy(oes)
• - (void) addJoins(joins)
• - (void) addJoin(join)
• - (void) setJoinStyle(path, style = 'OUTER')
• - (void) addConstraints(constraints)
• - (void) addConstraint(constraint) Bound
• - (void) getSorting()
• - (void) getConstraintXML()
• - (void) getJoinXML()
• - (void) toXML()
• - (void) toJSON()
• - (void) fetchCode(lang, cb)
• - (void) setName(name)
• - (void) save(name, cb) Save a query to the server, overwriting any query of the same name.
• - (void) store(name, cb) Store this query for the first time, avoiding name collisions.
• - (void) saveAsTemplate(name, cb)
• - (void) getCodeURI(lang)
• - (void) getExportURI(format = 'tab', options = {})
• - (Boolean) needsAuthentication() Return true if this query will require user authentication to run correctly.
• - (Promise<int>) fetchQID(cb) Get a query id for referencing this query in subsequent requests.
• - (void) __bio_req(types, n)
• - (void) _fasta_req()
• - (void) _gff3_req()

Class Method Details

             to `new Query(json)`.

Constructor Details

    to be used for given paths.
    when expanding `*` paths.
    paths to use to determine the sort-order.

Instance Method Details

   list of selected columns.

                         will also be cloned.