net.sf.saxon.trans.PackageLibrary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation
The XSLT and XQuery Processor
There is a newer version: 12.5
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2015 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

package net.sf.saxon.trans;


import net.sf.saxon.style.PackageVersion;
import net.sf.saxon.style.PackageVersionRanges;
import net.sf.saxon.style.StylesheetPackage;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class PackageLibrary {

    Map> packageMap = new HashMap>();

    /**
     * Add a package to the current library
     * 
     * 
Packages which have the same name and version to one already within the library are considered
     * to be duplicates and are not added.
     *
     * @param packageIn The stylesheet package to be added
     */
    public void addPackage(StylesheetPackage packageIn) {
        addPackage(packageIn.getPackageName(), packageIn);
    }

    /**
     * Add a package to the current library with the given name
     * 
     * 
Packages which have the same name and version to one already within the library are considered
     * to be duplicates and are not added.
     *
     * @param name      The name to use for this package
     * @param packageIn The stylesheet package to be added
     */
    public void addPackage(String name, StylesheetPackage packageIn) {
        List list = packageMap.get(name);
        if (list == null) {
            list = new ArrayList();
            list.add(packageIn);
            packageMap.put(name, list);
        } else {
            for (StylesheetPackage p : list) {
                if (p.getPackageVersion().equals(packageIn.getPackageVersion())) {
                    list.remove(p);
                    list.add(packageIn);
                    return;
                }
            }
            list.add(packageIn);

        }
    }

    /**
     * Return a package from the library that has the given name and whose version lies in the given ranges.
     * This default is the first version found.
     *
     * @param name   The name of the package
     * @param ranges The ranges of versions of that package that are acceptable
     * @return The latest package that meets the criteria, or null if none can be found
     */
    public StylesheetPackage getPackage(String name, PackageVersionRanges ranges) {
        return getPackage(name, ranges, true);
    }

    /**
     * Return the first or latest package from the library that has the given name
     * and whose version lies in the given ranges
     *
     * @param name   The name of the package
     * @param ranges The ranges of versions of that package that are acceptable
     * @param first  Whether to return the first (true) or the latest version (false)
     * @return The first or latest package that meets the criteria, or null if none can be found
     */
    public StylesheetPackage getPackage(String name, PackageVersionRanges ranges, boolean first) {
        PackageVersion latestVersion = null;
        StylesheetPackage latestPackage = null;
        List list = packageMap.get(name);
        if (list == null) {
            return null;
        }
        for (StylesheetPackage p : list) {
            PackageVersion pv = p.getPackageVersion();
            if (ranges.contains(pv)) {
                if (first) {
                    return p;
                }
                if (latestVersion == null || latestVersion.compareTo(pv) == -1) {
                    latestVersion = pv;
                    latestPackage = p;
                }
            }
        }
        return latestPackage;
    }

    /**
     * Return the latest version of a package of the given name from the library.
     * 
     * 
The definition of 'latest' is determined by partial ordering of the {@link PackageVersion} class
     *
     * @param name The name of the package to be returned
     * @return The version of the named package whose version orders highest, or null if no such package exists
     */
    public StylesheetPackage getPackage(String name) {
        PackageVersion latestVersion = null;
        StylesheetPackage latestPackage = null;
        List list = packageMap.get(name);
        if (list == null) {
            return null;
        }
        for (StylesheetPackage p : list) {
            if (latestVersion == null || latestVersion.compareTo(p.getPackageVersion()) == -1) {
                latestVersion = p.getPackageVersion();
                latestPackage = p;
            }
        }
        return latestPackage;
    }

    public int size(String name) {
        return packageMap.get(name).size();
    }

    /**
     * Supply all the packages that currently exist in this library
     *
     * @return every package indexed
     */
    public List getPackages() {
        List result = new ArrayList();
        for (String n : packageMap.keySet()) {
            result.addAll(packageMap.get(n));
        }
        return result;
    }

    public PackageLibrary copy() {
        PackageLibrary p = new PackageLibrary();
        p.packageMap.putAll(packageMap);
        return p;
    }
}