FilterDecorator.java

/**
 *  Copyright 2012 Universitat Pompeu Fabra.
 *
 *  Licensed 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.onexus.website.api.widgets.tableviewer.decorators.filter;

import org.apache.wicket.AttributeModifier;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.panel.EmptyPanel;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.util.string.Strings;
import org.onexus.collection.api.Collection;
import org.onexus.collection.api.Field;
import org.onexus.collection.api.IEntity;
import org.onexus.resource.api.ORI;
import org.onexus.resource.api.Parameters;
import org.onexus.website.api.Website;
import org.onexus.website.api.events.AbstractEvent;
import org.onexus.website.api.events.EventAddFilter;
import org.onexus.website.api.pages.browser.BrowserPageLink;
import org.onexus.website.api.pages.browser.BrowserPageStatus;
import org.onexus.website.api.pages.browser.SingleEntitySelection;
import org.onexus.website.api.widgets.tableviewer.decorators.utils.FieldDecorator;
import org.onexus.website.api.widgets.tableviewer.decorators.utils.LinkPanel;

import java.util.ArrayList;
import java.util.List;

public class FilterDecorator extends FieldDecorator {

    private ORI collectionId;

    private String emptyValue;

    public FilterDecorator(ORI collectionId, Field field, Parameters parameters) {
        super(field);
        this.collectionId = collectionId;
        this.emptyValue = parameters.get(FilterDecoratorParameters.EMPTY_VALUE);
    }

    @Override
    public void populateCell(WebMarkupContainer cellContainer, String componentId, IModel<IEntity> data) {

        Object value = getValue(data.getObject());

        if (value == null) {
            if (Strings.isEmpty(emptyValue)) {
                cellContainer.add(new EmptyPanel(componentId));
            } else {
                cellContainer.add(new Label(componentId, emptyValue));
            }

            return;
        }

        String label = "<i class=\"icon-hand-up\"></i>";
        String tooltip = "Filter results by " + getField().getLabel() + " = " + value;
        LinkPanel linkPanel = new LinkPanel(componentId, label, getLink(collectionId, data, tooltip));
        cellContainer.add(linkPanel);
    }

    protected WebMarkupContainer getLink(ORI collectionId, IModel<IEntity> data, String tooltip) {

        String entityId = null;
        IEntity entity = data.getObject();

        if (entity.getCollection().getORI().equals(collectionId)) {
            entityId = entity.getId();
        } else {
            entityId = String.valueOf(entity.get(getField().getId()));
        }

        WebMarkupContainer link = new BrowserPageLink<SingleEntitySelection>(LinkPanel.LINK_ID, Model.of(new SingleEntitySelection(collectionId, entityId))) {

            @Override
            public void onClick(AjaxRequestTarget target) {
                BrowserPageStatus status = getBrowserPageStatus();
                SingleEntitySelection rowEntity = getModelObject();

                // Try to make the link relative to the current website project
                Website website = findParent(Website.class);
                if (website != null) {
                    ORI projectUri = website.getConfig().getORI().getParent();
                    ORI relativeUri = rowEntity.getSelectionCollection().toRelative(projectUri);
                    rowEntity.setFilteredCollection(relativeUri);
                }

                AbstractEvent[] events = FilterDecorator.this.onClick(rowEntity, status);
                for (AbstractEvent event : events) {
                    sendEvent(event);
                }
            }

        };

        link.add(new AttributeModifier("rel", "tooltip"));
        link.add(new AttributeModifier("title", tooltip));
        link.add(new AttributeModifier("data-placement", "right"));
        return link;
    }

    protected AbstractEvent[] onClick(SingleEntitySelection rowEntity, BrowserPageStatus status) {

        // Fix current row entity
        status.addEntitySelection(rowEntity);

        return new AbstractEvent[]{EventAddFilter.EVENT};
    }

    @Override
    public List<String> getExtraFields(Collection collection) {
        List<String> fields = new ArrayList<String>();
        for (Field field : collection.getFields()) {
            if (field.isPrimaryKey() != null && field.isPrimaryKey()) {
                fields.add(field.getId());
            }
        }
        return fields;
    }
}