$from

There are several “helpers” in OpenAF to help to “query” array of maps that help to make code cleaner. For a complete list (like JMESPath) see on the end of this document. nLinq is currently the most use one.

Quick examples:

// How many contacts there are with email ending in @domain.com
$from( arrayOfContacts )
.ends("email", "@domain.com")
.count();

// Sort all contacts in @domain.com by first name and last name
$from( arrayOfContacts )
.ends("email", "@domain.com")
.sort("firstName", "lastName")
.select()

Reference

nLinq queries are made through a series of calls divided into three main areas:

var result = $from( aSourceArray )      // FROM part
             .equals("aKey1", aValue)   // WHERE part
             .greater("aKey2", 10)      //
             .select()                  // SELECT part

FROM

The input should be primarially an array. If a map is provided it will be converted into an array. For streams it can also be a function.

Simple array 

var inData  = [ 1, 2, 3 ];
var outData = $from(inData).select();
// [ 1, 2, 3 ]

Array of maps 

var inData  = [ { a: 1 }, { a: 2 }, { a: 3 } ];
var outData = $from(inData).select();
// [ {a: 1}, {a: 2}, {a: 3} ]

Simple map 

var inData  = { a: 1, b: 2, c: 3};
var outData = $from(inData).select();
// [ 1, 2, 3 ]

Map of maps 

var inData  = { a1: { a: 1 }, a2: { a: 2 }, a3: { a: 3 } };
var outData = $from(inData).select();
// [ { a: 1, _key: "a1" }, { a: 2, _key: "a2" }, { a: 3, _key: "a3"} ]

A function 

var ll = 0, sum = 0;
var fn = () => ll++;
$from(fn).limit(5).stream(r => sum += r);
// sum = 10 | ll = 6

WHERE

Restriciting prefixes and suffixes

Consider the following example:

var names = [
  { first: "James", last: "Bond" },
  { first: "James", last: "Scott" },
  { first: "Louis", last: "Bond" }
];
Method Description Example
starts Restricts string fields prefix to a value $from(names).starts("first", "J").select()
andStarts Restricts string fields prefix to a value in addition to the previous restriction $from(names).starts("first", "J").starts("last", "B").select()
notStarts Restricts string fields that are not prefixed by a value $from(names).notStarts("first", "J").select()
andNotStarts Restricts string fields that are not prefixed by a value in addition to the previous restriction $from(names).starts("first", "J").andNotStarts("last", "S").select()
orStarts Restricts string fields prefix to a value in alternative to the previous restriction $from(names).starts("first", "Ja").orStarts("last", "Bo").select()
orNotStarts Restricts string fields prefix that are not prefixed by a value in alternative to the previous restriction $from(names).starts("first", "Ja").orNotStarts("last", "Sc").select()
ends Restricts string fields suffix to a value $from(names).ends("last", "nd").select()
andEnds Restricts string fields suffix to a value in addition to the previous restriction $from(names).ends("first", "es").andEnds("last", "d").select()
notEnds Restricts string fields that are not suffixed by a value $from(names).notEnds("last", "Bond").select()
andNotEnds Restricts string fields that are not suffixed by a value in addition to a previous restriction $from(names).starts("first", "J").andNotEnds("last", "d").select()
orEnds Restricts string fields that are suffixed by a value in alternative to a previous restriction $from(names).starts("first", "J").orEnds("first", "d").select()
orNotEnds Restricts string fields that are not suffixed by a value in alternative to a previous restriction $from(names).starts("first", "J").orNotEnds("first", "s").select()

Restricting by equality

Method Description Example
andEquals    
greaterEquals    
andGreaterEquals    
notGreaterEquals    
andNotGreaterEquals    
orGreaterEquals    
orNotGreaterEquals    
lessEquals    
andLessEquals    
andNotLessEquals    
orLessEquals    
orNotLessEquals    

Restricting by value

