org.entur.netex.support.NetexVersionHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of netex-parser-java Show documentation

Library for parsing NeTEx files and looking up entities in an index.

There is a newer version: 3.1.29

package org.entur.netex.support;

import org.rutebanken.netex.model.EntityInVersionStructure;

import java.util.Collection;
import java.util.Comparator;

import static java.util.Comparator.comparingInt;

/**
 * Utility class to help working with versioned NeTEx element.
 * 
 * This class implements Norwegian profile specific rules.
 */
public class NetexVersionHelper {

    /**
     * private constructor to prevent instantiation of utility class
     */
    private NetexVersionHelper() { }

    /**
     * According to the Norwegian Netex profile the version number must be a
     * positive increasing integer. A bigger value indicate a later version.
     */
    private static int versionOf(EntityInVersionStructure e) {
        return Integer.parseInt(e.getVersion());
    }

    /**
     * Return the element with the latest (maximum) version for a given {@code list} of elements.
     * If no elements exist in the collection {@code null} is returned.
     */
    public static  T latestVersionedElementIn(Collection list) {
        if (list.size() == 1) {
            return list.iterator().next();
        }
        return list.stream().max(comparingVersion()).orElse(null);
    }

    public static  T versionOfElementIn(Collection list, String version) {
        return list.stream().filter(e -> e.getVersion().equals(version)).findFirst().orElse(null);
    }

    /**
     * Return a comparator to compare {@link EntityInVersionStructure} elements by version.
     */
    private static  Comparator comparingVersion() {
        return comparingInt(NetexVersionHelper::versionOf);
    }
}