[#TM-239] Filter.orderBy() API for sorting results - comm.world Open Source-Kit (OS-Kit)

Tiny Marbles

Filter.orderBy() API for sorting results

Created: 20/Nov/06 12:08 Central European Time Updated: 06/Mar/07 17:26 Central European Time

Component/s:

Filters and Queries

Affects Version/s:

None

Fix Version/s:

0.9.5

Original Estimate:

Unknown

Remaining Estimate:

Unknown

Time Spent:

Unknown

Issue Links:

Cause

This issue causes:
	~~TM-282~~ Finish refactoring of the CriteriaQue...

Precedence

This issue must be done before:
	~~MUM-11~~ Sorting in the list
	~~CMS-67~~ List all articles: sorting result
	~~CMS-68~~ List all versions: sorting result

Related

This issue relates to:
	~~TM-283~~ Fail when PType.put() is called using...

This issue is related with:
	TM-306 Coverage tests for sorter elements

Description

« Hide

We need to be able to sort results by attribute value. I think an API like this could work:

List<PObject> users = repository.createFilter("User")
   .like("name", "a%")
   .orderBy("name")
   .list();

Maybe a better API would be sortAsc and sortDesc. The following example would sort first by release date, newest first, then by title, alphabetically:

List<PObject> objects = repository.createFilter("Songs")
  .in("tags", "rock")
  .sortDesc("releaseDate")
  .sortAsc("title")
  .list();

Since we are using the Criteria API from Hibernate under the hood, we can transfer the same semantics.

All

Comments

Work Log

Change History

Version Control

Time Spent

Sort Order:

[ Permlink | « Hide ]

Tiago Silveira - [20/Nov/06 12:09 Central European Time ]

Sorting in MUM should be done mainly with the Marbles filter.

[ Permlink | « Hide ]

Tiago Silveira - [08/Feb/07 18:19 Central European Time ]

Still not complete. I only added a sorter for the attributes. We need to add sorting by SystemId and by Parent too.

Maybe some constants?

Filter.sortAsc(Filter.SYSTEM_ID);

or

Filter.sortBySystemIdAsc();

There's also the possibility to reserve those words:

Filter.sortAsc("systemId"); // it's never an attribute.

This might even be better, but would cause a compatibility break, so we cannot release it for 0.9.5.

[ Permlink | « Hide ]

Tiago Silveira - [09/Feb/07 19:47 Central European Time ]

I have also added two extra cases:

1) systemId and id are reserved

2) if a key contains a dot (e.g. "marriedTo.name"), it will be interpreted as a reference to another object. You can go as deep as you want, if the object doesn't have the correct key, the value is interpreted as being NULL.

2.b) if a key or fragment starts with "parent.", it will be interpreted not as a reference to another PObject, but as a reference to the parent PObject.

Thus, the following sorting is valid:

Filter.sortAsc("parent.name")
.sortDesc("marriedTo.parent.id");

It will be interpreted as sort ascending on the parent's name and descending on the id of the parent of the object reached by the reference "marriedTo".