org.eclipse.osbp.runtime.web.vaadin.common/src/org/eclipse/osbp/runtime/web/vaadin/common/data/filter/JoinFilter.java

/**
 * Copyright 2009-2013 Oy Vaadin Ltd
 *
 * 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.eclipse.osbp.runtime.web.vaadin.common.data.filter;

import com.vaadin.data.Container.Filter;
import com.vaadin.data.Item;
import com.vaadin.data.util.filter.AbstractJunctionFilter;

/**
 * This filter allows you to implement filtering on joined tables using
 * Hibernate, which lacks support for automatic joins. EclipseLink supports
 * automatic joins, which allows you to filter by e.g.
 * <code>new Equal("skills.skill", s)</code>, while Hibernate requires you to do
 * the same using this filter e.g.
 * <code>new JoinFilter("skills", new Equal("skill", s))</code>
 */
@SuppressWarnings("serial")
public class JoinFilter extends AbstractJunctionFilter {

    private final String joinProperty;

    /**
     * Constructs a HibernateJoin filter.
     * 
     * @param joinProperty
     *            the property that should be joined
     * @param filters
     *            a set of filters filtering on the joined property. By default
     *            all filters much pass for the item to be matched.
     */
    public JoinFilter(String joinProperty, Filter... filters) {
        super(filters);
        this.joinProperty = joinProperty;
    }

    /**
     * @return the property that is joined on
     */
    public String getJoinProperty() {
        return joinProperty;
    }

    /*
     * (non-Javadoc)
     * 
     * @see com.vaadin.data.Container.Filter#passesFilter(java.lang.Object,
     * com.vaadin.data.Item)
     */
    public boolean passesFilter(Object itemId, Item item)
            throws UnsupportedOperationException {
        for (Filter f : getFilters()) {
            if (!f.passesFilter(itemId, item)) {
                return false;
            }
        }
        return true;
    }
}