catalogue-util-library/src/main/java/org/gcube/datacatalogue/utillibrary/shared/jackan/model/CkanGroupOrgBase.java

/* 
 * Copyright 2015 Trento Rise  (trentorise.eu) 
 *
 * 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 org.gcube.datacatalogue.utillibrary.shared.jackan.model;


import static org.gcube.datacatalogue.utillibrary.server.utils.GenericUtils.isNotEmpty;

import java.util.List;

import javax.annotation.Nullable;

import org.gcube.com.fasterxml.jackson.annotation.JsonProperty;
import org.gcube.com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import org.gcube.datacatalogue.utillibrary.jackan.JackanModule;



/**
 * Abstract class to model the same data structure that Ckan uses for creating
 * both groups and organizations. Since they are different things and work with
 * different APIs we made two different implementations, {@link CkanGroup} and
 * {@link CkanOrganization}. The Ckan way to tell the difference is the {@link #isOrganization()
 * } field).
 *
 * @author David Leoni
 * @since 0.4.1
 */
public abstract class CkanGroupOrgBase {

    private String approvalStatus;
    private String description;
    private List<CkanPair> extras;
    private List<CkanGroup> groups;
    private String id;

    private String imageUrl;
    private String name;
    private boolean organization;
    @JsonDeserialize(using = JackanModule.GroupOrgPackagesDeserializer.class)
    private List<CkanDataset> packages;

    private CkanState state;
    private String title;
    private String type;
    private List<CkanUser> users;

    protected CkanGroupOrgBase() {
    }

    /**
     * Constructor with minimal amount of parameters needed to successfully
     * create an instance on the server.
     *
     * @param name Name in the url, lowercased and without spaces. i.e.
     * management-of-territory
     */
    protected CkanGroupOrgBase(String name) {
        this.name = name;
    }

    /**
     * can be "approved" or what? Bah
     */
    public String getApprovalStatus() {
        return approvalStatus;
    }

    public void setApprovalStatus(String approvalStatus) {
        this.approvalStatus = approvalStatus;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public List<CkanPair> getExtras() {
        return extras;
    }

    public void setExtras(List<CkanPair> extras) {
        this.extras = extras;
    }

    /**
     * Have no idea what this could mean inside a group!
     */
    public List<CkanGroup> getGroups() {
        return groups;
    }

    public void setGroups(List<CkanGroup> groups) {
        this.groups = groups;
    }

    public String getId() {
        return id;
    }

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

    /**
     * The URL to an image to be displayed on the group/org’s page (optional)
     */
    public String getImageUrl() {
        return imageUrl;
    }

    /**
     * The URL to an image to be displayed on the group/org’s page (optional)
     */
    public void setImageUrl(String imageUrl) {
        this.imageUrl = imageUrl;
    }

    /**
     * Name in the url, lowercased and without spaces. i.e.
     * management-of-territory
     */
    public String getName() {
        return name;
    }

    /**
     * @param name Name in the url, lowercased and without spaces. i.e.
     * management-of-territory
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * A ckan group can also be an organization.
     */
    @JsonProperty("is_organization")
    public boolean isOrganization() {
        return organization;
    }

    /**
     * Protected, we use it only when deserializing
     */
    @JsonProperty("is_organization")
    protected void setOrganization(boolean organization) {
        this.organization = organization;
    }

    /**
     * The datasets of the group. Some api return the *number* of packages, in
     * this case we set the value to null.
     */
    public List<CkanDataset> getPackages() {
        return packages;
    }

     /**
     * The datasets of the group. Some api return the *number* of packages, in
     * this case we set the value to null.
     */
    public void setPackages(List<CkanDataset> packages) {
        this.packages = packages;
    }

    /**
     * The current state of the group, e.g. 'active' or 'deleted', only active
     * groups show up in search results and other lists of groups, this
     * parameter will be ignored if you are not authorized to change the state
     * of the group (optional, default: 'active')
     */
    public CkanState getState() {
        return state;
    }

    /**
     * The current state of the group/organization, e.g. 'active' or 'deleted',
     * only active groups/organizations show up in search results and other
     * lists of groups/organizations, this parameter will be ignored if you are
     * not authorized to change the state (optional, default: 'active')
     */
    public void setState(CkanState state) {
        this.state = state;
    }

    /**
     * Human readable name, i.e. "Department of Justice"
     *
     * @see #getName()
     */
    public String getTitle() {
        return title;
    }

    /**
     * Human readable name, i.e. "Department of Justice"
     *
     * @see #setName(java.lang.String)
     */
    public void setTitle(String title) {
        this.title = title;
    }

    public String getType() {
        return type;
    }

    /**
     * Don't know possible ckan types
     */
    public void setType(String type) {
        this.type = type;
    }

    public List<CkanUser> getUsers() {
        return users;
    }

    public void setUsers(List<CkanUser> users) {
        this.users = users;
    }

    /**
     * Returns the id if non-empty, the name otherwise
     */
    @Nullable
    public String idOrName() {
        return isNotEmpty(getId()) ? getId() : getName();
    }

    /**
     * Returns the name if non-empty, the id otherwise
     */
    @Nullable
    public String nameOrId() {

        return isNotEmpty(getName()) ? getName() : getId();
    }

}