com.basistech.rosette.dm.SimilarTerm Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of adm-model Show documentation
ADM data model.
There is a newer version: 3.0.6
/*
* Copyright 2018 Basis Technology Corp.
*
* 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.basistech.rosette.dm;

import lombok.EqualsAndHashCode;

import java.io.Serializable;

/**
 * A term with some semantic similarity to an {@link AnnotatedText}.
 */
@EqualsAndHashCode(callSuper = true)
public class SimilarTerm extends BaseAttribute implements Serializable {
    private final String term;
    private final Double similarity;

    protected SimilarTerm(String term, Double similarity) {
        this.term = term;
        this.similarity = similarity;
    }

    /**
     * Returns the text of this term
     * @return the text of this term
     */
    public String getTerm() {
        return term;
    }

    /**
     * Returns the similarity between this term and the document
     * @return the similarity between this term and the document
     */
    public Double getSimilarity() {
        return similarity;
    }

    @Override
    public String toString() {
        return String.format("SimilarTerm{term=%s; similarity=%s}", term, similarity);
    }

    /**
     * Builder class for SimilarTerm
     */
    public static class Builder extends BaseAttribute.Builder {
        private String term;
        private Double similarity;

        public Builder() {
            term = null;
            similarity = null;
        }

        /**
         * Specifies the text of this term
         * @param term the text of this term
         * @return this
         */
        public Builder term(String term) {
            this.term = term;
            return this;
        }

        /**
         * Specifies the similarity of this term
         * @param similarity the similarity of this term
         * @return this
         */
        public Builder similarity(Double similarity) {
            this.similarity = similarity;
            return this;
        }

        /**
         * Returns an immutable SimilarTerm from the current state of this builder
         * @return the new SimilarTerm instance
         */
        public SimilarTerm build() {
            return new SimilarTerm(term, similarity);
        }

        @Override
        protected Builder getThis() {
            return this;
        }
    }
}