Code Snippets

Thought this might be of use to others and save them a lot of time hunting around for ages.

Two pages of commonly required functionality in Velocity, JSP, and java tag library.

Feel free to show me a better way as I'm new at this

Great work, GrahamButcher!

I am thinking that we should put all user generated documents like this in one place.

Thought I'd share this as I found it useful, in case anybody else might find it useful. As I'm a noob to java etc, I don't know how robust it is and I'm sure its very messy and could be made more efficient, but it seems to be working for me. Have tried it on versions 2.9.9.2 and the developer bundle (2.9.6 I think)

Background:
The infoglue tag, structure:childPages, didn't give me all I wanted. So I created my own version.

This childPages tag does the same as the structure:childPagess Tag but with extra properties in the returned list of pages and some different attributes. It will also recurse down a sitenode tree for as many levels as you specify as opposed to the 1 of structure:childContents.

Properties

The properties that each node has in the returned list are the same as those for the SiteNodeVO class plus these extra ones:

depth - The sub level depth of this node in relation to the start node
levelWidth - The maximum depth of all nodes in this collection - depth of this node + 1. So if the start node has just one sub node under it, then the start node will have a depth of 0 and a levelWidth of 2. The sub node will have a depth of 1 and a levelWidth of 1
navigationTitle - The value of the site nodes navigation title attribute
url - The URL of the site node.
firstChild - True if this is the first child of each level.
lastChild - True if this is the last child of each level.
childNumber - The number of the child. Zero is the first child in each level.
anyChildren - True if there are any sub nodes to this node.
depthDifference - The difference in depth between this node and the next one. If this node is depth 3 and the next is depth 4 then the difference will be -1

Some important differences between structure:childPages and this tag:

* This tag does not support the following attributes:
o propertyName (too complicated to figure out how to do it - could be added later)
o useInheritance
o useRepositoryInheritance
o useStructureInheritance
* This tag returns the start node as well as the child nodes.
* This tag will do any number of sub levels.
* This tag sorts the returned site nodes.
* This tag returns all the properties of a SiteNodeVO object.
* This tag does not return contentId and languageId properties in its returned site nodes.

Notes:

The start node in the returned list has an empty string for the navigation title and the url. This needs to be added, but haven't figured out how to do it yet.

Example

And finally, the source code:

The bit for the tld file:

<tag>
		<name>childPages</name>
		<tagclass>org.infoglue.deliver.taglib.wmfs.ChildPagesTag</tagclass>
		<bodycontent>empty</bodycontent>
		<info></info>
		<attribute>
			<name>startSiteNodeId</name>
			<required>true</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		<attribute>
			<name>id</name>
			<required>true</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		<attribute>
			<name>levels</name>
			<required>false</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		<attribute>
			<name>sortAttribute</name>
			<required>false</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		<attribute>
			<name>sortOrder</name>
			<required>false</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		<attribute>
			<name>escapeHTML</name>
			<required>false</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		<attribute>
			<name>hideUnauthorizedPages</name>
			<required>false</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
	</tag>

The class that encapsulates SiteNodeVO and adds some more properties:

package wmfs;

import java.util.Date;
import java.util.Map;

import org.infoglue.cms.entities.structure.SiteNodeVO;
import org.infoglue.cms.util.ConstraintExceptionBuffer;

public class WMFSWebPage
{
	private int depth, levelWidth, childNumber, childCount, index, parentIndex, depthDifference;
	private String url, navigationTitle;
	private boolean firstChild, lastChild;
	private SiteNodeVO snvo;

public WMFSWebPage() {
		initWMFSWebPage();
		this.snvo = new SiteNodeVO();
	}

public WMFSWebPage(SiteNodeVO snvo) {
		initWMFSWebPage();
		this.snvo = snvo;
	}

private void initWMFSWebPage()
	{
		this.depth = 0;
		this.depthDifference = 0;
		this.url = "";
		this.navigationTitle = "";
		this.firstChild = false;
		this.lastChild = false;
		this.childCount = 0;
	}
	
