edu.cmu.tetradapp.model.datamanip.ConcatenateDatasetsWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tetrad-gui Show documentation
The newest version!
///////////////////////////////////////////////////////////////////////////////
// For information as to what this class does, see the Javadoc, below.       //
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,       //
// 2007, 2008, 2009, 2010, 2014, 2015, 2022 by Peter Spirtes, Richard        //
// Scheines, Joseph Ramsey, and Clark Glymour.                               //
//                                                                           //
// This program is free software; you can redistribute it and/or modify      //
// it under the terms of the GNU General Public License as published by      //
// the Free Software Foundation; either version 2 of the License, or         //
// (at your option) any later version.                                       //
//                                                                           //
// This program 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 General Public License for more details.                              //
//                                                                           //
// You should have received a copy of the GNU General Public License         //
// along with this program; if not, write to the Free Software               //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA //
///////////////////////////////////////////////////////////////////////////////
package edu.cmu.tetradapp.model.datamanip;

import edu.cmu.tetrad.data.DataModel;
import edu.cmu.tetrad.data.DataSet;
import edu.cmu.tetrad.data.LogDataUtils;
import edu.cmu.tetrad.util.MultidataUtils;
import edu.cmu.tetrad.util.Parameters;
import edu.cmu.tetrad.util.TetradSerializableUtils;
import edu.cmu.tetradapp.model.DataWrapper;
import edu.cmu.tetradapp.model.PcRunner;

import java.util.LinkedList;
import java.util.List;

/**
 * Tyler was lazy and didn't document this....
 *
 * @author Tyler Gibson
 * @version $Id: $Id
 */
public class ConcatenateDatasetsWrapper extends DataWrapper {

    private static final long serialVersionUID = 23L;

    /**
     * Constructor for ConcatenateDatasetsWrapper.
     *
     * @param data   an array of {@link edu.cmu.tetradapp.model.DataWrapper} objects
     * @param params a {@link edu.cmu.tetrad.util.Parameters} object
     */
    public ConcatenateDatasetsWrapper(DataWrapper[] data, Parameters params) {
        construct(data);
    }

    /**
     * Generates a simple exemplar of this class to test serialization.
     *
     * @return a {@link edu.cmu.tetradapp.model.PcRunner} object
     * @see TetradSerializableUtils
     */
    public static PcRunner serializableInstance() {
        return PcRunner.serializableInstance();
    }

    private void construct(DataWrapper... dataWrappers) {
        for (DataWrapper wrapper : dataWrappers) {
            if (wrapper == null) {
                throw new NullPointerException("The given data must not be null");
            }
        }

        List dataModels = new LinkedList<>();
        for (DataWrapper wrapper : dataWrappers) {
            wrapper.getDataModelList().forEach(dataModel -> {
                if (dataModel instanceof DataSet) {
                    dataModels.add(dataModel);
                } else {
                    throw new IllegalArgumentException("Sorry, I am only willing to concatenate tabular datasets.");
                }
            });
        }

        DataModel dataModel = MultidataUtils.combineDataset(dataModels);
        dataModel.setName("Concatenated");
        this.setDataModel(dataModel);

        LogDataUtils.logDataModelList("Parent data in which constant columns have been removed.", getDataModelList());

    }
}