/**
 * Copyright (C) 2012-2017 52°North Initiative for Geospatial Open Source
 * Software GmbH
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published
 * by the Free Software Foundation.
 *
 * If the program is linked with libraries which are licensed under one of
 * the following licenses, the combination of the program with the linked
 * library is not considered a "derivative work" of the program:
 *
 *     - Apache License, version 2.0
 *     - Apache Software License, version 1.0
 *     - GNU Lesser General Public License, version 3
 *     - Mozilla Public License, versions 1.0, 1.1 and 2.0
 *     - Common Development and Distribution License (CDDL), version 1.0
 *
 * Therefore the distribution of the program linked with libraries licensed
 * under the aforementioned licenses, is permitted by the copyright holders
 * if the distribution is compliant with both the GNU General Public
 * License version 2 and the aforementioned licenses.
 *
 * This program 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 General
 * Public License for more details.
 */
package org.n52.sos.inspire.aqd;


import org.n52.sos.util.Nillable;

import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;

/**
 * TODO JavaDoc
 * @author Christian Autermann
 */
public class Spelling {

    private String text;
    private Nillable<String> script = Nillable.missing();
    private Nillable<String> transliterationScheme = Nillable.missing();

    public String getText() {
        if (Strings.isNullOrEmpty(text)) {
            return "unknown";
        }
        return text;
    }

    public Spelling setText(String text) {
        this.text = Preconditions.checkNotNull(text);
        return this;
    }

    public Nillable<String> getScript() {
        return script;
    }

    public Spelling setScript(Nillable<String> script) {
        this.script = Preconditions.checkNotNull(script);
        return this;
    }

    public Spelling setScript(String script) {
        return setScript(Nillable.of(script));
    }

    public Nillable<String> getTransliterationScheme() {
        return transliterationScheme;
    }

    public Spelling setTransliterationScheme(Nillable<String> transliterationScheme) {
        this.transliterationScheme = Preconditions.checkNotNull(transliterationScheme);
        return this;
    }

    public Spelling setTransliterationScheme(String transliterationScheme) {
        return this.setTransliterationScheme(Nillable.of(transliterationScheme));
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(getText(), getScript(), getTransliterationScheme());
    }

    @Override
    public String toString() {
        return Objects.toStringHelper(this)
                .add("text", getText())
                .add("script", getScript())
                .add("transliterationScheme", getTransliterationScheme())
                .toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof Spelling) {
            Spelling that = (Spelling) obj;
            return Objects.equal(this.getText(), that.getText()) &&
                   Objects.equal(this.getScript(), that.getScript()) &&
                   Objects.equal(this.getTransliterationScheme(), that.getTransliterationScheme());
        }
        return false;
    }





}