jdplus.toolkit.desktop.plugin.ui.properties.l2fprod.OutlierDescriptor Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 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 jdplus.toolkit.desktop.plugin.ui.properties.l2fprod;

import jdplus.toolkit.base.api.data.Parameter;
import jdplus.toolkit.desktop.plugin.descriptors.EnhancedPropertyDescriptor;
import jdplus.toolkit.desktop.plugin.descriptors.IPropertyDescriptors;
import jdplus.toolkit.base.api.information.InformationSet;
import jdplus.toolkit.base.api.timeseries.TsDomain;
import jdplus.toolkit.base.api.timeseries.TsPeriod;
import jdplus.toolkit.base.api.timeseries.TsUnit;
import jdplus.toolkit.base.api.timeseries.regression.IOutlier;
import jdplus.toolkit.base.api.timeseries.regression.Variable;
import java.beans.IntrospectionException;
import java.beans.PropertyDescriptor;
import java.time.Clock;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.List;

/**
 *
 * @author Mats Maggi
 */
public class OutlierDescriptor implements IPropertyDescriptors {
    
    public static enum OutlierType {
        AO, LS, TC, SO;
    }
    
    private static final int NAME_ID = 0, POSITION_ID = 1, TYPE_ID = 2, FIXEDPARAMETER_ID = 3, PARAMETER_ID = 4;
    private LocalDate position;
    private OutlierType type;
    private Parameter parameter;
    private String name;
    
    public OutlierDescriptor() {
        position = LocalDate.now(Clock.systemDefaultZone());
        type = OutlierType.AO;
        parameter = Parameter.undefined();
        name = null;
    }
    
    public OutlierDescriptor(LocalDate pos, OutlierType type) {
        this.position = pos;
        this.type = type;
        parameter = Parameter.undefined();
        name = null;
    }
    
    public OutlierDescriptor(LocalDate pos, OutlierType type, Parameter parameter, String name) {
        this.position = pos;
        this.type = type;
        this.parameter = parameter;
        if (name != null && !name.isBlank() && !name.equals(name())) {
            this.name = name;
        } else {
            this.name = null;
        }
    }
    
    public  OutlierDescriptor(Variable var) {
        O core = var.getCore();
        position = core.getPosition().toLocalDate();
        type = OutlierType.valueOf(core.getCode());
        parameter = var.getCoefficient(0);
        String c = var.getName();
        if (!c.isBlank() && !c.equals(name())) {
            name = c;
        }
    }
    
    public OutlierDescriptor(OutlierDescriptor desc) {
        position = desc.position;
        type = desc.type;
        parameter = desc.parameter;
        name = desc.name;
    }
    
    public OutlierDescriptor duplicate() {
        return new OutlierDescriptor(this);
    }
    
    private String name() {
        TsDomain domain = UserInterfaceContext.INSTANCE.getDomain();
        int freq = domain == null ? 0 : domain.getAnnualFrequency();
        StringBuilder builder = new StringBuilder();
        if (freq == 0) {
            builder.append(type).append(InformationSet.SEP).append(position.format(DateTimeFormatter.ISO_DATE));
            if (parameter.isFixed()) {
                builder.append(" [").append(parameter.getValue()).append(']');
            }
        } else {
            TsUnit unit = TsUnit.ofAnnualFrequency(freq);
            builder.append(type).append(InformationSet.SEP).append(TsPeriod.of(unit, position).display());
            if (parameter.isFixed()) {
                builder.append(" [").append(parameter.getValue()).append(']');
            }
        }
        return builder.toString();
    }
    
    public String getName() {
        return name == null ? name() : name;
    }
    
    public void setName(String name) {
        if (!name.isBlank() && !name.equals(name())) {
            this.name = name;
        }else
            this.name=null;
    }
    
    public LocalDate getPosition() {
        return position;
    }
    
    public void setPosition(LocalDate position) {
        this.position = position;
    }
    
    public OutlierType getType() {
        return type;
    }
    
    public void setType(OutlierType type) {
        this.type = type;
    }
    
    public Parameter getParameter() {
        return parameter;
    }
    
    public void setParameter(Parameter p) {
        parameter = p ;
    }
    
    public Parameter getCoefficient() {
        return parameter;
    }
    
    @Override
    public List getProperties() {
        ArrayList descs = new ArrayList<>();
        EnhancedPropertyDescriptor desc;
        desc = nameDesc();
        if (desc != null) {
            descs.add(desc);
        }
        desc = positionDesc();
        if (desc != null) {
            descs.add(desc);
        }
        desc = typeDesc();
        if (desc != null) {
            descs.add(desc);
        }
        desc = parameterDesc();
        if (desc != null) {
            descs.add(desc);
        }
        return descs;
    }
    
    @Override
    public String getDisplayName() {
        return "Outlier";
    }
    
    EnhancedPropertyDescriptor nameDesc() {
        try {
            PropertyDescriptor desc = new PropertyDescriptor("name", this.getClass());
            EnhancedPropertyDescriptor edesc = new EnhancedPropertyDescriptor(desc, NAME_ID);
            desc.setDisplayName("Name");
            return edesc;
        } catch (IntrospectionException ex) {
            return null;
        }
    }
    
    private EnhancedPropertyDescriptor positionDesc() {
        try {
            PropertyDescriptor desc = new PropertyDescriptor("position", this.getClass());
            EnhancedPropertyDescriptor edesc = new EnhancedPropertyDescriptor(desc, POSITION_ID);
            desc.setDisplayName("Position");
            return edesc;
        } catch (IntrospectionException ex) {
            return null;
        }
    }
    
    private EnhancedPropertyDescriptor typeDesc() {
        try {
            PropertyDescriptor desc = new PropertyDescriptor("type", this.getClass());
            EnhancedPropertyDescriptor edesc = new EnhancedPropertyDescriptor(desc, TYPE_ID);
            desc.setDisplayName("Outlier Type");
            return edesc;
        } catch (IntrospectionException ex) {
            return null;
        }
    }
    
    private EnhancedPropertyDescriptor parameterDesc() {
        try {
            PropertyDescriptor desc = new PropertyDescriptor("parameter", this.getClass());
            EnhancedPropertyDescriptor edesc = new EnhancedPropertyDescriptor(desc, PARAMETER_ID);
            desc.setDisplayName("Parameter value");
            return edesc;
        } catch (IntrospectionException ex) {
            return null;
        }
    }
    
    @Override
    public String toString() {
        return getName();
    }
    
}