org.geomajas.rendering.GraphicsDocument Maven / Gradle / Ivy

Go to download
/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2013 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the GNU Affero
 * General Public License. All contributions in this program are covered
 * by the Geomajas Contributors License Agreement. For full licensing
 * details, see LICENSE.txt in the project root.
 */
package org.geomajas.rendering;

import java.text.DecimalFormat;

import com.vividsolutions.jts.geom.Coordinate;


/**
 * 
 * Document interface (DOM) that supports serial writing.
 * 
 *
 * @author Jan De Moerloose
 */
public interface GraphicsDocument {

	/**
	 * Writes a text-node to the document.
	 *
	 * @param text The text to write into the text-node.
	 * @throws RenderException writing failed
	 */
	void writeTextNode(String text) throws RenderException;

	/**
	 * Writes a general object to the document, potentially as a child element
	 * of the last element written. Throws an exception if the object cannot be
	 * written.
	 *
	 * @param o object to write
	 * @param asChild when true, write as child element
	 * @throws RenderException the object cannot be written
	 */
	void writeObject(Object o, boolean asChild) throws RenderException;

	/**
	 * Close the last element.
	 *
	 * @throws RenderException closing the document failed.
	 */
	void closeElement() throws RenderException;

	/**
	 * Writes an XML element either as a child element of the last element
	 * written or as the next element. Make sure the current start tag is
	 * finished !
	 *
	 * @param name tag to write
	 * @param asChild when true, write as child element
	 * @throws RenderException write failed
	 */
	void writeElement(String name, boolean asChild) throws RenderException;

	/**
	 * Writes an attribute with the specified value. An element must be created
	 * first.
	 *
	 * @param name name of attribute
	 * @param value value of attribute
	 * @throws RenderException write failed
	 */
	void writeAttribute(String name, double value) throws RenderException;

	/**
	 * Writes an attribute with the specified value. An element must be created
	 * first.
	 *
	 * @param name name of attribute
	 * @param value value of attribute
	 * @throws RenderException write failed
	 */
	void writeAttribute(String name, String value) throws RenderException;

	/**
	 * Write the start part of an attribute up to the opening value quote. The
	 * value should be written after this quote by calling other methods.
	 *
	 * @param name attribute name
	 * @throws RenderException write failed
	 */
	void writeAttributeStart(String name) throws RenderException;

	/**
	 * Writes the closing value quote of an attribute.
	 *
	 * @throws RenderException write failed
	 */
	void writeAttributeEnd() throws RenderException;

	/**
	 * Write the content of the d attribute in a path element.
	 *
	 * @param coordinates coordinates
	 * @throws RenderException write failed
	 */
	void writePathContent(Coordinate[] coordinates) throws RenderException;

	/**
	 * Write an array of coordinates as a closing "d" attribute of an path
	 * element.
	 *
	 * @param coordinates coordinates
	 * @throws RenderException write failed
	 */
	void writeClosedPathContent(Coordinate[] coordinates) throws RenderException;

	/**
	 * Write the remaining state if any. Closes elements if needed.
	 *
	 * @throws RenderException write failed
	 */
	void flush() throws RenderException;

	/**
	 * Set the maximum number of digits after the fraction. This can be
	 * important to save memory in the resulting string, when many floating
	 * point numbers have to be written.
	 *
	 * @param numDigits maximum number of fraction digits
	 */
	void setMaximumFractionDigits(int numDigits);

	/**
	 * Where there is a maximum, there is a minimum (no?). Usually defaults to
	 * 0.
	 *
	 * @param numDigits minimum number of fraction digits
	 */
	void setMinimumFractionDigits(int numDigits);

	/**
	 * Adds an id attribute to the last element written using a '.' to
	 * concatenate the current id prefix with the specified id.
	 *
	 * @param id id attribute to add
	 * @throws RenderException write failed
	 */
	void writeId(String id) throws RenderException;

	/**
	 * Set the id of the id prefix of the first element written.
	 *
	 * @param id root id
	 */
	void setRootId(String id);

	/**
	 * Return the coordinate formatter.
	 *
	 * @return decimal formatter
	 */
	DecimalFormat getFormatter();

	/**
	 * Return the current id.
	 *
	 * @return current id
	 */
	String getCurrentId();
}