OptionsNavigationConfig.java

/* Copyright (2005-2012) Schibsted ASA
 * This file is part of Possom.
 *
 *   Possom is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   Possom is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with Possom.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Jul 25, 2007 11:03:04 AM
 */
package no.sesat.search.view.navigation;

import static no.sesat.search.site.config.AbstractDocumentFactory.fillBeanProperty;
import static no.sesat.search.site.config.AbstractDocumentFactory.ParseType;
import no.sesat.search.view.navigation.NavigationConfig.Nav.ControllerFactory;

import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathFactory;
import javax.xml.xpath.XPathExpressionException;
import javax.xml.xpath.XPathConstants;
import java.util.List;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Collection;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import no.sesat.search.view.config.SearchTab;

/**
 *
 *
 *
 */
@ControllerFactory("no.sesat.search.view.navigation.OptionNavigationController")
public final class OptionsNavigationConfig extends NavigationConfig.Nav {

    private final List<Option> optionsToKeep = new ArrayList<Option>();
    private final List<Option> optionsToDelete = new ArrayList<Option>();
    private final List<Option> optionsToAdd = new ArrayList<Option>();

    private enum Operation {
        ADD,
        KEEP,
        DELETE
    }

    public OptionsNavigationConfig(
            final NavigationConfig.Nav parent,
            final NavigationConfig.Navigation navigation,
            final Element element)
    {
        super(parent, navigation, element);
        try {
            final XPath xPath = XPathFactory.newInstance().newXPath();
            final NodeList optionNodes = (NodeList) xPath.evaluate("config/*", element, XPathConstants.NODESET);
            processOptions(optionNodes);
        } catch (XPathExpressionException e) {
            throw new RuntimeException(e);
        }
    }

    public boolean isVirtual() {
        return true;
    }

    private void processOptions(NodeList optionNodes) {
        for (int i = 0; i < optionNodes.getLength(); i++) {
            final Element optionElement = (Element) optionNodes.item(i);

            final Option option = new Option(optionElement);
            final Operation operation = Enum.valueOf(Operation.class, optionElement.getNodeName().toUpperCase());

            switch (operation) {
                case ADD:
                    optionsToAdd.add(option);
                    break;
                case KEEP:
                    optionsToKeep.add(option);
                    break;
                case DELETE:
                    optionsToDelete.add(option);
                    break;
                default:
                    break;
            }
        }
    }

    public Collection<Option> getOptionsToKeep() {
        return Collections.unmodifiableCollection(optionsToKeep);
    }

    public Collection<Option> getOptionsToDelete() {
        return Collections.unmodifiableCollection(optionsToDelete);
    }

    public Collection<Option> getOptionsToAdd() {
        return Collections.unmodifiableCollection(optionsToAdd);
    }

    public class Option implements Serializable {

        private String value;
        private String displayName;
        private String valueRef;
        private boolean defaultSelect;
        private String defaultSelectValueRef;
        private String tab;
        private boolean useHitCount;
        private String commandName;
        // just like NavigationConfig.Navigation.Nav we'll handle tab via staticParameters
        private Map<String,String> staticParameters = new HashMap<String,String>();

        public Option(final Element e) {
            fillBeanProperty(this, null, "value", ParseType.String, e, null);
            fillBeanProperty(this, null, "valueRef", ParseType.String, e, null);
            fillBeanProperty(this, null, "defaultSelect", ParseType.Boolean, e, "false");
            fillBeanProperty(this, null, "defaultSelectValueRef", ParseType.String, e, null);
            fillBeanProperty(this, null, "useHitCount", ParseType.Boolean, e, "false");
            fillBeanProperty(this, getParent(), "commandName", ParseType.String, e, null);
            fillBeanProperty(this, null, "tab", ParseType.String, e, getParent().getTab());
            fillBeanProperty(this, null, "displayName", ParseType.String, e, getValue());
        }

        public String getValue() {
            return value;
        }

        public void setValue(String value) {
            this.value = value;
        }

        public String getDisplayName() {
            return displayName;
        }

        public void setDisplayName(String displayName) {
            this.displayName = displayName;
        }

        public String getValueRef() {
            return valueRef;
        }

        public void setValueRef(final String valueRef) {
            this.valueRef = valueRef;
        }

        public boolean isDefaultSelect() {
            return defaultSelect;
        }

        public void setDefaultSelect(final boolean defaultSelect) {
            this.defaultSelect = defaultSelect;
        }

        public String getDefaultSelectValueRef() {
            return defaultSelectValueRef;
        }

        public void setDefaultSelectValueRef(final String defaultSelectValueRef) {
            this.defaultSelectValueRef = defaultSelectValueRef;
        }

        public String getTab() {
            return tab;
        }

        public void setTab(final String tab) {
            this.tab = tab;
            // The tab property takes preference over any url parameters. intialse it here and use against urlGenerator.
            staticParameters.put(SearchTab.PARAMETER_KEY, tab);
        }

        public boolean isUseHitCount() {
            return useHitCount;
        }

        public void setUseHitCount(final boolean useHitCount) {
            this.useHitCount = useHitCount;
        }

        public String getCommandName() {
            return commandName;
        }

        public void setCommandName(final String commandName) {
            this.commandName = commandName;
        }

        public Map<String, String> getStaticParameters() {
            return Collections.unmodifiableMap(staticParameters);
        }

        @Override
        public String toString() {
            return "\nOption{" +
                    "value='" + value + '\'' +
                    ",displayName='" + displayName + '\'' +
                    ", valueRef='" + valueRef + '\'' +
                    ", defaultSelect=" + defaultSelect +
                    ", defaultSelectValueRef='" + defaultSelectValueRef + '\'' +
                    ", tab='" + tab + '\'' +
                    ", useHitCount=" + useHitCount +
                    ", commandName='" + commandName + '\'' +
                    '}';
        }

    }

}