///////////////////////////////////////////////////////////////////////////
//                   __                _      _   ________               //
//                  / /   ____  ____ _(_)____/ | / / ____/               //
//                 / /   / __ \/ __ `/ / ___/  |/ / / __                 //
//                / /___/ /_/ / /_/ / / /__/ /|  / /_/ /                 //
//               /_____/\____/\__, /_/\___/_/ |_/\____/                  //
//                           /____/                                      //
//                                                                       //
//               The Next Generation Logic Library                       //
//                                                                       //
///////////////////////////////////////////////////////////////////////////
//                                                                       //
//  Copyright 2015-20xx Christoph Zengler                                //
//                                                                       //
//  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.logicng.io.graphical;

import java.util.Objects;

/**
 * A single node in a graphical representation of a formula, BDD, or graph.  A node holds a unique ID, a label,
 * a flag whether this is a terminal node or not, and a node style.
 * @version 2.4.0
 * @since 2.4.0
 */
public class GraphicalNode {
    private final String id;
    private final String label;
    private final boolean terminal;
    private final GraphicalNodeStyle style;

    /**
     * Constructs a new non-terminal graphical node with the given values.
     * @param id    the unique ID
     * @param label the label
     * @param style the style of the node
     */
    public GraphicalNode(final String id, final String label, final GraphicalNodeStyle style) {
        this(id, label, false, style);
    }

    /**
     * Constructs a new graphical node with the given values.
     * @param id       the unique ID
     * @param label    the label
     * @param terminal whether it is a terminal node or not
     * @param style    the style of the node
     */
    public GraphicalNode(final String id, final String label, final boolean terminal, final GraphicalNodeStyle style) {
        this.id = id;
        this.label = label;
        this.terminal = terminal;
        this.style = style;
    }

    /**
     * Returns the id of this node.
     * @return the if of this node
     */
    public String getId() {
        return this.id;
    }

    /**
     * Returns the label of this node.
     * @return the label of this node
     */
    public String getLabel() {
        return this.label;
    }

    /**
     * Returns whether this node is a terminal.
     * @return {@code true} if this node is a terminal, otherwise {@code false}
     */
    public boolean isTerminal() {
        return this.terminal;
    }

    /**
     * Returns the style of this node.
     * @return the style of this node
     */
    public GraphicalNodeStyle getStyle() {
        return this.style;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        final GraphicalNode that = (GraphicalNode) o;
        return this.terminal == that.terminal &&
                Objects.equals(this.id, that.id) &&
                Objects.equals(this.label, that.label) &&
                Objects.equals(this.style, that.style);
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.id, this.label, this.terminal, this.style);
    }

    @Override
    public String toString() {
        return "GraphicalNode{" +
                "id='" + this.id + '\'' +
                ", label='" + this.label + '\'' +
                ", terminal=" + this.terminal +
                ", style=" + this.style +
                '}';
    }
}
