All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.googlecode.jinahya.util.DependencyResolver Maven / Gradle / Ivy

/*
 * Copyright 2011 Jin Kwon.
 *
 * 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 com.googlecode.jinahya.util;


import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;


/**
 * Dependency resolving utility.
 *
 * @author Jin Kwon
 */
public class DependencyResolver implements Serializable {


    /**
     * Returns a synchronized instance.
     *
     * @param  type parameter
     * @return a synchronized instance
     */
    public static  DependencyResolver synchronizedInstance() {

        return new DependencyResolver() {


            @Override
            public synchronized void add(T source, T... targets)
                throws DependencyResolverException {

                super.add(source, targets);
            }


            @Override
            public synchronized void remove(T source, T... targets) {
                super.remove(source, targets);
            }


            @Override
            public synchronized boolean contains(T source, T target) {
                return super.contains(source, target);
            }


            @Override
            public synchronized boolean containsAll(T source, T... target) {
                return super.containsAll(source, target);
            }


            @Override
            public synchronized boolean containsAny(T source, T... targets) {
                return super.containsAny(source, targets);
            }


            @Override
            public synchronized List> getPaths(T source, T target) {
                return super.getPaths(source, target);
            }


            @Override
            public synchronized List getSingleGroup() {
                return super.getSingleGroup();
            }


            @Override
            public synchronized List> getHorizontalGroups() {
                return super.getHorizontalGroups();
            }


            @Override
            public synchronized List> getVerticalGroups() {
                return super.getVerticalGroups();
            }


            @Override
            public synchronized void clear() {
                super.clear();
            }
        };
    }


    /*
     * Adds direct dependencies from source to each of
     * targets.
     *
     * @param source source; may not be null
     * @param targets targets; may not be null; each element may be null
     * @throws DependencyResolverException if an error occurs
    public void addDependencies(final T source, final T... targets)
    throws DependencyResolverException {
    
    if (source == null) {
    throw new NullPointerException("null source");
    }
    
    if (targets == null) {
    throw new NullPointerException("null targets");
    }
    
    for (T target : targets) {
    addDependency(source, target);
    }
    }
     */
    /*
     * Adds a direct dependency from given source to specified
     * target.
     *
     * @param source source; may not be null
     * @param target target; may be null
     * @throws DependencyResolverException if failed to add dependency.
    public void addDependency(final T source, final T target)
    throws DependencyResolverException {
    
    if (source == null) {
    throw new NullPointerException("null source");
    }
    
    if (source.equals(target)) {
    throw new IllegalArgumentException(
    "source(" + source + ") is equals to target(" + target + ")");
    }
    
    if (target != null && hasDependency(target, source)) {
    throw new CyclicDependencyException(source, target);
    }
    
    List targets = map.get(source);
    
    if (targets == null) {
    targets = new ArrayList();
    map.put(source, targets);
    }
    
    if (targets.contains(target)) {
    return;
    }
    
    targets.add(target);
    }
     */
    /**
     * Adds dependencies from source to each of
     * targets.
     *
     * @param source source
     * @param targets targets
     * @throws DependencyResolverException if an error occurs.
     */
    public void add(final T source, final T... targets)
        throws DependencyResolverException {

        if (source == null) {
            throw new NullPointerException("null source");
        }

        if (targets == null) {
            throw new NullPointerException("null targets");
        }

        List list = map.get(source);

        for (T target : targets) {

            if (source.equals(target)) {
                throw new DependencyResolverException("self dependency");
            }

            if (target != null && contains(target, source)) {
                throw new CyclicDependencyException(source, target);
            }

            if (list == null) {
                list = new ArrayList();
                map.put(source, list);
            }

            if (!list.contains(target)) {
                list.add(target);
            }
        }
    }


    /*
     * Removes direct dependencies from specified source to each of
     * specified targets.
     *
     * @param source source; may not be null
     * @param targets targets; may not be null; each element may be null
    public void removeDependencies(final T source, final T... targets) {
    
    if (source == null) {
    throw new NullPointerException("null source");
    }
    
    if (targets == null) {
    throw new NullPointerException("null targets");
    }
    
    for (T target : targets) {
    removeDependency(source, target);
    }
    }
     */
    /**
     * Removes direct dependencies from source to each of
     * targets.
     *
     * @param source source
     * @param targets targets
     */
    public void remove(final T source, final T... targets) {

        if (source == null) {
            throw new NullPointerException("null source");
        }

        if (targets == null) {
            throw new NullPointerException("null targets");
        }

        final List list = map.get(source);

        if (list == null) {
            return;
        }

        for (T target : targets) {
            if (list.remove(target) && list.isEmpty()) {
                map.remove(source);
                return;
            }
        }
    }


