LanguageQualityIssue.java

/*
 * Copyright (C) 2013-2015, VistaTEC or third-party contributors as indicated
 * by the @author tags or express copyright attribution statements applied by
 * the authors. All third-party contributions are distributed under license by
 * VistaTEC.
 *
 * This file is part of Ocelot.
 *
 * Ocelot is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Ocelot is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, write to:
 *
 *     Free Software Foundation, Inc.
 *     51 Franklin Street, Fifth Floor
 *     Boston, MA 02110-1301
 *     USA
 *
 * Also, see the full LGPL text here: <http://www.gnu.org/copyleft/lesser.html>
 */
package com.vistatec.ocelot.its.model;

import com.vistatec.ocelot.rules.DataCategoryField;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.EnumMap;
import java.util.Map;
import java.util.Objects;

import net.sf.okapi.common.annotation.GenericAnnotation;
import net.sf.okapi.common.annotation.GenericAnnotationType;

/**
 * Represents Language Quality Issue Data Category in the ITS 2.0 spec.
 */
public class LanguageQualityIssue extends ITSMetadata {
	
//	public static final int NONE = -1;
//	public static final int MINOR = 0;
//	public static final int MAJOR = 1;
//	public static final int CRITICAL = 2;
    private String type, comment, issuesRef;
    private double severity;
//    private int severityType = NONE;
    private String severityName;
    private URL profileReference;
    private boolean enabled = true;

    public LanguageQualityIssue() {
        super();
    }

    public LanguageQualityIssue(LanguageQualityIssue lqi) {
        this.type = lqi.type;
        this.comment = lqi.comment;
        this.issuesRef = lqi.issuesRef;
        this.severity = lqi.severity;
        this.profileReference = lqi.profileReference;
        this.enabled = lqi.enabled;
    }

    /**
     * XLIFF 1.2 binding.  This will need to move out of this class eventually.
     * @deprecated
     */
    public LanguageQualityIssue(GenericAnnotation ga) {
        if (ga.getString(GenericAnnotationType.LQI_ISSUESREF) != null) {
            this.issuesRef = ga.getString(GenericAnnotationType.LQI_ISSUESREF);
            if (this.issuesRef.charAt(0) == '#') {
                this.issuesRef = this.issuesRef.substring(1);
            }
        }
        if (ga.getString(GenericAnnotationType.LQI_TYPE) != null) {
            this.type = ga.getString(GenericAnnotationType.LQI_TYPE);
        }
        if (ga.getDouble(GenericAnnotationType.LQI_SEVERITY) != null) {
            this.severity = ga.getDouble(GenericAnnotationType.LQI_SEVERITY);
        }
        if (ga.getString(GenericAnnotationType.LQI_COMMENT) != null) {
            this.comment = ga.getString(GenericAnnotationType.LQI_COMMENT);
        }
        if (ga.getString(GenericAnnotationType.LQI_PROFILEREF) != null) {
            try {
                this.profileReference = new URL(GenericAnnotationType.LQI_PROFILEREF);
            } catch (MalformedURLException ex) {
                // TODO: Handle url exception appropriately
                System.err.println(ex.getMessage());
            }
        }
        if (ga.getBoolean(GenericAnnotationType.LQI_ENABLED) != null) {
            this.enabled = ga.getBoolean(GenericAnnotationType.LQI_ENABLED);
        }
    }

    @Override
    public Map<DataCategoryField, Object> getFieldValues() {
        Map<DataCategoryField, Object> map = new EnumMap<>(DataCategoryField.class);
        map.put(DataCategoryField.LQI_TYPE, type);
        map.put(DataCategoryField.LQI_COMMENT, comment);
        map.put(DataCategoryField.LQI_SEVERITY, severity);
        return map;
    }

    public String getType() {
        return this.type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getComment() {
        return comment;
    }

    public void setComment(String comment) {
        this.comment = comment;
    }

    public double getSeverity() {
        return severity;
    }

    public void setSeverity(double severity) {
        this.severity = severity;
    }

    public URL getProfileReference() {
        return profileReference;
    }

    public void setProfileReference(URL profileReference) {
        this.profileReference = profileReference;
    }

    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    public String getIssuesRef() {
        return issuesRef;
    }

    public void setIssuesRef(String issuesRef) {
        this.issuesRef = issuesRef;
    }
    
//    public int getSeverityType() {
//		return severityType;
//	}
//
//	public void setSeverityType(int severityType) {
//		this.severityType = severityType;
//	}
    
    public String getSeverityName() {
		return severityName;
	}

	public void setSeverityName(String severityName) {
		this.severityName = severityName;
	}

	@Override
    public String toString() {
        return getType();
    }

    @Override
    public boolean equals(Object o) {
        if (o == this) return true;
        if (o == null || !(o instanceof LanguageQualityIssue)) return false;
        LanguageQualityIssue lqi = (LanguageQualityIssue)o;
        return severity == lqi.severity &&
               enabled == lqi.enabled &&
               Objects.equals(profileReference, lqi.profileReference) &&
               Objects.equals(type, lqi.type) &&
               Objects.equals(comment, lqi.comment) &&
               Objects.equals(issuesRef, lqi.issuesRef);
    }

    @Override
    public int hashCode() {
        return Objects.hash(severity, enabled, profileReference, type, comment, issuesRef);
    }
}