NavigationHelper.java

/* Copyright (2007-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/>.
 *
 * NavigationHelper.java
 *
 * Created on 12/06/2007, 17:13:43
 *
 */

package no.sesat.search.view.navigation;

import no.sesat.search.datamodel.DataModel;
import no.sesat.search.result.BasicNavigationItem;
import no.sesat.search.result.NavigationItem;

/**
 * All public methods require take a datamodel argument. This datamodel must in VIEW_CONSTRUCTION state.
 * It essentially means that this helper class can only be used from jsp/velocity code.
 *
 *
 *
 * @version $Id$
 *
 */
public final class NavigationHelper {

    // Constants -----------------------------------------------------

    // Static --------------------------------------------------------

    public static String removeQuery(final String url) {
        return url.replaceAll("(&)?q=[^&]*", "");
    }

    /** Drill down the navigation hierarchy and find the first Nav that hasn't yet been selected.
     * Any Nav that has autoNavigation and has only one child will be automatically selected,
     *      (as along as the child has a corresponding NavigationItem).
     * @param dm the datamodel
     * @param nav the current nav
     * @return the first non-selected nav inside the current nav given
     */
    public static NavigationConfig.Nav getFirstNotSelected(DataModel dm, NavigationConfig.Nav nav) {

        NavigationConfig.Nav result = null;

        if (dm.getParameters().getValue(nav.getId()) != null
                && !nav.getChildNavs().isEmpty()
                && !nav.getChildNavs().get(0).isVirtual()) {

            result = getFirstNotSelected(dm, nav.getChildNavs().get(0));

        } else {

            final int navResultSize = null != nav.getId()
                    && null != dm.getNavigation().getNavigation(nav.getId())
                    && null != dm.getNavigation().getNavigation(nav.getId()).getResults()
                    ? dm.getNavigation().getNavigation(nav.getId()).getResults().size()
                    : 0;

            if(1 == navResultSize && !nav.getChildNavs().isEmpty() && nav.isAutoNavigation()){

// TODO: Specification is a mess, so this becomes ugly. See history in prio-198 & SEARCH-3320.
// TODO: Haven't found a general way to solve this. Special case for Oslo.
// TODO: New JIRA created to resolve this: SEARCH-3451
//            return 1 == navResultSize && !nav.getChildNavs().isEmpty()
//                    ? getFirstNotSelected(dm, nav.getChildNavs().get(0))
//                    : nav;


                // don't go automatically selecting any navigator we haven't built a NavigationItem for
                final NavigationItem childNavItem = dm.getNavigation().getNavigation(nav.getChildNavs().get(0).getId());
                if(null != childNavItem && 0 < childNavItem.getResults().size()){

                    result = getFirstNotSelected(dm, nav.getChildNavs().get(0));
                }
            }
        }
        return null != result ? result : nav;
    }

    public static NavigationItem getSingleNavigationItem(DataModel dm, final String navId, final String value) {
        final NavigationItem item = dm.getNavigation().getNavigation(navId);

        if (item != null && item.getChildByTitle(value) != null) {

            return item.getChildByTitle(value);
        } else {
            final BasicNavigationItem navigationItem = new BasicNavigationItem();

            navigationItem.setHitCount(0);
            navigationItem.setTitle(value);

            return navigationItem;
        }
    }

    public static String getResetUrl(final DataModel dm, final String navId) {
        return dm.getNavigation().getNavigation("reset_" + navId).getUrl();
    }

    // Constructors --------------------------------------------------

    /** Velocity templates need an instance to put into the context just to call the static methods. **/
    public NavigationHelper(){}

    // Private -------------------------------------------------------

}