com.ibm.g11n.pipeline.client.SegmentData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gp-java-client Show documentation
Java client SDK for Globalization Pipeline on IBM Bluemix providing JDK ResourceBundle integration and Java APIs for Globalization Pipeline's REST endpoints.
The newest version!
/*  
 * Copyright IBM Corp. 2018
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.ibm.g11n.pipeline.client;

import java.util.Date;
import java.util.List;
import java.util.Map;

/**
 * SegmentData provides read access to the segment's
 * properties.
 * 
 * @author jugudanniesundar
 */
public abstract class SegmentData {
    private final String value;
    private final String sourceValue;
    private final TranslationStatus translationStatus;
    private final boolean reviewed;
    private final String updatedBy;
    private final Date updatedAt;

    /**
     * Protected constructor for a subclass extending SegmentData
     * 
     * @param value             The segment value.
     * @param sourceValue       The segment value in the source language.
     * @param translationStatus The translation status.
     * @param reviewed          If this string value marked as reviewed.
     * @param updatedBy         The last user who updated this segment.
     * @param updatedAt         The last date when this segment was updated.
     */
    protected SegmentData(String value, String sourceValue,
            TranslationStatus translationStatus,
            boolean reviewed, String updatedBy, Date updatedAt) {
        this.value = value;
        this.sourceValue = sourceValue;
        this.translationStatus = translationStatus;
        this.reviewed = reviewed;
        this.updatedBy = updatedBy;
        this.updatedAt = updatedAt;
    }

    /**
     * Returns the segment value. If this entry is for a translation
     * target language, then this is the translation result.
     * 
     * @return The segment value.
     */
    public final String getValue() {
        return value;
    }

    /**
     * Returns the segment value in the source language.
     * 
     * @return The segment value in the source language.
     */
    public final String getSourceValue() {
        return sourceValue;
    }

    /**
     * Returns the current translation status.
     * 
     * @return The current translation status.
     * @see TranslationStatus
     */
    public final TranslationStatus getTranslationStatus() {
        return translationStatus;
    }

    /**
     * Returns true if this entry is marked as reviewed.
     * 
     * @return true if this entry is marked as reviewed.
     */
    public final boolean isReviewed() {
        return reviewed;
    }

    /**
     * Returns the last user updated this resource entry.
     * 
     * @return The last user updated this resource entry.
     */
    public final String getUpdatedBy() {
        return updatedBy;
    }

    /**
     * Returns the last date when this resource entry was updated.
     * 
     * @return The last date when this resource entry was updated.
     */
    public final Date getUpdatedAt() {
        return updatedAt;
    }

    /**
     * Returns the notes for this resource entry.
     * 
     * @return The notes for this resource entry.
     */
    public abstract List getNotes();

    /**
     * Returns the arbitrary metadata represented by string key-value pairs.
     * 
     * @return The arbitrary metadata represented by string key-value pairs.
     */
    public abstract Map getMetadata();

    /**
     * Returns the status string set by a translation partner.
     * This property is reserved for a translation partner's use.
     * 
     * @return The status string set by a translation partner.
     */
    public abstract String getPartnerStatus();

    /**
     * Returns the sequence number of the segment.
     * 
     * @return The sequence number of the segment.
     */
    public abstract Integer getSequenceNumber();
}