statoolinfosweb/src/fr/devinsy/statoolinfos/core/Federation.java

/*
 * Copyright (C) 2020 Christian Pierre MOMON <christian@momon.org>
 * 
 * This file is part of StatoolInfos, simple service statistics tool.
 * 
 * StatoolInfos is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * StatoolInfos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with StatoolInfos.  If not, see <http://www.gnu.org/licenses/>.
 */
package fr.devinsy.statoolinfos.core;

import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.time.LocalDateTime;

import org.apache.commons.lang3.StringUtils;

import fr.devinsy.statoolinfos.properties.PathProperties;
import fr.devinsy.statoolinfos.properties.PathPropertyList;

/**
 * The Class PathProperty.
 */
public class Federation extends PathPropertyList
{
    private static final long serialVersionUID = -8970835291634661580L;
    private Organizations organizations;
    private File inputFile;

    /**
     * Instantiates a new federation.
     */
    public Federation()
    {
        super();
        this.organizations = new Organizations();
    }

    /**
     * Instantiates a new federation.
     *
     * @param properties
     *            the properties
     */
    public Federation(final PathProperties properties)
    {
        super(properties);

        if ((properties == null) || (StringUtils.isBlank(properties.get("federation.name"))))
        {
            throw new IllegalArgumentException("Not a federation.");
        }
        else
        {
            this.organizations = new Organizations();
        }
    }

    /**
     * Gets the all services.
     *
     * @return the all services
     */
    public Services getAllServices()
    {
        Services result;

        result = new Services();

        for (Organization organization : this.organizations)
        {
            result.addAll(organization.getServices());
        }

        //
        return result;
    }

    /**
     * Gets the contact email.
     *
     * @return the contact email
     */
    public String getContactEmail()
    {
        String result;

        result = get("federation.contact.email");

        //
        return result;
    }

    /**
     * Gets the contact website.
     *
     * @return the contact website
     */
    public String getContactWebsite()
    {
        String result;

        result = get("federation.contact.url");

        //
        return result;
    }

    /**
     * Gets the crawled date.
     *
     * @return the crawled date
     */
    public LocalDateTime getCrawledDate()
    {
        LocalDateTime result;

        result = LocalDateTime.parse(get("crawl.file.datetime"));

        //
        return result;
    }

    /**
     * Gets the description.
     *
     * @return the description
     */
    public String getDescription()
    {
        String result;

        result = get("federation.description");

        //
        return result;
    }

    public File getInputFile()
    {
        return this.inputFile;
    }

    /**
     * Gets the legal website.
     *
     * @return the legal website
     */
    public String getLegalWebsite()
    {
        String result;

        result = get("federation.legal.url", "federation.legal");

        //
        return result;
    }

    /**
     * Gets the logo URL.
     *
     * @return the logo URL
     * @throws MalformedURLException
     */
    public URL getLogoURL() throws MalformedURLException
    {
        URL result;

        String path = get("federation.logo");
        if ((StringUtils.isBlank(path)) || (!StringUtils.startsWith(path, "http")))
        {
            result = null;
        }
        else
        {
            result = new URL(path);
        }

        //
        return result;
    }

    /**
     * Gets the name.
     *
     * @return the name
     */
    public String getName()
    {
        String result;

        result = get("federation.name");

        //
        return result;
    }

    /**
     * Gets the organiation count.
     *
     * @return the organiation count
     */
    public int getOrganiationCount()
    {
        int result;

        result = this.organizations.size();

        //
        return result;
    }

    public Organizations getOrganizations()
    {
        return this.organizations;
    }

    /**
     * Gets the service count.
     *
     * @return the service count
     */
    public int getServiceCount()
    {
        int result;

        result = 0;
        for (Organization organization : this.organizations)
        {
            result += organization.getServiceCount();
        }

        //
        return result;
    }

    /**
     * Gets the software catalog.
     *
     * @return the software catalog
     */
    public Softwares getSoftwares()
    {
        Softwares result;

        result = new Softwares();

        for (Service service : getAllServices())
        {
            if (StringUtils.isNotBlank(service.getSoftwareName()))
            {
                Software software = result.get(service.getSoftwareName());

                if (software == null)
                {
                    software = new Software(service.getSoftwareName(), service.getSoftwareDescription());
                    result.put(software);
                }
            }
        }

        //
        return result;
    }

    /**
     * Gets the start date.
     *
     * @return the start date
     */
    public String getStartDate()
    {
        String result;

        result = get("federation.startdate");

        //
        return result;
    }

    /**
     * Gets the technical doc website.
     *
     * @return the technical doc website
     */
    public String getTechnicalDocWebsite()
    {
        String result;

        result = get("federation.documentation.technical", "federation.documentationtechnical.url", "federation.technical", "federation.technical.url", "service.guide.technical",
                "federation.guide.technical.url");

        //
        return result;
    }

    /**
     * Gets the technical name.
     *
     * @return the technical name
     */
    public String getTechnicalName()
    {
        String result;

        result = StatoolInfosUtils.toTechnicalName(getName());

        //
        return result;
    }

    /**
     * Gets the user doc website.
     *
     * @return the user doc website
     */
    public String getUserDocWebsite()
    {
        String result;

        result = get("federation.documentation", "federation.documentation.url", "federation.documentation.user", "federation.documentation.user.url", "service.documentation.tutorial",
                "federation.documentation.tutorial.url",
                "federation.guide.user",
                "federation.guide.user.url");

        //
        return result;
    }

    /**
     * Gets the website.
     *
     * @return the website
     */
    public String getWebsite()
    {
        String result;

        result = get("federation.website");

        //
        return result;
    }

    public void setInputFile(final File inputFile)
    {
        this.inputFile = inputFile;
    }
}