org.identifiers.cloud.libapi.models.resourcerecommender.ResourceRecommendation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of libapi Show documentation

This library provides client side service wrappers to access identifiers.org Cloud based API

There is a newer version: 2.6.0

package org.identifiers.cloud.libapi.models.resourcerecommender;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

import java.io.Serializable;

/**
 * @author Manuel Bernal Llinares 
 * Project: libapi
 * Package: org.identifiers.cloud.libapi.models.ResourceRecommender
 * Timestamp: 2018-03-06 12:15
 * ---
 *
 * This POJO models a recommendation for a particular resource, produced by the Resource Reommendation service.
 *
 * As Resource Recommender service issues recommendation metrics as scores / indexes, this class implements the
 * Comparable interface for easy sorting on the client side.
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class ResourceRecommendation implements Serializable, Comparable {
    // This is an index [0,99] on how recommendable is this resource, 0 - not at all, 99 - way to go
    private int recommendationIndex = 0;
    private String recommendationExplanation = "no explanation has been specified";
    // This is the contextual ID of the resource in the current recommendation request
    private String id;
    private String accessURL;

    public int getRecommendationIndex() {
        return recommendationIndex;
    }

    public ResourceRecommendation setRecommendationIndex(int recommendationIndex) {
        this.recommendationIndex = recommendationIndex;
        return this;
    }

    public String getRecommendationExplanation() {
        return recommendationExplanation;
    }

    public ResourceRecommendation setRecommendationExplanation(String recommendationExplanation) {
        this.recommendationExplanation = recommendationExplanation;
        return this;
    }

    public String getId() {
        return id;
    }

    public ResourceRecommendation setId(String id) {
        this.id = id;
        return this;
    }

    public String getAccessURL() {
        return accessURL;
    }

    public ResourceRecommendation setAccessURL(String accessURL) {
        this.accessURL = accessURL;
        return this;
    }

    @Override
    public int compareTo(ResourceRecommendation o) {
        return Integer.compare(recommendationIndex, o.recommendationIndex);
    }
}