	public int getChildNumber() {
		return this.childNumber;
	}

public void setChildNumber(int childNumber) {
		this.childNumber = childNumber;
	}

public int getIndex() {
		return this.index;
	}

public void setIndex(int index) {
		this.index = index;
	}

public int getParentIndex() {
		return this.parentIndex;
	}

public void setParentIndex(int parentIndex) {
		this.parentIndex = parentIndex;
	}

public boolean isAnyChildren() {
		return this.childCount>0;
	}

public int getChildCount() {
		return this.childCount;
	}

public void setChildCount(int childCount) {
		this.childCount = childCount;
	}

public int getDepth()
	{
		return this.depth;
	}

public void setDepth(int depth)
	{
		this.depth = depth;
	}

public int getDepthDifference()
	{
		return this.depthDifference;
	}

public void setDepthDifference(int depthDifference)
	{
		this.depthDifference = depthDifference;
	}

public int getLevelWidth() {
		return this.levelWidth;
	}

public void setLevelWidth(int levelWidth) {
		this.levelWidth = levelWidth;
	}

public void setUrl(String url) {
		this.url = url;
	}

public String getUrl() {
		return url;
	}

public String getNavigationTitle() {
		return navigationTitle;
	}

public void setNavigationTitle(String navigationTitle) {
		this.navigationTitle = navigationTitle;
	}

public boolean isFirstChild() {
		return firstChild;
	}

public void setFirstChild(boolean firstChild) {
		this.firstChild = firstChild;
	}

public boolean isLastChild() {
		return lastChild;
	}

public void setLastChild(boolean lastChild) {
		this.lastChild = lastChild;
	}

public SiteNodeVO getSnvo() {
		return snvo;
	}

public void setSnvo(SiteNodeVO snvo) {
		this.snvo = snvo;
	}

public String getCreatorName() {
		return snvo.getCreatorName();
	}

public Date getExpireDateTime() {
		return snvo.getExpireDateTime();
	}

@SuppressWarnings("unchecked")
	public Map getExtraProperties() {
		return snvo.getExtraProperties();
	}

public Integer getId() {
		return snvo.getId();
	}

public Boolean getIsBranch() {
		return snvo.getIsBranch();
	}

public Integer getMetaInfoContentId() {
		return snvo.getMetaInfoContentId();
	}

public String getName() {
		return snvo.getName();
	}

public Integer getParentSiteNodeId() {
		return snvo.getParentSiteNodeId();
	}

public Date getPublishDateTime() {
		return snvo.getPublishDateTime();
	}

public Integer getRepositoryId() {
		return snvo.getRepositoryId();
	}

public Integer getSiteNodeId() {
		return snvo.getSiteNodeId();
	}

public Integer getSiteNodeTypeDefinitionId() {
		return snvo.getSiteNodeTypeDefinitionId();
	}

public void setCreatorName(String creatorName) {
		snvo.setCreatorName(creatorName);
	}

public void setExpireDateTime(Date expireDateTime) {
		snvo.setExpireDateTime(expireDateTime);
	}

public void setIsBranch(Boolean isBranch) {
		snvo.setIsBranch(isBranch);
	}

public void setMetaInfoContentId(Integer metaInfoContentId) {
		snvo.setMetaInfoContentId(metaInfoContentId);
	}

public void setName(String name) {
		snvo.setName(name);
	}

public void setParentSiteNodeId(Integer parentSiteNodeId) {
		snvo.setParentSiteNodeId(parentSiteNodeId);
	}

public void setPublishDateTime(Date publishDateTime) {
		snvo.setPublishDateTime(publishDateTime);
	}

public void setRepositoryId(Integer repositoryId) {
		snvo.setRepositoryId(repositoryId);
	}

public void setSiteNodeId(Integer siteNodeId) {
		snvo.setSiteNodeId(siteNodeId);
	}

public void setSiteNodeTypeDefinitionId(Integer siteNodeTypeDefinitionId) {
		snvo.setSiteNodeTypeDefinitionId(siteNodeTypeDefinitionId);
	}

public ConstraintExceptionBuffer validate() {
		return snvo.validate();
	}
}

And the actual tag code:

package org.infoglue.deliver.taglib.wmfs;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspTagException;

import org.apache.taglibs.standard.tag.el.core.ExpressionUtil;
import org.infoglue.cms.entities.structure.SiteNodeVO;
import org.infoglue.cms.util.sorters.PageComparator;
import org.infoglue.deliver.applications.databeans.WebPage;
import org.infoglue.deliver.controllers.kernel.impl.simple.TemplateController;
import org.infoglue.deliver.taglib.component.ComponentLogicTag;

import wmfs.WMFSWebPage;

