sdmxdl.ResourceRef Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017 National Bank of Belgium
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved
 * by the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 *
 * http://ec.europa.eu/idabc/eupl
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 */
package sdmxdl;

import internal.sdmxdl.Chars;
import lombok.NonNull;
import nbbrd.design.SealedType;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Abstract identifier of a resource.
 *
 * @author Philippe Charles
 */
@SealedType({
        StructureRef.class,
        FlowRef.class,
        CodelistRef.class
})
public abstract class ResourceRef> {

    public static final String ALL_AGENCIES = "all";
    public static final String LATEST_VERSION = "latest";
    private static final char SEP = ',';

    @NonNull
    public abstract String getAgency();

    @NonNull
    public abstract String getId();

    @NonNull
    public abstract String getVersion();

    public boolean containsRef(@NonNull Resource that) {
        return contains(that.getRef());
    }

    public boolean contains(@NonNull T that) {
        return (this.getAgency().equals(ALL_AGENCIES) || this.getAgency().equals(that.getAgency()))
                && (this.getId().equals(that.getId()))
                && (this.getVersion().equals(LATEST_VERSION) || this.getVersion().equals(that.getVersion()));
    }

    public boolean equalsRef(@NonNull Resource that) {
        return equals(that.getRef());
    }

    @NonNull
    protected static String toString(ResourceRef ref) {
        return ref.getAgency() + SEP + ref.getId() + SEP + ref.getVersion();
    }

    @NonNull
    protected static > T create(@NonNull CharSequence input, @NonNull Factory factory) throws IllegalArgumentException {
        String[] items = Chars.splitToArray(input.toString(), SEP);
        switch (items.length) {
            case 3:
                return factory.create(Chars.emptyToDefault(items[0], ALL_AGENCIES), items[1], Chars.emptyToDefault(items[2], LATEST_VERSION));
            case 2:
                return factory.create(Chars.emptyToDefault(items[0], ALL_AGENCIES), items[1], LATEST_VERSION);
            case 1:
                return factory.create(ALL_AGENCIES, items[0], LATEST_VERSION);
            default:
                throw new IllegalArgumentException(input.toString());
        }
    }

    @NonNull
    protected static > T of(@Nullable String agencyId, @NonNull String id, @Nullable String version, @NonNull Factory factory) throws IllegalArgumentException {
        if (Chars.contains(id, SEP)) {
            throw new IllegalArgumentException(id);
        }
        return factory.create(Chars.nullOrEmptyToDefault(agencyId, ALL_AGENCIES), id, Chars.nullOrEmptyToDefault(version, LATEST_VERSION));
    }

    protected interface Factory> {

        @NonNull
        T create(@NonNull String agencyId, @NonNull String id, @NonNull String version);
    }
}