DocumentUpdate

/*
 * Copyright 2011 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl1.php
 *
 * 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 org.kuali.rice.kew.api.document;

import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAnyElement;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.kuali.rice.core.api.CoreConstants;
import org.kuali.rice.core.api.mo.ModelBuilder;
import org.kuali.rice.core.util.jaxb.MapStringStringAdapter;
import org.kuali.rice.kew.api.KewApiConstants;
import org.w3c.dom.Element;

/**
 * Defines an update to document content on a particular workflow document.
 * Contains general application content as well as a list of attribute
 * definitions and searchable definitions.  When passed to the appropriate
 * workflow services to perform an update on document content, if any of the
 * internal content or definitions on this object have not been set then they
 * will not be updated.  This allows for this data structure to be used to only
 * update the portion of the document content that is desired to be updated.
 *
 * @author Kuali Rice Team (rice.collab@kuali.org)
 *
 */
@XmlRootElement(name = DocumentUpdate.Constants.ROOT_ELEMENT_NAME)
@XmlAccessorType(XmlAccessType.NONE)
@XmlType(name = DocumentUpdate.Constants.TYPE_NAME, propOrder = {
	DocumentUpdate.Elements.TITLE,
    DocumentUpdate.Elements.APPLICATION_DOCUMENT_ID,
    DocumentUpdate.Elements.APPLICATION_DOCUMENT_STATUS,
    DocumentUpdate.Elements.VARIABLES,
    CoreConstants.CommonElements.FUTURE_ELEMENTS
})
public final class DocumentUpdate implements Serializable {

	private static final long serialVersionUID = 608839901744771499L;

	@XmlElement(name = Elements.TITLE, required = false)
	private final String title;

	@XmlElement(name = Elements.APPLICATION_DOCUMENT_ID, required = false)
	private final String applicationDocumentId;

	@XmlElement(name = Elements.APPLICATION_DOCUMENT_STATUS, required = false)
	private final String applicationDocumentStatus;

	@XmlElement(name = Elements.VARIABLES, required = false)
	@XmlJavaTypeAdapter(MapStringStringAdapter.class)
	private final Map<String, String> variables;

	@SuppressWarnings("unused")
    @XmlAnyElement
    private final Collection<Element> _futureElements = null;

	private DocumentUpdate() {
		this.title = null;
		this.applicationDocumentId = null;
		this.applicationDocumentStatus = null;
		this.variables = null;
	}

    private DocumentUpdate(Builder builder) {
    	this.title = builder.getTitle();
    	this.applicationDocumentId = builder.getApplicationDocumentId();
    	this.applicationDocumentStatus = builder.getApplicationDocumentStatus();
    	this.variables = builder.getVariables();
    }

	public String getTitle() {
		return title;
	}

	public String getApplicationDocumentId() {
		return applicationDocumentId;
	}

	public String getApplicationDocumentStatus() {
		return applicationDocumentStatus;
	}

	public Map<String, String> getVariables() {
		if (variables == null) {
			return Collections.emptyMap();
		}
		return Collections.unmodifiableMap(variables);
	}

	@Override
    public int hashCode() {
        return HashCodeBuilder.reflectionHashCode(this, Constants.HASH_CODE_EQUALS_EXCLUDE);
    }

    @Override
    public boolean equals(Object object) {
        return EqualsBuilder.reflectionEquals(object, this, Constants.HASH_CODE_EQUALS_EXCLUDE);
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this);
    }

	/**
	 * A builder which can be used to construct {@link DocumentUpdate} instances.
	 */
	public final static class Builder implements Serializable, ModelBuilder {

		private static final long serialVersionUID = 2220000561051177421L;

		private String title;
		private String applicationDocumentId;
		private String applicationDocumentStatus;
		private Map<String, String> variables;


		private Builder() {
			this.title = "";
			this.variables = new HashMap<String, String>();
		}

		public static Builder create() {
			return new Builder();
		}

		public static Builder create(Document document) {
			if (document == null) {
				throw new IllegalArgumentException("document was null");
			}
			Builder builder = create();
			builder.setTitle(document.getTitle());
			builder.setApplicationDocumentId(document.getApplicationDocumentId());
			builder.setApplicationDocumentStatus(document.getApplicationDocumentStatus());
			builder.setVariables(document.getVariables());
			return builder;
		}

		public DocumentUpdate build() {
			return new DocumentUpdate(this);
		}

		public String getTitle() {
			return title;
		}

		/**
		 * TODO: document the fact that this will auto-truncate the title...
		 */
		public void setTitle(String title) {
			if (title == null) {
				title = "";
			}
	        if (title.length() > KewApiConstants.TITLE_MAX_LENGTH) {
	            title = title.substring(0, KewApiConstants.TITLE_MAX_LENGTH);
	        }
			this.title = title;
		}

		public String getApplicationDocumentId() {
			return applicationDocumentId;
		}

		public void setApplicationDocumentId(String applicationDocumentId) {
			this.applicationDocumentId = applicationDocumentId;
		}

		public String getApplicationDocumentStatus() {
			return applicationDocumentStatus;
		}

		public void setApplicationDocumentStatus(String applicationDocumentStatus) {
			this.applicationDocumentStatus = applicationDocumentStatus;
		}

		public void setVariables(Map<String, String> variables) {
			if (variables == null) {
				this.variables = new HashMap<String, String>();
			} else {
				this.variables = new HashMap<String, String>(variables);
			}
		}

		public Map<String, String> getVariables() {
			return variables;
		}

		public String getVariableValue(String name) {
			return variables.get(name);
	    }

	    public void setVariable(String name, String value) {
	        if (StringUtils.isBlank(name)) {
	        	throw new IllegalArgumentException("name was null or blank");
	        }
	        variables.put(name, value);
	    }

	}

    /**
     * Defines some internal constants used on this class.
     */
    static class Constants {
        final static String ROOT_ELEMENT_NAME = "documentUpdate";
        final static String TYPE_NAME = "DocumentUpdateType";
        final static String[] HASH_CODE_EQUALS_EXCLUDE = new String[] { CoreConstants.CommonElements.FUTURE_ELEMENTS };
    }

    /**
     * A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.
     */
    static class Elements {
    	final static String TITLE = "title";
        final static String APPLICATION_DOCUMENT_ID = "applicationDocumentId";
        final static String APPLICATION_DOCUMENT_STATUS = "applicationDocumentStatus";
        final static String VARIABLES = "variables";
    }

}