CollectionContentsSortableDataProvider.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

package org.apache.isis.viewer.wicket.ui.components.collectioncontents.ajaxtable;

import com.google.common.base.Predicate;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Ordering;
import org.apache.isis.applib.annotation.Where;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.core.metamodel.consent.InteractionInitiatedBy;
import org.apache.isis.core.metamodel.consent.InteractionResult;
import org.apache.isis.core.metamodel.interactions.InteractionUtils;
import org.apache.isis.core.metamodel.interactions.ObjectVisibilityContext;
import org.apache.isis.core.metamodel.interactions.VisibilityContext;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import org.apache.isis.core.metamodel.spec.ObjectSpecificationException;
import org.apache.isis.core.metamodel.spec.feature.ObjectAssociation;
import org.apache.isis.viewer.wicket.model.models.EntityCollectionModel;
import org.apache.isis.viewer.wicket.model.models.EntityModel;
import org.apache.wicket.extensions.ajax.markup.html.repeater.data.table.AjaxFallbackDefaultDataTable;
import org.apache.wicket.extensions.markup.html.repeater.util.SortParam;
import org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider;
import org.apache.wicket.model.IModel;

import java.util.Iterator;
import java.util.List;

/**
 * Part of the {@link AjaxFallbackDefaultDataTable} API.
 */
public class CollectionContentsSortableDataProvider extends SortableDataProvider<ObjectAdapter,String> {

    private static final long serialVersionUID = 1L;

    private final EntityCollectionModel model;

    public CollectionContentsSortableDataProvider(final EntityCollectionModel model) {
        this.model = model;
    }

    @Override
    public IModel<ObjectAdapter> model(final ObjectAdapter adapter) {
        return new EntityModel(adapter);
    }

    @Override
    public long size() {
        return model.getObject().size();
    }

    @Override
    public void detach() {
        super.detach();
        model.detach();
    }

    public EntityCollectionModel getEntityCollectionModel() {
        return model;
    }

    @Override
    public Iterator<ObjectAdapter> iterator(final long first, final long count) {

        final List<ObjectAdapter> adapters = model.getObject();

        final Iterable<ObjectAdapter> visibleAdapters =
                Iterables.filter(adapters, ignoreHidden());

        // need to create a list from the iterable, then back to an iterable
        // because guava's Ordering class doesn't support sorting of iterable -> iterable
        final List<ObjectAdapter> sortedVisibleAdapters = sortedCopy(visibleAdapters, getSort());
        final List<ObjectAdapter> pagedAdapters = subList(first, count, sortedVisibleAdapters);
        return pagedAdapters.iterator();
    }

    private static List<ObjectAdapter> subList(
            final long first,
            final long count,
            final List<ObjectAdapter> objectAdapters) {

        final int fromIndex = (int) first;
        // if adapters where filter out (as invisible), then make sure don't run off the end
        final int toIndex = Math.min((int) (first + count), objectAdapters.size());

        return objectAdapters.subList(fromIndex, toIndex);
    }

    private List<ObjectAdapter> sortedCopy(
            final Iterable<ObjectAdapter> adapters,
            final SortParam<String> sort) {

        final ObjectAssociation sortProperty = lookupAssociationFor(sort);
        if(sortProperty == null) {
            return Lists.newArrayList(adapters);
        }

        final Ordering<ObjectAdapter> ordering =
                orderingBy(sortProperty, sort.isAscending());
        return ordering.sortedCopy(adapters);
    }

    private ObjectAssociation lookupAssociationFor(final SortParam<String> sort) {

        if(sort == null) {
            return null;
        }

        final ObjectSpecification elementSpec = model.getTypeOfSpecification();
        final String sortPropertyId = sort.getProperty();

        try {
            // might be null, or throw ex
            return elementSpec.getAssociation(sortPropertyId);
        } catch(ObjectSpecificationException ex) {
            // eg invalid propertyId
            return null;
        }
    }

    private Predicate<ObjectAdapter> ignoreHidden() {
        return new Predicate<ObjectAdapter>() {
            @Override
            public boolean apply(ObjectAdapter input) {
                final InteractionResult visibleResult = InteractionUtils.isVisibleResult(input.getSpecification(), createVisibleInteractionContext(input));
                return visibleResult.isNotVetoing();
            }
        };
    }

    private VisibilityContext<?> createVisibleInteractionContext(final ObjectAdapter objectAdapter) {
        return new ObjectVisibilityContext(
                objectAdapter, objectAdapter.getSpecification().getIdentifier(), InteractionInitiatedBy.USER,
                Where.ALL_TABLES);
    }

    private static Ordering<ObjectAdapter> orderingBy(final ObjectAssociation sortProperty, final boolean ascending) {
        final Ordering<ObjectAdapter> ordering = new Ordering<ObjectAdapter>(){
    
            @Override
            public int compare(final ObjectAdapter p, final ObjectAdapter q) {
                final ObjectAdapter pSort = sortProperty.get(p, InteractionInitiatedBy.FRAMEWORK);
                final ObjectAdapter qSort = sortProperty.get(q, InteractionInitiatedBy.FRAMEWORK);
                Ordering<ObjectAdapter> naturalOrdering;
                if(ascending){
                    naturalOrdering = ORDERING_BY_NATURAL.nullsFirst();
                } else {
                    naturalOrdering = ORDERING_BY_NATURAL.reverse().nullsLast();
                }
                return naturalOrdering.compare(pSort, qSort);
            }
        };
        return ordering;
    }

    private static Ordering<ObjectAdapter> ORDERING_BY_NATURAL = new Ordering<ObjectAdapter>(){
        @Override
        public int compare(final ObjectAdapter p, final ObjectAdapter q) {
            final Object pPojo = p.getObject();
            final Object qPojo = q.getObject();
            if(!(pPojo instanceof Comparable) || !(qPojo instanceof Comparable)) {
                return 0;
            } 
            return naturalOrdering(pPojo, qPojo);
        }
        @SuppressWarnings("rawtypes")
        private int naturalOrdering(final Object pPojo, final Object qPojo) {
            Comparable pComparable = (Comparable) pPojo;
            Comparable qComparable = (Comparable) qPojo;
            return Ordering.natural().compare(pComparable, qComparable);
        }
    };



}