Skip to main content

Implementing advanced sort in Grails

The "list" pages generated by inbuilt scaffolding/template features of grails have pagination and sorting features. However, if the domain object displayed in the list is a nested object having another domain object as a property, you may notice that sort is not enabled for that field. Boiler plate code for the header of the list is shown below.
















As you would have noticed few columns have sortable columns automatically generated by Grails command, generate-all or generate-views.

The properties 'partyAccount' and 'bankAccount' in this sample are domain classes nested in the domain class 'partyTransaction'. We could convert them to sortable columns by using the tag g:sortableColumn.
eg:
<g:sortableColumn property="party" title="${message(code: 'paymentTransaction.party.label', default: 'Party')}"></g:sortableColumn>


The sort behavior is magically introduced after this modification.

The version of the code generated by grails in the corresponding controller class is shown below:



def list = {
params.max = Math.min( params.max ? params.max.toInteger() : 10, 100)
params.sort = params.sort?:'id'
[ paymentTransactionInstanceList: PaymentTransaction.list( params ),paymentTransactionInstanceTotal: PaymentTransaction.count() ]
}


The sort result may not be as anticipated. How do we enforce sort on a custom property?
An enhanced version to get custom sort behavior is given below:



def list = {

params.max = Math.min( params.max ? params.max.toInteger() : 10, 100)
params.offset = params.offset? params.offset.toInteger():0
params.sort = params.sort?:'id'
params.order = params.order?:'desc'
def lst = PaymentTransaction.createCriteria().list{

createAlias ('partyAccount', 'pa')

if (params.sort == 'partyAccount')
order ('pa.accountName', params.order)
else

order (params.sort, params.order)

maxResults (params.max)
firstResult (params.offset)
}

[ paymentTransactionInstanceList: lst, paymentTransactionInstanceTotal: PaymentTransaction.count() ]
}



We can also implement sort on more than one column as below:



def list = {

params.max = Math.min( params.max ? params.max.toInteger() : 10, 100)
params.offset = params.offset? params.offset.toInteger():0
params.sort = params.sort?:'id'
params.order = params.order?:'desc'
def lst = PaymentTransaction.createCriteria().list{

createAlias ('partyAccount', 'pa')
createAlias ('bankAccount', 'ba')

order ('pa.accountName', 'asc')
order ('ba.accountName', 'asc')

order (amount, 'desc')
maxResults (params.max)
firstResult (params.offset)
}

[ paymentTransactionInstanceList: lst, paymentTransactionInstanceTotal: PaymentTransaction.count() ]
}



Sample classes used in the example:

class PaymentTransaction{
static belongsTo =[partyAccount:Account, bankAccount:Account, ...]
double amount
..
..


}

class Account{
String accountName
..
..
}





Note: In case the property 'partyAccount' is nullable you may force LEFT JOIN to get the right results.


createAlias ('partyAccount', 'pa', CriteriaSpecification.LEFT_JOIN)

Comments

  1. Thanks a lot,

    saved hours....

    ReplyDelete
    Replies
    1. very Helpful.What if you have dynamically generated headers,How do you sort and paginate them.thanks

      Delete

Post a Comment

Popular posts from this blog

Grails - cross-field Date validation

Often we run into domain classes with date fields. If the domain class has two datefields, startDate and endDate, and the rule for a valid combination is "endDate to be greater than startDate", how do we handle? I listed below two of the options, either using domain level constraints or using the domain classes. Option 1: Using domain constraints. Let us take a sample Grails Domain class class Student{ String name String school Date startDate Date endDate } Add the following constraints to enforce validation rules where name, school, startDate cannot be blank and endDate if present should be greater than startDate.

Grails - Querying complex associations

Criteria class allows performing complex searches on grails objects. There are number of shortcut methods for performing queries but these methods have limitations in terms of number of conditions used in "where clauses". Traditional sql "joins" are not possible as shown in some of the Grails "Finder" methods shown below. Sample 1: def list = AccountTransaction.findAllByCompanyCodeAndVoucherDateBetween(branch, fromDate, toDate, params) Sample 2: def list = AccountTransaction.findAllByCompanyCodeAndVoucherDateGreaterThanEquals(branch, fromDate, params) Sample 3: def list = AccountTransaction.findAllByCompanyCodeAndTransGroup(branch, group, params) "params" contains attributes related to sorting, paging etc. It is very easy to use finder methods but when you want to filter objects by more conditions we need to look for alternatives. For understanding the relationships used in this sample, I listed the grails domain classes. class TransactionTyp