slightly more type-safe and extending friendly navigation
[svjatoslav_commons.git] / src / main / java / eu / svjatoslav / commons / network / navigation / NavigationItem.java
index d40ff57..76a7d07 100755 (executable)
@@ -1,3 +1,12 @@
+/*
+ * Svjatoslav Commons - shared library of common functionality.
+ * Copyright ©2012-2014, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of version 3 of the GNU Lesser General Public License
+ * or later as published by the Free Software Foundation.
+ */
+
 package eu.svjatoslav.commons.network.navigation;
 
 import java.util.ArrayList;
@@ -8,61 +17,77 @@ import java.util.Map;
 import eu.svjatoslav.commons.network.Locale;
 import eu.svjatoslav.commons.string.WildCardMatcher;
 
-public class NavigationItem {
+public class NavigationItem<NI extends NavigationItem, N extends Navigation> {
+
+       private String matchingPattern;
 
-       private String matchingWildcard;
        private final Map<Locale, String> localeToTitle = new HashMap<Locale, String>();
-       ArrayList<NavigationItem> subElements = new ArrayList<NavigationItem>();
-       private Locale[] localeOrder;
-       private NavigationItem parent;
+       private final ArrayList<NI> subElements = new ArrayList<NI>();
+       private final NI parent;
+       private final N navigation;
        private final String linkUrl;
-
-       public NavigationItem(final Locale... localeOrder) {
-               if (localeOrder.length == 0)
-                       this.localeOrder = new Locale[] { Locale.ENG };
-               else
-                       this.localeOrder = localeOrder;
-
-               matchingWildcard = null;
+       /**
+        * CSS prefix is inherited to child menu items.
+        */
+       private String cssPrefix;
+
+       public NavigationItem(final N navigation) {
+               this.navigation = navigation;
+               parent = null;
+               matchingPattern = null;
                linkUrl = null;
        }
 
-       public NavigationItem(final NavigationItem parent, final String linkUrl,
+       public NavigationItem(final NI parent, final String linkUrl,
                        final String... titles) {
+               this.navigation = (N) parent.getNavigation();
                this.parent = parent;
                this.linkUrl = linkUrl;
+               matchingPattern = linkUrl;
 
                initializeLocalizedTitles(titles);
+
+               parent.addNavigationItem(this);
+       }
+
+       public void addNavigationItem(final NI navigationItem) {
+               subElements.add(navigationItem);
        }
 
-       public NavigationItem addChild(final String linkUrl, final String... titles) {
+       protected String getCssPrefix() {
+               if (cssPrefix != null)
+                       return cssPrefix;
 
-               final NavigationItem item = new NavigationItem(this, linkUrl, titles);
-               subElements.add(item);
+               if (parent == null)
+                       return null;
 
-               return item;
+               return parent.getCssPrefix();
        }
 
        public String getLinkUrl() {
                return linkUrl;
        }
 
-       public Locale[] getLocaleOrder() {
-               if (localeOrder != null)
-                       return localeOrder;
+       NI getMatchingNavigationItem(final String requestPath) {
+               if (matchesUrl(requestPath))
+                       return (NI) this;
 
-               return parent.getLocaleOrder();
-       }
+               for (final NI childNavigationItem : subElements) {
+                       final NI match = (NI) childNavigationItem
+                                       .getMatchingNavigationItem(requestPath);
 
-       public List<NavigationItem> getSubElements() {
-               return subElements;
+                       if (match != null)
+                               return match;
+               }
+               return null;
        }
 
-       public String getTitle() {
-               if (localeToTitle.size() != 1)
-                       throw new RuntimeException("there shall be exactly one title");
+       public N getNavigation() {
+               return navigation;
+       }
 
-               return localeToTitle.values().iterator().next();
+       public List<NI> getSubElements() {
+               return subElements;
        }
 
        public String getTitle(final Locale locale) {
@@ -70,18 +95,35 @@ public class NavigationItem {
        }
 
        private void initializeLocalizedTitles(final String... titles) {
-               final Locale[] locales = getLocaleOrder();
-               if (locales.length != titles.length)
+               final List<Locale> locales = getNavigation().getLocaleConfiguration()
+                               .getAllowedLocales();
+               if (locales.size() != titles.length)
                        throw new RuntimeException("There should be exactly "
-                                       + locales.length + " title(s).");
+                                       + locales.size() + " title(s).");
 
                for (int i = 0; i < titles.length; i++)
-                       localeToTitle.put(locales[i], titles[i]);
+                       localeToTitle.put(locales.get(i), titles[i]);
        }
 
        public boolean matchesUrl(final String url) {
-               return WildCardMatcher.match(url, matchingWildcard);
+               return WildCardMatcher.match(url, matchingPattern);
+       }
+
+       public void setCssPrefix(final String cssPrefix) {
+               this.cssPrefix = cssPrefix;
+       }
+
+       public NavigationItem setPattern(final String pattern) {
+               matchingPattern = pattern;
+               return this;
+       }
 
+       @Override
+       public String toString() {
+               return "NavigationItem [matchingPattern=" + matchingPattern
+                               + ", localeToTitle=" + localeToTitle + ", subElements count="
+                               + subElements.size() + ", linkUrl=" + linkUrl + ", cssPrefix="
+                               + cssPrefix + "]";
        }
 
 }