All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.enterprisemath.math.prediction.DataCategoyPair Maven / Gradle / Ivy

The newest version!
package com.enterprisemath.math.prediction;

import com.enterprisemath.utils.DomainUtils;
import com.enterprisemath.utils.ValidationUtils;
import java.util.List;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.apache.commons.lang3.builder.ToStringBuilder;

/**
 * Definition of pair with data and category.
 *
 * @author radek.hecl
 */
public class DataCategoyPair {

    /**
     * Builder object.
     */
    public static class Builder {

        /**
         * Log record.
         */
        private List data;

        /**
         * Category.
         */
        private String category;

        /**
         * Sets data.
         *
         * @param data data
         * @return this instance
         */
        public Builder setData(List data) {
            this.data = DomainUtils.softCopyList(data);
            return this;
        }

        /**
         * Sets category.
         *
         * @param category category
         * @return this instance
         */
        public Builder setCategory(String category) {
            this.category = category;
            return this;
        }

        /**
         * Builds the result object.
         *
         * @return created object
         */
        public DataCategoyPair build() {
            return new DataCategoyPair(this);
        }
    }

    /**
     * Log record.
     */
    private List data;

    /**
     * Category.
     */
    private String category;

    /**
     * Creates new instance.
     *
     * @param builder builder object
     */
    public DataCategoyPair(Builder builder) {
        data = DomainUtils.softCopyUnmodifiableList(builder.data);
        category = builder.category;
        guardInvariants();
    }

    /**
     * Guards this object to be consistent. Throws exception if this is not the case.
     */
    private void guardInvariants() {
        ValidationUtils.guardNotNullCollection(data, "data cannot have null element");
        ValidationUtils.guardNotNull(category, "category cannot be null");
    }

    /**
     * Returns data.
     *
     * @return data
     */
    public List getData() {
        return data;
    }

    /**
     * Returns category.
     *
     * @return category
     */
    public String getCategory() {
        return category;
    }

    @Override
    public int hashCode() {
        return HashCodeBuilder.reflectionHashCode(this);
    }

    @Override
    public boolean equals(Object obj) {
        return EqualsBuilder.reflectionEquals(this, obj);
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this);
    }

    /**
     * Shortcut to create new instance.
     *
     * @param data data
     * @param category
     * @return created object
     */
    public static DataCategoyPair create(List data, String category) {
        return new DataCategoyPair.Builder().
                setData(data).
                setCategory(category).
                build();
    }

}