    /*
     * Remove a direct dependency from given source to specified
     * target.
     *
     * @param source source; may not be null
     * @param target target; may be null
    public void removeDependency(final T source, final T target) {
    
    if (source == null) {
    throw new NullPointerException("null source");
    }
    
    final List targets = map.get(source);
    
    if (targets == null) {
    return;
    }
    
    if (targets.remove(target) && targets.isEmpty()) {
    map.remove(source);
    }
    }
     */
    /**
     * Check if all of specified targets has a direct or indirect
     * dependency from given source.
     *
     * @param source source
     * @param targets targets
     * @return true if source has dependencies to all of
     *         targets; false if there is no dependency from
     *         source to any of targets.
     */
    public boolean containsAll(final T source, final T... targets) {

        if (source == null) {
            throw new NullPointerException("null source");
        }

        if (targets == null) {
            throw new NullPointerException("null targets");
        }

        for (T target : targets) {
            if (!contains(source, target)) {
                return false;
            }
        }

        return true;
    }


    /**
     * Checks if there is any direct or indirect dependency from
     * source to any of targets.
     *
     * @param source source
     * @param targets targets
     * @return true if there is a dependency; false if there is none.
     */
    public boolean containsAny(final T source, final T... targets) {

        if (source == null) {
            throw new NullPointerException("null source");
        }

        if (targets == null) {
            throw new NullPointerException("null targets");
        }

        for (T target : targets) {
            if (contains(source, target)) {
                return true;
            }
        }

        return false;
    }


    /**
     * Checks if there is a dependency from source to
     * target.
     *
     * @param source source
     * @param target target
     * @return true if there is a direct or indirect dependency from
     *         source to target; false if there is
     *         none.
     */
    public boolean contains(final T source, final T target) {

        if (source == null) {
            throw new NullPointerException("null source");
        }

        final List list = map.get(source);

        if (list == null) {
            return false;
        }

        if (list.contains(target)) {
            return true;
        }

        for (T auxiliary : list) {
            if (auxiliary == null) {
                continue;
            }
            if (contains(auxiliary, target)) {
                return true;
            }
        }

        return false;
    }


    /*
     * Checks if given source has direct or indirect dependencies
     * to all of targets.
     *
     * @param source source; may not be null
     * @param targets targets; may not be null; each element may be null
     * @return true if all targets are dependent from source; false otherwise
    public boolean hasDependencies(final T source, final T... targets) {
    
    if (source == null) {
    throw new NullPointerException("null source");
    }
    
    if (targets == null) {
    throw new NullPointerException("null targets");
    }
    
    for (T target : targets) {
    if (!hasDependency(source, target)) {
    return false;
    }
    }
    
    return true;
    }
     */
    /*
     * Checks if there is any direct or indirect dependency from
     * source to target.
     *
     * @param source source; may not be null
     * @param target target; may be null
     * @return true if there is a dependency; false otherwise
    public boolean hasDependency(final T source, final T target) {
    
    if (source == null) {
    throw new NullPointerException("null source");
    }
    
    final List list = map.get(source);
    
    if (list == null) {
    return false;
    }
    
    if (list.contains(target)) {
    return true;
    }
    
    for (T auxiliary : list) {
    if (auxiliary == null) {
    continue;
    }
    if (hasDependency(auxiliary, target)) {
    return true;
    }
    }
    
    return false;
    }
     */
    /**
     * Finds all direct or indirect paths from given source to
     * specified target.
     *
     * @param source source
     * @param target target
     * @return paths from source to target.
     */
    public List> getPaths(final T source, final T target) {

        if (source == null) {
            throw new NullPointerException("null source");
        }

        if (source.equals(target)) {
            throw new IllegalArgumentException(
                "source(" + source + ") is equals to target(" + target + ")");
        }

        final List> paths = new ArrayList>();

        final List targets = map.get(source);

        if (targets == null) {
            return paths;
        }

        for (T auxiliary : targets) {

            if ((auxiliary == null && target == null)
                || auxiliary.equals(target)) {

                final List path = new LinkedList();
                path.add(source);
                path.add(auxiliary);
                paths.add(path);
                continue;
            }

            if (auxiliary == null) {
                continue;
            }

            for (List path : getPaths(auxiliary, target)) {
                path.add(0, source);
                paths.add(path);
            }
        }

        return paths;
    }


