/*
 * © Copyright IBM Corp. 2013
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at:
 * 
 * http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 
 * implied. See the License for the specific language governing 
 * permissions and limitations under the License.
 */

package com.ibm.sbt.services.client.connections.forums.model;

import static com.ibm.sbt.services.client.base.ConnectionsConstants.nameSpaceCtx;

import java.util.ArrayList;
import java.util.List;

import org.w3c.dom.Node;

import com.ibm.commons.util.StringUtil;
import com.ibm.commons.xml.NamespaceContext;
import com.ibm.commons.xml.xpath.XPathExpression;
import com.ibm.sbt.services.client.base.AtomEntity;
import com.ibm.sbt.services.client.base.AtomXPath;
import com.ibm.sbt.services.client.base.BaseService;
import com.ibm.sbt.services.client.base.datahandlers.XmlDataHandler;
import com.ibm.sbt.services.client.connections.common.Person;
import com.ibm.sbt.services.client.connections.forums.ForumService;
import com.ibm.sbt.services.client.connections.forums.ForumsXPath;

/**
 * Base model object to be used with Forums, Topics and Replies
 * 
 * @author Manish Kataria 
 */


public class BaseForumEntity extends AtomEntity {

	private final String FORUMID = "urn:lsid:ibm.com:forum:";

	/**
	 * Constructor
	 *  
	 * @param forumsService
	 * @param id
	 */
	public BaseForumEntity(ForumService forumsService, String id) {
		super(forumsService,id);
		setService(forumsService);
		setAsString(ForumsXPath.uid, id);
	}
	/**
     * Constructor
     * @param forumsService ForumService
     */
    public BaseForumEntity(ForumService forumsService) {
            super(forumsService);
            setService(forumsService);
    }
    
    
	/**
     * Constructor
     * @param service BaseService
     * @param node Node
     * @param namespaceCtx NamespaceContext
     * @param xpathExpression XPathExpression
     */
	public BaseForumEntity(BaseService service, Node node, NamespaceContext namespaceCtx, XPathExpression xpathExpression) {
		super(service, node, namespaceCtx, xpathExpression);
	}
	
	public BaseForumEntity(){}


	/**
    * To get Uuid of Forum Entity
	*
	* @method getUid
	* @return String
	*/ 
	public String getUid(){
		String id = getAsString(ForumsXPath.uid);
		if(StringUtil.isNotEmpty(id)){
			if(StringUtil.startsWithIgnoreCase(id, FORUMID)){
				id = id.substring(FORUMID.length());
			}
		}
		return id;
	}

	@Override
	public Person getAuthor(){
		return new Person(getService(),new XmlDataHandler((Node)getDataHandler().getData(), 
	    		nameSpaceCtx, (XPathExpression)AtomXPath.author.getPath()));
	}

	@Override
	public Person getContributor(){
		return new Person(getService(), new XmlDataHandler((Node)getDataHandler().getData(), 
	    		nameSpaceCtx, (XPathExpression)AtomXPath.contributor.getPath()));
	}

	/**
	 * sets the tags
	 */
	public void setTags(List<String> tags) {
		super.setBaseTags(tags);
	}

	/**
	 * sets the tags
	 */
	@Deprecated
	public void setTags(String tags) {
		List<String> tagsList = new ArrayList<String>();
		tagsList.add(tags);
		setTags(tagsList);
	}

	public List<String> getTags() {
		return super.getBaseTags();
	}
	
	@Override
	public ForumService getService(){
		return (ForumService)super.getService();
	}

	@Override
	public XmlDataHandler getDataHandler(){
		return (XmlDataHandler)super.getDataHandler();
	}

	/*
	 * Method used to extract the forum uuid for an id string.
	 */
	public String extractForumUuid(String uid) {
		if (StringUtil.isNotEmpty(uid) && StringUtil.startsWithIgnoreCase(uid, FORUMID)) {
			return uid.substring(FORUMID.length());
		} else {
			return uid;
		}
	}; 

}