com.basistech.rosette.dm.Concept 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 com.google.common.base.MoreObjects;
import lombok.EqualsAndHashCode;

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

/**
 * A reference to a high-level "concept" of a document.  A concept can be an abstract
 * or concrete topic that is highly relevant to the document in question.  Concepts
 * may or may not be explicitly referenced in the document, and as such do not refer to
 * any specific span of text.
 * Each {@linkplain Concept} provides:
 * 
 *     the name of the specific concept
 *     a salience value associated with the concept
 *     an ID that associates the concept some external knowledge base, e.g.
 * Q23 from Wikidata.
 * 
 */
@EqualsAndHashCode(callSuper = true)
public class Concept extends BaseAttribute implements Serializable {
    private static final long serialVersionUID = 250L;
    private final String phrase;
    private final Double salience;
    private final String conceptId;

    protected Concept(String phrase, Double salience, String conceptId, Map extendedProperties) {
        super(extendedProperties);
        this.phrase = phrase;
        this.salience = salience;
        this.conceptId = conceptId;
    }

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

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

    /**
     * Returns the ID associated with the concept
     * @return the ID associated with the concept
     */
    public String getConceptId() {
        return conceptId;
    }

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

    /**
     * A Builder for concepts
     */
    public static class Builder extends BaseAttribute.Builder {
        protected String phrase;
        protected Double salience;
        protected String conceptId;

        /**
         * Construct a builder out of the required properties
         * @param phrase the name of the concept
         * @param conceptId the ID associated with the concept
         */
        public Builder(String phrase, String conceptId) {
            this.phrase = phrase;
            this.conceptId = conceptId;
        }

        /**
         * Constructs a builder by copying values from an existing concept
         *
         * @param toCopy the object to copy from
         */
        public Builder(Concept toCopy) {
            super(toCopy);
            this.phrase = toCopy.getPhrase();
            this.salience = toCopy.getSalience();
            this.conceptId = toCopy.getConceptId();
        }

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

        /**
         * Specify the salience associated with this concept
         * @param salience the salience associated with the concept
         * @return this
         */
        public Builder salience(Double salience) {
            this.salience = salience;
            return this;
        }

        /**
         * Specify the unique ID associated with this concept
         * @param conceptId the unique ID associated with the concept
         * @return this
         */
        public Builder conceptId(String conceptId) {
            this.conceptId = conceptId;
            return this;
        }

        /**
         * Returns an immutable concept based on the content of the builder
         * @return the new concept
         */
        public Concept build() {
            return new Concept(phrase, salience, conceptId, buildExtendedProperties());
        }

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

}