org.javasimon.console.html.HtmlBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javasimon-console-embed Show documentation
There is a newer version: 4.2.0
Show newest version
package org.javasimon.console.html;

import org.javasimon.Simon;
import org.javasimon.console.SimonType;
import org.javasimon.console.reflect.Getter;
import org.javasimon.console.reflect.GetterFactory;
import org.javasimon.console.text.StringifierFactory;

import java.io.IOException;
import java.io.Writer;

/**
 * Class to ease HTML generation.
 *
 * @author gquintana
 */
public class HtmlBuilder {

	/** Delegate write. */
	private final Writer writer;
	/** Stringifier factory. */
	private final StringifierFactory stringifierFactory;

	/** Constructor without stringifier factory. */
	public HtmlBuilder(Writer writer) {
		this.writer = writer;
		this.stringifierFactory = null;
	}

	/** Constructor with stringifier factory. */
	public HtmlBuilder(Writer writer, StringifierFactory stringifierFactory) {
		this.writer = writer;
		this.stringifierFactory = stringifierFactory;
	}

	/**
	 * Begin an element without closing (no ending >).
	 *
	 * @param element tag name
	 * @param id element ID
	 * @param cssClass CSS class name
	 */
	private void doBegin(String element, String id, String cssClass) throws IOException {
		writer.write('<');
		writer.write(element);
		attr("id", id);
		attr("class", cssClass);
	}

	/**
	 * Add attribute.
	 *
	 * @param name Attribute name
	 * @param value Attribute value
	 */
	public T attr(String name, String value) throws IOException {
		if (value != null) {
			writer.write(' ');
			writer.write(name);
			writer.write("=\"");
			writer.write(value);
			writer.write('\"');
		}
		return (T) this;
	}

	/**
	 * Begin an element.
	 *
	 * @param element Tag name
	 * @param id Element Id
	 * @param cssClass CSS class name
	 */
	public T begin(String element, String id, String cssClass) throws IOException {
		doBegin(element, id, cssClass);
		writer.write('>');
		return (T) this;
	}

	/**
	 * Begin an element.
	 */
	public T begin(String element) throws IOException {
		return begin(element, null, null);
	}

	/**
	 * Simple element.
	 *
	 * @param element Tag name
	 * @param id Element Id
	 * @param cssClass CSS class name
	 */
	public T element(String element, String id, String cssClass) throws IOException {
		doBegin(element, id, cssClass);
		writer.write(" />");
		return (T) this;
	}

	/**
	 * End an element.
	 *
	 * @param element Tag name
	 */
	public T end(String element) throws IOException {
		writer.write("');
		return (T) this;
	}

	/**
	 * Writes text.
	 *
	 * @param text Text (can be null)
	 */
	public T text(String text) throws IOException {
		if (text != null) {
			writer.write(text);
		}
		return (T) this;
	}

	/**
	 * Writes verbatim.
	 *
	 * @param text Text
	 */
	public T write(String text) throws IOException {
		writer.write(text);
		return (T) this;
	}

	/**
	 * Adds a CSS StyleSheet link.
	 */
	private T cssResource(String path) throws IOException {
		return (T) write("");
	}

	private T resources(Iterable resources) throws IOException {
		// Write CSS Resources
		cssResource("css/javasimon.css");
		for (HtmlResource resource : resources) {
			if (resource.getType() == HtmlResourceType.CSS) {
				cssResource(resource.getPath());
			}
		}
		// Write JavaScript Resources
		for (HtmlResource resource : resources) {
			if (resource.getType() == HtmlResourceType.JS) {
				write("");
			}
		}
		return (T) this;
	}

	/**
	 * Page header.
	 *
	 * @param title Page title
	 */
	public T header(String title, Iterable resources) throws IOException {
		return (T) begin("html")
			.begin("head")
			.begin("title").text("Simon Console: ").text(title).end("title")
			.resources(resources)
			.end("head")
			.begin("body")
			.begin("h1")
			.write("")
			.text("Simon Console: ").text(title)
			.end("h1");
	}

	/**
	 * Page footer.
	 */
	public T footer() throws IOException {
		return (T) end("body").end("html");
	}

	/**
	 * Write value using appropriate stringifier.
	 *
	 * @param value Typed value
	 * @param subType Sub type
	 */
	public  T value(X value, String subType) throws IOException {
		return text(stringifierFactory.toString(value, subType));
	}

	/**
	 * Write Simon property (using Java Bean convention).
	 *
	 * @param simon Simon
	 * @param propertyName Property name
	 */
	public T simonProperty(Simon simon, String propertyName) throws IOException {
		Getter getter = GetterFactory.getGetter(simon.getClass(), propertyName);
		if (getter != null) {
			value(getter.get(simon), getter.getSubType());
		}
		return (T) this;
	}

	/**
	 * Apply stringifier on object and write it.
	 *
	 * @param object Object
	 */
	public T object(Object object) throws IOException {
		text(stringifierFactory.toString(object));
		return (T) this;
	}

	/**
	 * Icon image representing Simon Type.
	 *
	 * @param simonType Simon Type
	 * @param rootPath Path to root of Simon Console resources
	 */
	public T simonTypeImg(SimonType simonType, String rootPath) throws IOException {
		String image = null;
		switch (simonType) {
			case COUNTER:
				image = "TypeCounter.png";
				break;
			case STOPWATCH:
				image = "TypeStopwatch.png";
				break;
			case UNKNOWN:
				image = "TypeUnknown.png";
				break;
		}
		String label = simonType.name().toLowerCase();
		doBegin("img", null, label + " icon");
		attr("src", rootPath + "resource/images/" + image);
		attr("alt", label);
		writer.write(" />");
		return (T) this;
	}
}