com.basistech.rosette.dm.Keyphrase 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.3
/*
* Copyright 2017 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 com.google.common.base.Objects;

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

/**
 * A reference to a "keyphrase" of a document. Each keyphrase is a specific
 * span of text that is highly relevant to the document.
 * Each {@linkplain Keyphrase} provides:
 * 
 *     the name of the specific keyphrase
 *     the salience associated with the keyphrase
 *     a list of {@linkplain Extent}s marking each location of the keyphrase in the text
 * 
 */
public class Keyphrase extends BaseAttribute implements Serializable {
    private static final long serialVersionUID = 222L;
    private final String phrase;
    private final Double salience;
    private final List extents;

    protected Keyphrase(String phrase, Double salience, List extents, Map extendedProperties) {
        super(extendedProperties);
        this.phrase = phrase;
        this.salience = salience;
        this.extents = listOrNull(extents);
    }

    /**
     * Returns the name of the keyphrase
     * @return phrase the name of the keyphrase
     */
    public String getPhrase() {
        return phrase;
    }

    /**
     * Returns the salience value associated with the keyphrase
     * @return the salience value
     */
    public Double getSalience() {
        return salience;
    }

    /**
     * Returns the list of extents marking the offsets of each instance
     * of the keyphrase in the text
     * @return the list of extents
     */
    public List getExtents() {
        return extents;
    }

    @Override
    protected Objects.ToStringHelper toStringHelper() {
        return super.toStringHelper()
                .add("phrase", phrase)
                .add("salience", salience)
                .add("extents", extents);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        if (!super.equals(o)) {
            return false;
        }

        Keyphrase that = (Keyphrase) o;

        if (phrase != null ? !phrase.equals(that.phrase) : that.phrase != null) {
            return false;
        }

        if (salience != null ? !salience.equals(that.salience) : that.salience != null) {
            return false;
        }

        return !(extents != null ? !extents.equals(that.extents) : that.extents != null);
    }

    @Override
    public int hashCode() {
        int result = super.hashCode();
        result = 31 * result + (phrase != null ? phrase.hashCode() : 0);
        result = 31 * result + (salience != null ? salience.hashCode() : 0);
        result = 31 * result + (extents != null ? extents.hashCode() : 0);
        return result;
    }

    /**
     * A builder for keyphrases
     */
    public static class Builder extends BaseAttribute.Builder {
        private String phrase;
        private Double salience;
        private List extents;

        /**
         * Constructs a builder from the required properties
         * @param phrase the name of the keyphrase
         * @param extents the list of extents marking offsets for each mention of the
         *                keyphrase in the text
         */
        public Builder(String phrase, List extents) {
            this.phrase = phrase;
            this.extents = extents;
        }

        /**
         * Constructs a builder out of an existing Keyphrase
         * @param toCopy the keyphrase to copy
         */
        public Builder(Keyphrase toCopy) {
            super(toCopy);
            this.phrase = toCopy.getPhrase();
            this.salience = toCopy.getSalience();
            this.extents = toCopy.getExtents();
        }

        /**
         * Specify the name of the keyphrase
         * @param phrase the name of the keyphrase
         * @return this
         */
        public Builder phrase(String phrase) {
            this.phrase = phrase;
            return this;
        }

        /**
         * Specify the salience value for the keyphrase
         * @param salience the salience value
         * @return this
         */
        public Builder salience(Double salience) {
            this.salience = salience;
            return this;
        }

        /**
         * Specify the list of offsets of each mention of the keyphrase
         * @param extents the list of extents
         * @return this
         */
        public Builder extents(List extents) {
            this.extents = extents;
            return this;
        }

        /**
         * Returns an immutable Keyphrase out of the builder contents
         * @return the new Keyphrase
         */
        public Keyphrase build() {
            return new Keyphrase(phrase, salience, extents, buildExtendedProperties());
        }

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