org.zanata.rest.dto.resource.TranslationsResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zanata-common-api Show documentation
Zanata API definitions
There is a newer version: 4.6.2
package org.zanata.rest.dto.resource;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import com.webcohesion.enunciate.metadata.Label;
import org.codehaus.jackson.annotate.JsonIgnore;
import org.codehaus.jackson.annotate.JsonIgnoreProperties;
import org.codehaus.jackson.annotate.JsonProperty;
import org.codehaus.jackson.annotate.JsonPropertyOrder;
import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.zanata.common.Namespaces;
import org.zanata.rest.dto.Extensible;
import org.zanata.rest.dto.HasSample;
import org.zanata.rest.dto.Links;
import org.zanata.rest.dto.extensions.gettext.TranslationsResourceExtension;

/**
 * Represents the translation of a document into a single locale.
 */
@XmlType(name = "translationsResourceType", propOrder = { "links",
        "extensions", "textFlowTargets" })
@XmlRootElement(name = "translations")
@JsonPropertyOrder({ "links", "extensions", "textFlowTargets" })
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
@Label("Translations")
public class TranslationsResource implements Serializable,
        HasSample,
        Extensible {
    private static final long serialVersionUID = 1L;
    private ExtensionSet extensions;
    private Links links;
    private List textFlowTargets;
    private Integer revision;

    /**
     * Any provided extensions
     */
    @XmlElementWrapper(name = "extensions", required = false,
            namespace = Namespaces.ZANATA_OLD)
    @XmlElement(name = "extension", namespace = Namespaces.ZANATA_OLD)
    public ExtensionSet getExtensions() {
        return extensions;
    }

    public void setExtensions(
            ExtensionSet extensions) {
        this.extensions = extensions;
    }

    @JsonIgnore
    public ExtensionSet getExtensions(
            boolean createIfNull) {
        if (createIfNull && extensions == null)
            extensions = new ExtensionSet();
        return extensions;
    }

    /**
     * The text flow targets (i.e. translated text)
     */
    @XmlElementWrapper(name = "targets", required = false,
            namespace = Namespaces.ZANATA_OLD)
    @XmlElement(name = "text-flow-target", namespace = Namespaces.ZANATA_API)
    @JsonProperty("textFlowTargets")
    public List getTextFlowTargets() {
        if (textFlowTargets == null) {
            textFlowTargets = new ArrayList();
        }
        return textFlowTargets;
    }

    /**
     * A collection of links provided with the translations.
     */
    @XmlElement(name = "links", namespace = Namespaces.ZANATA_OLD)
    public Links getLinks() {
        return links;
    }

    public void setLinks(Links links) {
        this.links = links;
    }

    @JsonIgnore
    public Links getLinks(boolean createIfNull) {
        if (createIfNull && links == null)
            links = new Links();
        return links;
    }

    /**
     * Revision number for the translations
     */
    @XmlAttribute()
    public Integer getRevision() {
        return revision;
    }

    public void setRevision(Integer revision) {
        this.revision = revision;
    }

    @Override
    public TranslationsResource createSample() {
        return new TranslationsResource();
    }

    // @Override
    // public String toString()
    // {
    // return DTOUtil.toXML(this);
    // }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result =
                prime * result
                        + ((extensions == null) ? 0 : extensions.hashCode());
        result = prime * result + ((links == null) ? 0 : links.hashCode());
        result =
                prime
                        * result
                        + ((textFlowTargets == null) ? 0 : textFlowTargets
                                .hashCode());
        result =
                prime * result + ((revision == null) ? 0 : revision.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof TranslationsResource)) {
            return false;
        }
        TranslationsResource other = (TranslationsResource) obj;
        if (extensions == null) {
            if (other.extensions != null) {
                return false;
            }
        } else if (!extensions.equals(other.extensions)) {
            return false;
        }
        if (links == null) {
            if (other.links != null) {
                return false;
            }
        } else if (!links.equals(other.links)) {
            return false;
        }
        if (textFlowTargets == null) {
            if (other.textFlowTargets != null) {
                return false;
            }
        } else if (!textFlowTargets.equals(other.textFlowTargets)) {
            return false;
        }
        if (revision == null) {
            if (other.revision != null) {
                return false;
            }
        } else if (!revision.equals(other.revision)) {
            return false;
        }
        return true;
    }

}