ru.crazycoder.plugins.tabdir.TitleFormatter.java Source code

Introduction

Here is the source code for ru.crazycoder.plugins.tabdir.TitleFormatter.java

Source

/*
 * Copyright 2012 Vladimir Rudev
 *
 * 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 ru.crazycoder.plugins.tabdir;

import ru.crazycoder.plugins.tabdir.configuration.FolderConfiguration;

import java.text.MessageFormat;
import java.util.*;

import static org.apache.commons.lang.StringUtils.*;

/**
 * User: crazycoder
 * Date: Aug 21, 2010
 * Time: 9:28:09 AM
 */
public class TitleFormatter {

    private static final int MIN_DUPLICATE_LENGTH = 3;

    public static String format(LinkedHashMap<String, Set<String>> prefixes, String tabName,
            FolderConfiguration configuration) {
        String joinedPrefixes = joinPrefixesWithRemoveDuplication(prefixes, configuration);
        return MessageFormat.format(configuration.getTitleFormat(), joinedPrefixes, tabName);
    }

    private static String joinPrefixesWithRemoveDuplication(LinkedHashMap<String, Set<String>> prefixes,
            FolderConfiguration configuration) {
        List<String> keys = new LinkedList<String>(prefixes.keySet());
        keys = getPrefixesSublist(keys, configuration);
        List<String> resultPrefixes = new ArrayList<String>(keys.size());
        for (String key : keys) {
            resultPrefixes.add(removeDuplicates(key, prefixes.get(key)));
        }
        StringBuilder buffer = join(resultPrefixes, configuration);
        return removeEnd(buffer.toString(), configuration.getDirSeparator());
    }

    /**
     * <ol>
     * <li>
     * Finds greatest common prefix of key and all neighbours,
     * this prefix replaced by first char and {@link FolderConfiguration#DUPLICATES_DELIMITER}.
     * </li>
     * <li>
     * Remove all neighbours that differs from key after removed common prefix.
     * </li>
     * <li>Doing 1, 2 until have neighbours and common prefixes.</li>
     * </ol>
     * See tests for examples.
     *
     * @param key        main folder name
     * @param neighbours folders with similar files in same level as key
     * @return key, with removed duplicates
     * @see ru.crazycoder.plugins.tabdir.SameFilenameTitleProviderTest#testRemoveMultiDuplicates()
     */
    private static String removeDuplicates(final String key, Set<String> neighbours) {
        String result = "";
        neighbours.remove(null);
        List<String> list = new ArrayList<String>(neighbours);

        // this neighbours unnecessary
        Iterator<String> iterator = list.iterator();
        while (iterator.hasNext()) {
            String string = iterator.next();
            if (getCommonPrefix(new String[] { string, key }).length() <= MIN_DUPLICATE_LENGTH) {
                iterator.remove();
            }
        }

        list.add(key);
        String commonPrefix = getCommonPrefix(list.toArray(new String[list.size()]));
        String suffix = key;
        while (!isBlank(commonPrefix)) {
            int prefixLength = commonPrefix.length();
            if (prefixLength == suffix.length()) {
                return result + suffix;
            }
            result += commonPrefix.substring(0, 1) + FolderConfiguration.DUPLICATES_DELIMITER;

            suffix = suffix.substring(prefixLength);
            List<String> newList = new ArrayList<String>();
            for (String s : list) {
                String substring = s.substring(prefixLength);
                boolean notBlank = isNotBlank(substring)
                        && getCommonPrefix(new String[] { substring, suffix }).length() > MIN_DUPLICATE_LENGTH;
                if (notBlank) {
                    newList.add(substring);
                }
            }
            list = newList;
            commonPrefix = getCommonPrefix(list.toArray(new String[list.size()]));
        }
        return result + suffix;
    }

    //-----simple format

    public static String format(List<String> prefixes, String tabName, FolderConfiguration configuration) {
        String joinedPrefixes = joinPrefixes(prefixes, configuration);
        return MessageFormat.format(configuration.getTitleFormat(), joinedPrefixes, tabName);
    }

    private static String joinPrefixes(List<String> prefixes, FolderConfiguration configuration) {
        prefixes = getPrefixesSublist(prefixes, configuration);
        StringBuilder buffer = join(prefixes, configuration);
        return removeEnd(buffer.toString(), configuration.getDirSeparator());
    }

    private static List<String> getPrefixesSublist(List<String> prefixes, FolderConfiguration configuration) {
        int maxDirsToShow = configuration.getMaxDirsToShow();
        if (maxDirsToShow > 0 && maxDirsToShow < prefixes.size()) {
            int beginIndex = prefixes.size() - maxDirsToShow;
            int endIndex = prefixes.size();
            if (configuration.isCountMaxDirsFromStart()) {
                beginIndex = 0;
                endIndex = maxDirsToShow;
            }
            return prefixes.subList(beginIndex, endIndex);
        }
        return prefixes;
    }

    private static StringBuilder join(List<String> prefixes, FolderConfiguration configuration) {
        StringBuilder buffer = new StringBuilder();
        for (String prefix : prefixes) {
            if (configuration.isReduceDirNames()) {
                String reducedDir;
                if (configuration.isReduceDirNames() && prefix.contains(FolderConfiguration.DUPLICATES_DELIMITER)) {
                    int start = prefix.lastIndexOf(FolderConfiguration.DUPLICATES_DELIMITER);
                    reducedDir = substring(prefix, 0, start + configuration.getCharsInName() + 1);
                } else {
                    reducedDir = substring(prefix, 0, configuration.getCharsInName());
                }
                buffer.append(reducedDir);
            } else {
                buffer.append(prefix);
            }
            buffer.append(configuration.getDirSeparator());
        }
        return buffer;
    }

    public static String example(FolderConfiguration configuration) {
        List<String> examplePrefixes = Arrays.asList("first", "second", "third", "fourth", "fifth", "sixs");
        String exampleFileName = "FileName";
        return format(examplePrefixes, exampleFileName, configuration);
    }
}