    /*
     * Finds all direct or indirect dependency paths from given
     * source to specified target.
     *
     * @param source source
     * @param target target
     * @return dependency paths from source to target.
    public List> getDependencyPaths(final T source, final T target) {
    
    if (source == null) {
    throw new NullPointerException("null source");
    }
    
    if (source.equals(target)) {
    throw new IllegalArgumentException(
    "source(" + source + ") is equals to target(" + target + ")");
    }
    
    final List> paths = new ArrayList>();
    
    final List targets = map.get(source);
    
    if (targets == null) {
    return paths;
    }
    
    for (T auxiliary : targets) {
    
    if ((auxiliary == null && target == null)
    || auxiliary.equals(target)) {
    
    final List path = new LinkedList();
    path.add(source);
    path.add(auxiliary);
    paths.add(path);
    continue;
    }
    
    if (auxiliary == null) {
    continue;
    }
    
    for (List path : getDependencyPaths(auxiliary, target)) {
    path.add(0, source);
    paths.add(path);
    }
    }
    
    return paths;
    }
     */
    /**
     * Returns a single group of all dependencies in order.
     *
     * @return a single dependency group
     */
    public List getSingleGroup() {

        final List group = new LinkedList();

        for (T source : map.keySet()) {
            getSingleGroup(source, group);
        }

        return group;
    }


    /**
     * Returns a list of horizontal dependency groups. Each group can be
     * processed concurrently but all elements in a group must be processed in
     * order.
     *
     * @return horizontal groups
     */
    private void getSingleGroup(final T source, final List group) {

        if (source == null) {
            throw new NullPointerException("null source");
        }

        if (group == null) {
            throw new NullPointerException("null group");
        }

        if (group.contains(source)) {
            return;
        }

        final List targets = map.get(source);
        if (targets != null) {
            for (T target : targets) {
                if (target == null) {
                    continue;
                }
                getSingleGroup(target, group);
            }
        }

        group.add(source);
    }


    /**
     * Returns a list of vertical dependency groups. Each group can be processed
     * concurrently but all elements in a group must be processed in order.
     *
     * @return vertical groups
     */
    public List> getHorizontalGroups() {

        final List> groups = new ArrayList>();

        final List single = getSingleGroup();

        while (!single.isEmpty()) {

            final List group = new ArrayList();
            groups.add(group);

            group.add(single.remove(0));

            outer:
            for (int i = 0; i < single.size();) {
                for (T g : group) {
                    if (contains(single.get(i), g)) {
                        group.add(single.remove(i));
                        continue outer;
                    }
                }
                for (int j = i + 1; j < single.size(); j++) {
                    if (!contains(single.get(j), single.get(i))) {
                        continue;
                    }
                    for (T g : group) {
                        if (contains(single.get(j), g)) {
                            group.add(single.remove(i));
                            continue outer;
                        }
                    }
                }
                i++;
            }
        }

        if (!single.isEmpty()) {
            groups.add(single);
        }

        return groups;
    }


    /**
     * Returns a list of vertical dependency groups. Each element in a group can
     * be processed concurrently but all groups must be processed in order.
     *
     * @return vertical groups
     */
    public List> getVerticalGroups() {

        final List> groups = new ArrayList>();

        final List single = getSingleGroup();

        while (!single.isEmpty()) {

            final List group = new ArrayList();
            groups.add(group);

            outer:
            for (int i = single.size() - 1; i >= 0; i--) {
                for (int j = 0; j < i; j++) {
                    if (contains(single.get(i), single.get(j))) {
                        continue outer;
                    }
                }
                group.add(single.remove(i));
            }
        }

        if (!single.isEmpty()) {
            groups.add(single);
        }

        return groups;
    }


    /**
     * Removes all dependencies from this resolver.
     */
    public void clear() {
        map.clear();
    }


    /** map. */
    private final Map> map = new HashMap>();
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy