com.aylien.textapi.parameters.SummarizeParams Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of client Show documentation
AYLIEN's officially supported Java client library for accessing Text API
There is a newer version: 0.7.0
/**
 * Copyright 2016 Aylien, Inc. All Rights Reserved.
 *
 * 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.aylien.textapi.parameters;

import java.net.URL;

public class SummarizeParams {
    private String mode;
    private int numberOfSentences;
    private int percentageOfSentences;
    private String text;
    private String title;
    private URL url;

    /**
     * Constructs parameters that define a document whose summary needs to
     * generated.
     *
     * @param text Text
     *             This argument may be null, in which case url can not
     *             be null. If text is provided, title is required too.
     * @param title Title
     *              This argument may be null, in which case url can not
     *              be null. If title is provided, text is required too.
     * @param url URL
     *            This argument may be null, in which case the pair of
     *            text and title can not be null
     * @param mode Summarize mode
     *             This argument may be null, in which case a default value
     *             of default is assumed.
     *             Possible values are: default and short.
     * @param numberOfSentences Number of sentences in summary
     *                          This argument may be null, in which case a
     *                          default value of 5 is assumed.
     * @param percentageOfSentences Percentage of original document's
     *                              number of sentences in summary.
     *                              This argument may be null, in which case
     *                              value of numberOfSentences is used.
     */
    public SummarizeParams(String text, String title, URL url, String mode, int numberOfSentences, int percentageOfSentences) {
        this.text = text;
        this.title = title;
        this.url = url;
        this.mode = mode;
        this.numberOfSentences = numberOfSentences;
        this.percentageOfSentences = percentageOfSentences;
    }

    public String getMode() {
        return mode;
    }

    public int getNumberOfSentences() {
        return numberOfSentences;
    }

    public int getPercentageOfSentences() {
        return percentageOfSentences;
    }

    public String getText() {
        return text;
    }

    public String getTitle() {
        return title;
    }

    public URL getUrl() {
        return url;
    }

    public static Builder newBuilder() {
        return new Builder();
    }

    /**
     * Builder class to construct a SummarizeParams instance.
     */
    public static class Builder {
        private String mode = "default";
        private int numberOfSentences = 5;
        private int percentageOfSentences;
        private String text;
        private String title;
        private URL url;

        public Builder setMode(String mode) {
            this.mode = mode;
            return this;
        }

        public Builder setNumberOfSentences(int numberOfSentences) {
            this.numberOfSentences = numberOfSentences;
            return this;
        }

        public Builder setPercentageOfSentences(int percentageOfSentences) {
            this.percentageOfSentences = percentageOfSentences;
            return this;
        }

        public Builder setText(String text) {
            this.text = text;
            return this;
        }

        public Builder setTitle(String title) {
            this.title = title;
            return this;
        }

        public Builder setUrl(URL url) {
            this.url = url;
            return this;
        }

        public SummarizeParams build() {
            return new SummarizeParams(text, title, url, mode, numberOfSentences, percentageOfSentences);
        }
    }
}