jdplus.tramoseats.base.information.TramoSeatsSpecMapping Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdplus-tramoseats-base-information Show documentation
${project.parent.artifactId} - ${project.artifactId}
There is a newer version: 3.2.4
Show newest version
/*
 * Copyright 2020 National Bank of Belgium
 *
 * Licensed under the EUPL, Version 1.2 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:
 *
 * https://joinup.ec.europa.eu/software/page/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 jdplus.tramoseats.base.information;

import jdplus.toolkit.base.api.DemetraVersion;
import jdplus.toolkit.base.api.information.InformationSet;
import jdplus.toolkit.base.api.information.InformationSetSerializerEx;
import jdplus.toolkit.base.api.processing.AlgorithmDescriptor;
import jdplus.toolkit.base.api.processing.ProcSpecification;
import jdplus.sa.base.api.SaSpecification;
import jdplus.sa.base.information.SaBenchmarkingSpecMapping;
import jdplus.sa.base.information.SaSpecificationMapping;
import jdplus.toolkit.base.api.timeseries.TsDomain;
import jdplus.tramoseats.base.api.tramoseats.TramoSeatsSpec;
import nbbrd.service.ServiceProvider;

/**
 *
 * @author PALATEJ
 */
@lombok.experimental.UtilityClass
public class TramoSeatsSpecMapping {

    public static final InformationSetSerializerEx SERIALIZER_V3 = new InformationSetSerializerEx() {
        @Override
        public InformationSet write(TramoSeatsSpec object, TsDomain context, boolean verbose) {
            return TramoSeatsSpecMapping.write(object, context, verbose);
        }

        @Override
        public TramoSeatsSpec read(InformationSet info, TsDomain context) {
            return TramoSeatsSpecMapping.read(info, context);
        }
        
        @Override
        public boolean match(DemetraVersion version){
            return version == DemetraVersion.JD3;
        }
    };

    public static final InformationSetSerializerEx SERIALIZER_LEGACY = new InformationSetSerializerEx() {
        @Override
        public InformationSet write(TramoSeatsSpec object, TsDomain context, boolean verbose) {
            return TramoSeatsSpecMapping.writeLegacy(object, context, verbose);
        }

        @Override
        public TramoSeatsSpec read(InformationSet info, TsDomain context) {
            return TramoSeatsSpecMapping.readLegacy(info, context);
        }

        @Override
        public boolean match(DemetraVersion version){
            return version == DemetraVersion.JD2;
        }
    };

    public static final String TRAMO = "tramo", SEATS = "seats", BENCH = "benchmarking", RSA = "method";

    public InformationSet write(TramoSeatsSpec spec, TsDomain context, boolean verbose, DemetraVersion version) {
        return switch (version) {
            case JD2 -> writeLegacy(spec, context, verbose);
            default -> write(spec, context, verbose);
        };
        }

    public InformationSet write(TramoSeatsSpec spec, TsDomain context, boolean verbose) {
        InformationSet specInfo = new InformationSet();
        specInfo.add(ProcSpecification.ALGORITHM, TramoSeatsSpec.DESCRIPTOR_V3);
        InformationSet tinfo = TramoSpecMapping.write(spec.getTramo(), context, verbose);
        if (tinfo != null) {
            specInfo.add(TRAMO, tinfo);
        }
        InformationSet sinfo = DecompositionSpecMapping.write(spec.getSeats(), verbose);
        if (sinfo != null) {
            specInfo.add(SEATS, sinfo);
        }
        InformationSet binfo = SaBenchmarkingSpecMapping.write(spec.getBenchmarking(), verbose);
        if (binfo != null) {
            specInfo.add(BENCH, binfo);
        }
        return specInfo;
    }

    public InformationSet writeLegacy(TramoSeatsSpec spec, TsDomain context, boolean verbose) {
        InformationSet specInfo = new InformationSet();
        specInfo.add(ProcSpecification.ALGORITHM, TramoSeatsSpec.DESCRIPTOR_LEGACY);
        InformationSet tinfo = TramoSpecMapping.writeLegacy(spec.getTramo(), context, verbose);
        if (tinfo != null) {
            specInfo.add(TRAMO, tinfo);
        }
        InformationSet sinfo = DecompositionSpecMapping.write(spec.getSeats(), verbose);
        if (sinfo != null) {
            specInfo.add(SEATS, sinfo);
        }
        InformationSet binfo = SaBenchmarkingSpecMapping.write(spec.getBenchmarking(), verbose);
        if (binfo != null) {
            specInfo.add(BENCH, binfo);
        }
        return specInfo;
    }

    public TramoSeatsSpec read(InformationSet info, TsDomain context) {
        if (info == null) {
            return null;
        }
        AlgorithmDescriptor desc = info.get(ProcSpecification.ALGORITHM, AlgorithmDescriptor.class);
        if (desc == null) {
            return null;
        }
        if (desc.equals(TramoSeatsSpec.DESCRIPTOR_LEGACY)) {
            return readLegacy(info, context);
        } else if (desc.equals(TramoSeatsSpec.DESCRIPTOR_V3)) {
            return readV3(info, context);
        } else {
            return null;
        }
    }

    public TramoSeatsSpec readV3(InformationSet info, TsDomain context) {
        if (info == null) {
            return TramoSeatsSpec.DEFAULT;
        }
        return TramoSeatsSpec.builder()
                .tramo(TramoSpecMapping.readV3(info.getSubSet(TRAMO), context))
                .seats(DecompositionSpecMapping.read(info.getSubSet(SEATS)))
                .benchmarking(SaBenchmarkingSpecMapping.read(info.getSubSet(BENCH)))
                .build();
    }

    public TramoSeatsSpec readLegacy(InformationSet info, TsDomain context) {
        if (info == null) {
            return TramoSeatsSpec.DEFAULT;
        }
        return TramoSeatsSpec.builder()
                .tramo(TramoSpecMapping.readLegacy(info.getSubSet(TRAMO), context))
                .seats(DecompositionSpecMapping.read(info.getSubSet(SEATS)))
                .benchmarking(SaBenchmarkingSpecMapping.read(info.getSubSet(BENCH)))
                .build();
    }

    @ServiceProvider(SaSpecificationMapping.class)
    public static class Serializer implements SaSpecificationMapping {

        @Override
        public SaSpecification read(InformationSet info, TsDomain context) {
            return TramoSeatsSpecMapping.read(info, context);
        }

        @Override
        public InformationSet write(SaSpecification spec, TsDomain context, boolean verbose, DemetraVersion version) {
            if (spec instanceof TramoSeatsSpec tramoSeatsSpec) {
                return TramoSeatsSpecMapping.write(tramoSeatsSpec, context, verbose, version);
            } else {
                return null;
            }
        }

    }

}