EntityResourceWrapperXHTML.java

package com.temenos.interaction.media.xhtml;

/*
 * #%L
 * interaction-media-xhtml
 * %%
 * Copyright (C) 2012 - 2013 Temenos Holdings N.V.
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */


import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import com.temenos.interaction.core.entity.EntityMetadata;
import com.temenos.interaction.core.entity.EntityProperties;
import com.temenos.interaction.core.entity.EntityProperty;
import com.temenos.interaction.core.hypermedia.Link;
import com.temenos.interaction.core.media.EntityResourceWrapper;
import com.temenos.interaction.core.resource.EntityResource;

/**
 * XHTML entity resource wrapper classes which exposes a link to itself. 
 */
public class EntityResourceWrapperXHTML extends EntityResourceWrapper {
	private Set<String> entityPropertyNames = null;
	private EntityMetadata entityMetadata;

	public EntityResourceWrapperXHTML(EntityMetadata entityMetadata, EntityResource<Map<String, Object>> entityResource) {
		super(entityResource);
		this.entityMetadata = entityMetadata;
		if(entityMetadata == null) {
			throw new RuntimeException("Failed to obtain metadata for entity [" + entityResource.getEntityName() + "]");
		}
	}	
	
	public EntityResourceWrapperXHTML(EntityMetadata entityMetadata, Set<String> entityPropertyNames, EntityResource<Map<String, Object>> entityResource) {
		super(entityResource);
		this.entityPropertyNames = entityPropertyNames;
		this.entityMetadata = entityMetadata;
		if(entityMetadata == null) {
			throw new RuntimeException("Failed to obtain metadata for entity [" + entityResource.getEntityName() + "]");
		}
	}	

	/**
	 * Obtains an xhtml string describing an entity resource as as a map <dl>...</dl>
	 * @return xhtml string
	 */
	public String getEntityResourceString() {
		//Get entity data
		String s = "<dl>";
		Map<String, Object> data = getResource().getEntity();
		for(String key : data.keySet()) {
			s += getEntityResourceMapString(new EntityProperty(key, data.get(key)));
		}
		s += "</dl>";
		
		//Get entity links
		s += "<ul>";
		for(Link link : getResource().getLinks()) {
			s += "<li><a href=\"" + link.getHref() + "\" rel=\"" + link.getRel() + "\">" + link.getTitle() + "</a></li>";
		}
		s += "</ul>";
		
		return s;
	}
	
	private String getEntityResourceMapString(EntityProperty entityProperty) {
		String name = entityProperty.getName();
		Object value = entityProperty.getValue();
		String s = "<dt>" + name + "</dt>";
		if(value instanceof EntityProperties) {
			s += "<dl>";
			for(EntityProperty prop : ((EntityProperties) value).getProperties().values()) {
				s += getEntityResourceMapString(prop);
			}
			s += "</dl>";
		}
		else {
			s += "<dd>" + entityMetadata.getPropertyValueAsString(entityProperty.getFullyQualifiedName(), value) + "</dd>";
		}
		return s;
	}
	
	public String getEntityGetHRef() {
		return entityGetLink != null ? entityGetLink.getHref().replaceAll("'", "\\\\'") : "";
	}
	
	/**
	 * Returns the entity's property values as strings and in the same order
	 * as specified in the constructor's entityPropertyNames parameter.
	 * @return list of properties
	 */
	public List<String> getEntityProperties() {
		List<String> entityProperties = new ArrayList<String>();
		if(entityPropertyNames != null) {
			for(String entityPropertyName : entityPropertyNames) {
				Map<String, Object> data = getResource().getEntity();
				Object value = data.get(entityMetadata.getSimplePropertyName(entityPropertyName));
				if(value != null && !value.getClass().equals(EntityProperties.class)) {
					entityProperties.add(entityMetadata.getPropertyValueAsString(entityPropertyName, value));
				}
				else {
					entityProperties.add(new String(""));
				}
			}
		}
		return entityProperties;
	}
	
	/**
	 * Returns the entity properties as a map of property name and value pairs.
	 * @return properties
	 */
	public Map<String, Object> getEntityPropertyMap() {
		Map<String, Object> entityProperties = new HashMap<String, Object>();
		for(Entry<String, Object> entry : getResource().getEntity().entrySet()) {
			String name = entry.getKey();
			Object value = entry.getValue();
			if(value != null && value.getClass().equals(EntityProperties.class)) {
				entityProperties.put(name, value);
			}
			else {
				entityProperties.put(name, entityMetadata.getPropertyValueAsString(name, value));
			}
		}
		return entityProperties;
	}
}