com.github.easydoc.model.Doc Maven / Gradle / Ivy

Go to download
package com.github.easydoc.model;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * An easydoc documentation entry (the one within 
 * easydoc-start and easydoc-end tags).
 * This is called a "doc".
 * 
 * @author Viktor Kazakov ([email protected])
 *
 */
public class Doc implements Comparable, Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * A doc body items.
	 */
	private List items = new ArrayList();
	
	/**
	 * A raw params of this doc.
	 * 
	 * TODO: for now, we put the parse results in the model.
	 * This is wrong. We should use some other entities for that.
	 * The model shouldn't be in the transient state.
	 */
	private Map params = new HashMap();
	
	/**
	 * A user-defined id.
	 * This can be used afterwards to reference this doc. 
	 */
	private String id;
	
	/**
	 * A parent doc for this doc (if present).
	 */
	private Doc parent;
	
	/**
	 * A child docs for this doc.
	 */
	private List children = new ArrayList();
	
	/**
	 * A link to the source file, where this doc originates.
	 */
	private SourceLink sourceLink;
	
	/**
	 * A doc's weight. The higher the weight, the lower this 
	 * doc will be among the siblings.
	 */
	private Integer weight;
	
	private List directives = Collections.emptyList();

	public String getText() {
		StringBuilder sb = new StringBuilder();
		for(DocItem item : items) {
			sb.append(item.getText());
		}
		return sb.toString();
	}
	
	public void setText(String text) {
		setItems(
				Collections.singletonList(
						(DocItem)new DocTextItem(
								text
						)
				)
		);
	}

	public void setItems(List items) {
		this.items = items;
	}
	
	public Map getParams() {
		return params;
	}

	public void setParams(Map params) {
		this.params = params;
	}

	public String getId() {
		return id;
	}

	public void setId(String id) {
		this.id = id;
	}

	public Doc getParent() {
		return parent;
	}

	public void setParent(Doc parent) {
		this.parent = parent;
	}
	
	public List getChildren() {
		return children;
	}
	
	public void addChild(Doc child) {
		children.add(child);
	}

	public SourceLink getSourceLink() {
		return sourceLink;
	}

	public void setSourceLink(SourceLink sourceLink) {
		this.sourceLink = sourceLink;
	}

	public Integer getWeight() {
		return weight;
	}

	public void setWeight(Integer weight) {
		this.weight = weight;
	}

	public List getDirectives() {
		return directives;
	}

	public void setDirectives(List directives) {
		this.directives = directives;
	}
	
	public boolean hasChildrenWithIds() {
		for(Doc doc : children) {
			if(doc.getId() != null) return true;
		}
		return false;
	}

	@Override
	public String toString() {
		return String.format("Doc [text=%s, params=%s, id=%s, parent=%s, sourceLink=%s, weight=%d]", 
				items, params, id,
				(parent != null ? parent.getId() : null), sourceLink, weight);
	}
	
	public Object toShortString() {
		return String.format("Doc [params=%s, id=%s, parent=%s, sourceLink=%s, weight=%d]", 
				params, id,
				(parent != null ? parent.getId() : null), sourceLink, weight);
	}

	@Override
	public int compareTo(Doc doc) {
		Integer thisWeight = (weight != null ? weight : 0);
		return thisWeight.compareTo(doc.getWeight() != null ? doc.getWeight() : 0);
	}
}