edu.cmu.tetradapp.model.TetradMetadata 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;

import edu.cmu.tetrad.util.TetradLogger;
import edu.cmu.tetrad.util.TetradSerializable;
import edu.cmu.tetrad.util.TetradSerializableUtils;
import edu.cmu.tetrad.util.Version;
import edu.cmu.tetradapp.util.TetradMetadataIndirectRef;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serial;
import java.util.Date;

/**
 * Represents the Tetrad session that is serialized oud loaded back in. Basically, it's a SessionWrapper with metadata.
 * These fields have been encapsulated into their own class so that more metadata fields can be added in the future
 * without disturbing serialization. It must be the case that metadata can load even if the SessionWrapper cannot load.
 *
 * @author josephramsey
 * @version $Id: $Id
 */
public class TetradMetadata
        implements TetradSerializable, TetradMetadataIndirectRef {
    @Serial
    private static final long serialVersionUID = 23L;

    /**
     * The version of Tetrad that saved this session out.
     *
     * @serial Cannot be null.
     */
    private final Version version;

    /**
     * The date and time this Tetrad session was created.
     *
     * @serial Cannot be null.
     */
    private final Date date;

    //===========================CONSTRUCTORS=============================//

    /**
     * Constructor for TetradMetadata.
     */
    public TetradMetadata() {
        try {
            this.version = Version.currentViewableVersion();
        } catch (Exception e) {
            throw new RuntimeException("Can't retrive the current version of this tetrad release.");
        }

        this.date = new Date();
    }

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

    //==========================PUBLIC METHODS===========================//

    /**
     * Getter for the field version.
     *
     * @return a {@link edu.cmu.tetrad.util.Version} object
     */
    public Version getVersion() {
        return this.version;
    }

    /**
     * Getter for the field date.
     *
     * @return a {@link java.util.Date} object
     */
    public Date getDate() {
        return this.date;
    }

    //============================PRIVATE METHODS=======================//

    /**
     * Writes the object to the specified ObjectOutputStream.
     *
     * @param out The ObjectOutputStream to write the object to.
     * @throws IOException If an I/O error occurs.
     */
    @Serial
    private void writeObject(ObjectOutputStream out) throws IOException {
        try {
            out.defaultWriteObject();
        } catch (IOException e) {
            TetradLogger.getInstance().log("Failed to serialize object: " + getClass().getCanonicalName()
                                           + ", " + e.getMessage());
            throw e;
        }
    }

    /**
     * Reads the object from the specified ObjectInputStream. This method is used during deserialization
     * to restore the state of the object.
     *
     * @param in The ObjectInputStream to read the object from.
     * @throws IOException            If an I/O error occurs.
     * @throws ClassNotFoundException If the class of the serialized object cannot be found.
     */
    @Serial
    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        try {
            in.defaultReadObject();
        } catch (IOException e) {
            TetradLogger.getInstance().log("Failed to deserialize object: " + getClass().getCanonicalName()
                                           + ", " + e.getMessage());
            throw e;
        }
    }
}