de.unioninvestment.eai.portal.portlet.crud.ui.search.SearchBox.java Source code

Introduction

Here is the source code for de.unioninvestment.eai.portal.portlet.crud.ui.search.SearchBox.java

Source

/*
 * 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 de.unioninvestment.eai.portal.portlet.crud.ui.search;

import static de.unioninvestment.eai.portal.support.vaadin.context.Context.getMessage;

import java.util.Collection;
import java.util.Map;

import com.google.common.base.Strings;
import com.vaadin.data.Property;
import com.vaadin.data.util.filter.SimpleStringFilter;
import com.vaadin.shared.ui.combobox.FilteringMode;
import com.vaadin.ui.ComboBox;
import com.vaadin.ui.Notification;

/**
 * Search Widget.
 * 
 * @author cmj
 */
@SuppressWarnings("serial")
public class SearchBox extends ComboBox {

    private static final long serialVersionUID = 1L;

    /**
     * Handler that delivers autosuggest options.
     */
    public interface OptionHandler {
        Collection<String> getOptions(String filterString);
    }

    /**
     * Handler that validates and executes queries
     */
    public interface QuerySearchHandler {
        /**
         * @param expression
         *            the search string
         * @return true, if the expression is a valid query
         */
        boolean isValidQuery(String expression);

        /**
         * @param expression
         *            the search string
         */
        void search(String expression);
    }

    private SearchContainerDataSource container;
    private String previousFilterString;
    private String caseSensitiveFilterstring;

    private QuerySearchHandler searchHandler;

    private String lastNewItem;

    public SearchBox(QuerySearchHandler searchHandler) {
        this.searchHandler = searchHandler;

        container = new SearchContainerDataSource();

        setItemCaptionMode(ItemCaptionMode.PROPERTY);
        setItemCaptionPropertyId("value");
        setContainerDataSource(container);
        setImmediate(true);
        setNewItemsAllowed(true);
        setNullSelectionAllowed(true);

        addValueChangeListener(new Property.ValueChangeListener() {
            @Override
            public void valueChange(com.vaadin.data.Property.ValueChangeEvent event) {
                handleValueChange(event);
            }

        });
        setNewItemHandler(new NewItemHandler() {

            @Override
            public void addNewItem(String newItemCaption) {
                handleAddNewItem(newItemCaption);
            }

        });
    }

    public void setOptionHandler(OptionHandler handler) {
        container.setOptionHandler(handler);
    }

    @Override
    public void setValue(Object newValue) throws com.vaadin.data.Property.ReadOnlyException {
        if (newValue != null && !containsId(newValue)) {
            handleAddNewItem((String) newValue);
        }
        super.setValue(newValue);
    }

    @Override
    public void changeVariables(Object source, Map<String, Object> variables) {
        handleChangedFilterString((String) variables.get("filter"));
        super.changeVariables(source, variables);
    }

    private void handleChangedFilterString(String newFilterString) {
        if (newFilterString != null) {
            previousFilterString = caseSensitiveFilterstring;
            caseSensitiveFilterstring = newFilterString;

            if (!Strings.isNullOrEmpty(previousFilterString)) {
                if (newFilterString.length() > previousFilterString.length()) {
                    String newChars = newFilterString.substring(previousFilterString.length());
                    int spaceIdx = newChars.indexOf(' ');
                    if (previousFilterString.charAt(previousFilterString.length() - 1) != ' ' && spaceIdx >= 0) {
                        String expression = caseSensitiveFilterstring.substring(0,
                                previousFilterString.length() + spaceIdx);

                        search(expression, true);
                    }
                }
            }
        }
    }

    @Override
    protected Filter buildFilter(String filterString, FilteringMode filteringMode) {
        if (null != filterString && !"".equals(filterString)) {
            return new SimpleStringFilter(getItemCaptionPropertyId(), caseSensitiveFilterstring, false, true);
        }
        return null;
    }

    private void continueEditing() {
        focus();
    }

    private void handleAddNewItem(String newItemCaption) {
        container.addOption(newItemCaption);
        lastNewItem = newItemCaption;
        setValue(newItemCaption);
    }

    private void handleValueChange(com.vaadin.data.Property.ValueChangeEvent event) {

        String expression = (String) event.getProperty().getValue();
        if (expression == null) {
            expression = "";
        }
        continueEditing();

        boolean isItemFromOptions = !expression.equals(lastNewItem);
        search(expression, isItemFromOptions);
    }

    protected void search(String expression, boolean ignoreInvalidQuery) {
        if (!searchHandler.isValidQuery(expression)) {
            if (!ignoreInvalidQuery) {
                Notification.show(getMessage("portlet.crud.error.compoundsearch.invalidQuery", expression));
            }
        } else {
            searchHandler.search(expression);
        }
    }
}