feedSort

Home > Books > NetKernel API and Services Reference > Accessor Listing > PiNKY > feedSort

Module

The Sort accessor is exported by the urn:org:pinkypipes:mod:pinky module. Import this module to gain access to the accessor.

Syntax

URI

active:Sort

Argument	Rules	Description
feed	Mandatory	A feed resource
operator	Mandatory	XML sort specification

Example Usage

DPML

<instr>
  <type>feedSort</type>
  <feed>var:afeed</feed>
  <operator>
    <sort>
      <date />
    </sort>
  </operator>
  <target>var:feedsortedbydate</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:Sort");
req.addArgument("feed", [resource representation, aspect, or URI] );
req.addArgument("operator", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

The feedSort accessor sorts feed entries according to a declarative sort order specifed by the operator argument. The sort specificiation must be a <sort> xml fragment containing the sort order.

XML Sort Format

An example of the format for the <sort> xml fragment is as follows:

<sort>
  <date />
</sort>

The sort doc must contain at least one of the following first child elements...

tag	description
date	Sort by date (oldest first)
rdate	Sort by reverse date (youngest first)
title	Sort by title (alphabetic)
rtitle	Sort by reverse title (reverse-alphabetic)
description	Sort by description (alphabetic)
rdescription	Sort by reverse description (reverse-alphabetic)
author	Sort by author (alphabetic)
rauthor	Sort by reverse author (reverse-alphabetic)
category	Sort by category (alphabetic)
rauthor	Sort by reverse category (reverse-alphabetic)
update	Sort by revision update (oldest first) (Atom Only)
rupdate	Sort by reverse update (youngest first) (Atom Only)

Sort precedence will take the order specified by the sort entries. For example, specifying 'title' followed by 'date' will sort first by the title and then by date.

Example 1: Sort the feed by title

This is how to sort the feed by title using Sort in a DPML script:

<instr>
  <type>feedSort</type>
  <feed>var:afeed</feed>
  <operator>
    <sort>
      <title />
    </sort>
  </operator>
  <target>var:sortedfeed</target>
</instr>

Example 2: Sort by multiple criteria

This is how to sort by reverse date (youngest first), then by feed title:

<instr>
  <type>feedSort</type>
  <feed>var:afeed</feed>
  <operator>
    <sort>
      <rdate />
      <title />
    </sort>
  </operator>
  <target>var:sortedfeed</target>
</instr>

For more details see the PiNKY guide.