public class ChildPagesTag extends ComponentLogicTag 
{
	private static final long serialVersionUID = 3483847042623445384L;

private int startSiteNodeId, maxLevels=1, maxDepth, nodeIndex;
	private String sortAttribute="navigationTitle", sortOrder="asc";
	private boolean escapeHTML=false, hideUnauthorizedPages=false;
	private TemplateController tc;

public int doEndTag() throws JspException
	{
		List<WMFSWebPage> siteNodes = new ArrayList<WMFSWebPage>();

tc = getController();

// populate the root node and add it to the list
		WMFSWebPage siteNode = new WMFSWebPage(tc.getSiteNode(this.startSiteNodeId));
		siteNode.setDepth(0);
		siteNode.setFirstChild(true);
		siteNode.setLastChild(true);
		siteNode.setChildNumber(0);
		siteNodes.add(siteNode);

this.maxDepth = 0;
		this.nodeIndex = 0;

// recursively add all the child nodes
		doChildNodes(this.startSiteNodeId, 1, 0, siteNodes);

// now that we have all the nodes, populate them with node relation data
		int numNodes = siteNodes.size();
		WMFSWebPage lastNode = siteNodes.get(numNodes-1);
		lastNode.setLastChild(true);
		lastNode.setDepthDifference(lastNode.getDepth());
		for (int i=0; i<numNodes; i++)
		{
			WMFSWebPage thisNode = siteNodes.get(i);
			thisNode.setLevelWidth(this.maxDepth - thisNode.getDepth() + 1);

if (i < numNodes-1)
			{
				WMFSWebPage nextNode = siteNodes.get(i+1);
				if (thisNode.getDepth() > nextNode.getDepth())
					thisNode.setLastChild(true);

thisNode.setDepthDifference(thisNode.getDepth() - nextNode.getDepth());
			}

if (i>0)
			{
				WMFSWebPage parentNode = siteNodes.get(thisNode.getParentIndex());
				int cc = parentNode.getChildCount() + 1;
				parentNode.setChildCount(cc);
			}
		}

setResultAttribute(siteNodes);

return EVAL_PAGE;
	}

@SuppressWarnings({"unchecked"})
	private void doChildNodes(int siteNodeId, int lvl, int parentIndex, List<WMFSWebPage> siteNodes) throws JspTagException
	{
		List<WebPage> childWebPages = tc.getChildPages(siteNodeId, this.escapeHTML, this.hideUnauthorizedPages);
		Comparator comparator = new PageComparator(this.sortAttribute, this.sortOrder, false, tc);
		Collections.sort(childWebPages, comparator);

Collection<SiteNodeVO> childSiteNodeVOs = tc.getSiteNodesFromWebPages(childWebPages);

int idx = 0;
		for (SiteNodeVO i : childSiteNodeVOs)
		{
			this.nodeIndex++;
			WMFSWebPage wwp = new WMFSWebPage(i);
			wwp.setDepth(lvl);
			wwp.setUrl(childWebPages.get(idx).getUrl());
			wwp.setNavigationTitle(childWebPages.get(idx).getNavigationTitle());
			wwp.setChildNumber(idx);
			wwp.setIndex(this.nodeIndex);
			wwp.setParentIndex(parentIndex);

if (idx == 0)
				wwp.setFirstChild(true);

siteNodes.add(wwp);

if (lvl > this.maxDepth)
				this.maxDepth = lvl;

if (lvl < this.maxLevels)
				doChildNodes(i.getSiteNodeId(), lvl+1, this.nodeIndex, siteNodes);
			idx++;
		}
	}

public void setStartSiteNodeId(String siteNodeId) throws JspException
	{
		this.startSiteNodeId = evaluateInteger("childPages", "startSiteNodeId", siteNodeId);
	}

public void setLevels(String s) throws JspException
	{
		this.maxLevels = evaluateInteger("childPages", "maxLevels", s);
	}

public void setSortAttribute(String s) throws JspException
	{
		this.sortAttribute = (String)ExpressionUtil.evalNotNull("childPages", "sortAttribute", s, String.class, this, pageContext);
	}

public void setSortOrder(String s) throws JspException
	{
		this.sortOrder = (String)ExpressionUtil.evalNotNull("childPages", "sortOrder", s, String.class, this, pageContext);
	}

public void setEscapeHTML(String s) throws JspException
	{
		String tmp = ((String)ExpressionUtil.evalNotNull("childPages", "escapeHTML", s, String.class, this, pageContext)).substring(0,1);
		this.escapeHTML = (tmp.equalsIgnoreCase("Y")||tmp.equalsIgnoreCase("T"))?true:false;
	}

public void setHideUnauthorizedPages(String s) throws JspException
	{
		String tmp = ((String)ExpressionUtil.evalNotNull("childPages", "hideUnauthorizedPages", s, String.class, this, pageContext)).substring(0,1);
		this.hideUnauthorizedPages = (tmp.equalsIgnoreCase("Y")||tmp.equalsIgnoreCase("T"))?true:false;
	}
}

Thanks for sharing!

Hi Graham.

If you wish please clone the Infoglue 3.0 repo in github, implement this in 3.0 and push changes back. This way your splendid tag will be part of the core.

Regards
Mattias Bogeblad