de.unirostock.sems.bives.markup.MarkupElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of BiVeS-Core Show documentation
BiVeS - BioModel Version Control System This package provides core functionality
The newest version!
/**
 * 
 */
package de.unirostock.sems.bives.markup;

import java.util.ArrayList;
import java.util.List;



/**
 * The Class MarkupElement representing an element in a MarkupDocument.
 *
 * @author Martin Scharm
 */
public class MarkupElement
{
	
	/** The header. */
	private String							header;
	
	/** The list of entries in this element. */
	private List				values;
	
	/** The list of sub-elements. */
	private List	subElements;
	
	/**
	 * are there modifications, which cannot be displayed in this markup document?
	 */
	private boolean							invisibleModifications;
	
	
	/**
	 * Instantiates a new markup element.
	 *
	 * @param header
	 *          the header
	 */
	public MarkupElement (String header)
	{
		this.header = header;
		values = new ArrayList ();
		subElements = new ArrayList ();
		invisibleModifications = false;
	}
	
	
	/**
	 * Set a flag indicating that this element has modifications which are not
	 * visible in the markup document.
	 */
	public void flagInvisibleModification ()
	{
		invisibleModifications = true;
	}
	
	
	/**
	 * Does this element have modifications which are not visible in the markup
	 * document?.
	 *
	 * @return true, if the are invisible modifications
	 */
	public boolean hasInvisibleModifications ()
	{
		return invisibleModifications;
	}
	
	
	/**
	 * Does this element have modifications which are not visible in the markup
	 * document?.
	 *
	 * @param invisibleModifications
	 *          the flag for invisible modifications
	 * @return true, if the are invisible modifications
	 */
	public boolean setInvisibleModifications (boolean invisibleModifications)
	{
		this.invisibleModifications = invisibleModifications;
		return this.invisibleModifications;
	}
	
	
	/**
	 * Adds an entry to this element.
	 *
	 * @param value
	 *          the entry
	 */
	public void addValue (String value)
	{
		if (value != null)
			values.add (value);
	}
	
	
	/**
	 * Adds a sub-element.
	 *
	 * @param element
	 *          the element
	 */
	public void addSubElements (MarkupElement element)
	{
		if (element != null)
			subElements.add (element);
	}
	
	
	/**
	 * Sets the header.
	 *
	 * @param header
	 *          the new header
	 */
	public void setHeader (String header)
	{
		this.header = header;
	}
	
	
	/**
	 * Gets the header.
	 *
	 * @return the header
	 */
	public String getHeader ()
	{
		return header;
	}
	
	
	/**
	 * Gets the entries stored in this element.
	 *
	 * @return the entries
	 */
	public List getValues ()
	{
		return values;
	}
	
	
	/**
	 * Gets the sub-elements.
	 *
	 * @return the sub-elements
	 */
	public List getSubElements ()
	{
		return subElements;
	}
}