Method Description Example
greater    
andGreater    
notGreater    
andNotGreater    
orGreater    
orNotGreater    
less    
andLess    
notLess    
andNotLess    
orLess    
orNotLess    
between    
andBetween    
andNotBetween    
orBetween    
orNotBetween    
betweenEquals    
andBetweenEquals    
andNotBetweenEquals    
orBetweenEquals    
orNotBetweenEquals    

Restricting by value matching

Method Description Example
contains    
andContains    
andNotContains    
orContains    
orNotContains    
empty    
andEmpty    
andNotEmpty    
orEmpty    
orNotEmpty    
match    
andMatch    
andNotMatch    
orMatch    
orNotMatch    

Restricting by value type

Method Description Example
type    
andType    
andNotType    
orType    
orNotType    
Method Description Example
is    
andIs    
andNotIs    
orIs    
orNotIs    
or    
and    
not    
andNot    
orNot    

Changing the current result set

Method Description Example
each    
intersect    
cartesian    
except    
union    
attach    
sort    
assign    
join    
skip    
take    
skipTake    
define    
removed    
stream    
streamFn    

SELECT

Method Description Example
select Returns all fields from the original array $from(anArray).select()
select (selected fields) Returns specific fields with corresponding default values $from(anArray).select({ f1: "n/a", f2: false })
select (transform function) Returns the result of the transformation function $from(anArray).select(r => ({ f1: r.f1, f2: r.a1 + r.a2 }))
min Returns the minimum value of a field from the result $from(anArrayOfTemperatures).min("temperature")
max Returns the maximum value of a field from the result $from(anArrayOfTemperatures).max("temperature")
average Returns the average value of a field from the result $from(anArrayOfTemperatures).average("temperature")
sum Returns the sum value of a field from the result $from(anArrayOfFiles).sum("size")
distinct Returns an array of distinct values for a specific field from the result $from(anArrayOfMeasures).distinct("measureName")
group Returns a map grouping the array records by a specific field from the result $from(anArrayOfTemperatures).group("city")
at Returns a single entry of the result set $from(anArray).at(23)
all Returns true if all records from the original array are present on the final result set (false otherwise) $from(anArray).all()
count Returns the number of records of the final result set $from(anArray).count()
first Returns the first record of the final result set $from(anArray).first()
last Returns the last record of the final result set $from(anArray).last()
any Returns true if the result set has any record at all (false otherwise) $from(anArray).any()
none Returns true if the result set is empty (false otherwise) $from(anArray).none()
reverse Returns a reverse order result set $from(anArray).reverse()
limit Returns just a limited amount of records of the result set $from(anArray).limit(5)
head Returns a limited amount of the first records of the result set $from(anArray).head(10)
tail Returns a limited amount fo the last records of the result set $from(anArray).tail(10)

Simple select

Return the current result set with the WHERE part applied:

var result = $from([ 1, 2, 3 ]).select();
// [ 1, 2, 3 ]

Select the fields

Return the current result set with the WHERE part restricting each map entry on the result to the fields provided and their default values in case they are not present:

var inData = [ 
    { name: "Point 1", x: 1, y: -1 }, 
    { name: "Point 2", x: 5, y: -5 },
    { x: 3 }
]; 
var result = $from(inData).select({ x: 0, y: 0 });
// [ { x: 1, y: -1 },
//   { x: 5, y: -5 },
//   { x: 3, y: 0  } ]

Transform function

The result set will be transformed by the provided function:

var inData = [
    { name: "Vector 1", x1: 2, y1: -1, x2: 5, y2: -10 },
    { name: "Vector 2", x1: -2, y1: -1, x2: 5, y2: 10 }
];
var result = $from(inData).select(r => {
    var newResult = { name: r.name };

    newResult.distance = Math.round( Math.sqrt( Math.pow(r.x1-r.x2, 2) + Math.pow(r.y1-r.y2, 2)));

    return newResult;
});
// [ { name: "Vector 1", distance: 9 },
//   { name: "Vector 2", distance: 13} ]

Other libraries in OpenAF