package OurApplication;

import logging.LogElement;
import visualizationElements.Edge;
import visualizationElements.Vertex;

/**
 * This class extends logging.LogElement to provide additional functionality
 * for logging various elements related to graph visualization.
 *
 * @see LogElement
 */
public class OurLogElement extends LogElement {

	/** The sum up value associated with this log element. */
	protected long value;
	protected Vertex vertex;
	protected Edge edge;
	protected visualizationElements.Graph ourGraph;

	/**
	 * Standard constructor.
	 * Initializes the log element with default values.
	 */
	public OurLogElement() {
		super();
		this.value = 0;
	}

	/**
	 * Extended constructor.
	 * Initializes the log element with specified step number, description, sum up value, and vertex.
	 *
	 * @param step        the step number of the log element
	 * @param description the description of the log element
	 * @param value       the sum up value associated with the log element
	 * @param vertex      the vertex associated with the log element
	 */
	public OurLogElement(int step, String description, long value, Vertex vertex) {
		this.step = step;
		this.description = description;
		this.value = value;
		this.vertex = vertex;
	}

	/**
	 * Extended constructor.
	 * Initializes the log element with specified step number, description, sum up value, and edge.
	 *
	 * @param step        the step number of the log element
	 * @param description the description of the log element
	 * @param value       the sum up value associated with the log element
	 * @param edge        the edge associated with the log element
	 */
	public OurLogElement(int step, String description, long value, Edge edge) {
		this.step = step;
		this.description = description;
		this.value = value;
		this.edge = edge;
	}

	/**
	 * Extended constructor.
	 * Initializes the log element with specified step number, description, sum up value, and graph.
	 *
	 * @param step        the step number of the log element
	 * @param description the description of the log element
	 * @param value       the sum up value associated with the log element
	 * @param ourGraph    the graph associated with the log element
	 */
	public OurLogElement(int step, String description, long value, visualizationElements.Graph ourGraph) {
		this.step = step;
		this.description = description;
		this.value = value;
		this.ourGraph = ourGraph;
	}

	/**
	 * Retrieves the sum up value associated with this log element.
	 *
	 * @return the sum up value of the log element
	 */
	public long getValue() {
		return this.value;
	}

	/**
	 * Retrieves the edge associated with this log element.
	 *
	 * @return the edge associated with the log element
	 */
	public Edge getEdge() {
		return this.edge;
	}

	/**
	 * Retrieves the vertex associated with this log element.
	 *
	 * @return the vertex associated with the log element
	 */
	public Vertex getVertex() {
		return this.vertex;
	}

	/**
	 * Retrieves the graph associated with this log element.
	 *
	 * @return the graph associated with the log element
	 */
	public visualizationElements.Graph getGraph() {
		return this.ourGraph;
	}
}