com.ibm.g11n.pipeline.client.NewBundleData 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.
There is a newer version: 1.2.1
Show newest version
/*  
 * Copyright IBM Corp. 2015
 *
 * 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.Map;
import java.util.Objects;
import java.util.Set;

/**
 * NewBundleData is used for specifying new bundle's
 * properties.
 * 
 * @author Yoshito Umaoka
 */
public class NewBundleData {
    private final String sourceLanguage;
    private Set targetLanguages;
    private Map metadata;
    private String partner;
    private String segmentSeparatorPattern;
    private String noTranslationPattern;

    /**
     * Constructor.
     * 
     * @param sourceLanguage    The source language of the new bundle, specified
     *                          by BCP 47 language tag. Must not be null.
     */
    public NewBundleData(String sourceLanguage) {
        this.sourceLanguage = Objects.requireNonNull(sourceLanguage,
                "sourceLanguage must no be null");
    }

    /**
     * Returns the source language.
     * 
     * @return The source language.
     */
    public String getSourceLanguage() {
        return sourceLanguage;
    }

    /**
     * Returns the set of target languages.
     * 
     * @return The set of target languages.
     */
    public Set getTargetLanguages() {
        return targetLanguages;
    }

    /**
     * Sets the set of target languages specified by BCP 47 language tags.
     * 
     * @param targetLanguages   The set of target languages specified by BCP 47
     *                          language tags.
     * @return This object.
     */
    public NewBundleData setTargetLanguages(Set targetLanguages) {
        this.targetLanguages = targetLanguages;
        return this;
    }

    /**
     * Returns a map containing the key-value pairs.
     * 
     * @return A map containing the key-value pairs.
     */
    public Map getMetadata() {
        return metadata;
    }

    /**
     * Sets arbitrary metadata associated with the new bundle specified
     * by a map containing string key-value pairs.
     * 
     * @param metadata  A map containing string key-value pairs.
     * @return This object.
     */
    public NewBundleData setMetadata(Map metadata) {
        this.metadata = metadata;
        return this;
    }

    /**
     * Returns the translation partner assigned to the new bundle.
     * 
     * @return The translation partner assigned to the new bundle.
     */
    public String getPartner() {
        return partner;
    }

    /**
     * Sets the translation partner assigned to the new bundle.
     * 
     * @param partner The translation partner assigned to the new bundle.
     * @return This object.
     */
    public NewBundleData setPartner(String partner) {
        this.partner = partner;
        return this;
    }

    /**
     * Returns the user defined segmentation separator pattern string in Java
     * regular expression syntax.
     * 
     * @return The user defined segmentation separator pattern.
     */
    public String getSegmentSeparatorPattern() {
        return segmentSeparatorPattern;
    }

    /**
     * Sets the user defined segmentation separator pattern string in Java
     * regular expression syntax.
     * 
     * The pattern is used for dividing an input resource string value into
     * multiple segments before machine translation. The matching substrings
     * will be preserved after machine translation.
     * 
     * @param segmentSeparatorPattern   The user defined segmentation separator pattern.
     * @return This object.
     */
    public NewBundleData setSegmentSeparatorPattern(String segmentSeparatorPattern) {
        this.segmentSeparatorPattern = segmentSeparatorPattern;
        return this;
    }

    /**
     * Returns the user defined no-translation pattern string in Java regular
     * expression syntax.
     * 
     * @return The user defined no-translation pattern string.
     */
    public String getNoTranslationPattern() {
        return noTranslationPattern;
    }

    /**
     * Sets the user defined no-translation pattern string in Java regular
     * expression syntax.
     * 
     * The pattern is used for preserving matching substrings during machine
     * translation. For example, pattern "IBM|Bluemix" will skip translating
     * the words "IBM" and "Bluemix".
     * 
     * @param noTranslationPattern  The user defined no-translation pattern string.
     * @return This object.
     */
    public NewBundleData setNoTranslationPattern(String noTranslationPattern) {
        this.noTranslationPattern = noTranslationPattern;
        return this;
    }
}