/**
    * Copyright 2005-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/ecl2.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.search;
  
  import org.kuali.rice.core.api.CoreConstants;
  import org.kuali.rice.core.api.mo.AbstractDataTransferObject;
  import org.kuali.rice.core.api.mo.ModelBuilder;
  import org.kuali.rice.kew.api.document.Document;
  import org.kuali.rice.kew.api.document.attribute.DocumentAttribute;
  import org.kuali.rice.kew.api.document.attribute.DocumentAttributeContract;
  import org.kuali.rice.kew.api.document.attribute.DocumentAttributeFactory;
  import org.w3c.dom.Element;
  
  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.XmlElementWrapper;
  import javax.xml.bind.annotation.XmlRootElement;
  import javax.xml.bind.annotation.XmlType;
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.List;
  
  /**
   * An immutable data transfer object implementation of the {@link DocumentSearchResultContract}.  Instances of this
   * class should be constructed using the nested {@link Builder} class.
   *
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  @XmlRootElement(name = DocumentSearchResult.Constants.ROOT_ELEMENT_NAME)
  @XmlAccessorType(XmlAccessType.NONE)
  @XmlType(name = DocumentSearchResult.Constants.TYPE_NAME, propOrder = {
      DocumentSearchResult.Elements.DOCUMENT,
      DocumentSearchResult.Elements.DOCUMENT_ATTRIBUTES,
      CoreConstants.CommonElements.FUTURE_ELEMENTS
  })
  public final class DocumentSearchResult extends AbstractDataTransferObject implements DocumentSearchResultContract {
  
      @XmlElement(name = Elements.DOCUMENT, required = false)
      private final Document document;
  
      @XmlElementWrapper(name = Elements.DOCUMENT_ATTRIBUTES, required = true)
      @XmlElement(name = Elements.DOCUMENT_ATTRIBUTE, required = false)
      private final List<DocumentAttribute> documentAttributes;
  
      @SuppressWarnings("unused")
      @XmlAnyElement
      private final Collection<Element> _futureElements = null;
  
      /**
       * Private constructor used only by JAXB.
       */
      @SuppressWarnings("unused")
      private DocumentSearchResult() {
          this.document = null;
          this.documentAttributes = null;
      }
  
      private DocumentSearchResult(Builder builder) {
          this.document = builder.getDocument().build();
          List<DocumentAttribute> documentAttributes = new ArrayList<DocumentAttribute>();
          for (DocumentAttribute.AbstractBuilder<?> documentAttribute : builder.getDocumentAttributes()) {
              documentAttributes.add(documentAttribute.build());
          }
          this.documentAttributes = Collections.unmodifiableList(documentAttributes);
      }
  
      @Override
      public Document getDocument() {
          return this.document;
      }
  
      @Override
      public List<DocumentAttribute> getDocumentAttributes() {
          return this.documentAttributes;
      }
  
      /**
       * Returns an unmodifiable list of all document attributes on this result which have the given name.  It is legal
       * for a result to contain more than one attribute of the same name.  In these cases, this represents a document
       * attribute which has more than one value.
       *
       * @param attributeName the attribute name of document attributes to retrieve
      * @return an unmodifiable list of document attributes with the given name, will never be null but may be empty
      */
     public List<DocumentAttribute> getDocumentAttributeByName(String attributeName) {
         List<DocumentAttribute> namedAttributes = new ArrayList<DocumentAttribute>();
         for (DocumentAttribute attribute : getDocumentAttributes()) {
             if (attribute.getName().equals(attributeName)) {
                 namedAttributes.add(attribute);
             }
         }
         return Collections.unmodifiableList(namedAttributes);
     }
 
     /**
      * Returns a single document attribute from this result which has the given name.  If there is more than one
      * document attribute on this result with the given name, only a single one will be returned (though it is
      * undeterministic which one will this will be).  If there are no attributes on this result with the given name
      * then this method will return null.
      *
      * @param attributeName the attribute name of the document attribute to retrieve
      * @return a single document attribute with the given name, or null if one does not exist
      */
     public DocumentAttribute getSingleDocumentAttributeByName(String attributeName) {
         List<DocumentAttribute> namedAttributes = getDocumentAttributeByName(attributeName);
         if (namedAttributes.isEmpty()) {
             return null;
         }
         return namedAttributes.get(0);
     }
 
     /**
      * A builder which can be used to construct {@link DocumentSearchResult} instances.  Enforces the constraints of the
      * {@link DocumentSearchResultContract}.
      */
     public final static class Builder implements Serializable, ModelBuilder, DocumentSearchResultContract {
 
         private Document.Builder document;
         private List<DocumentAttribute.AbstractBuilder<?>> documentAttributes;
 
         private Builder(Document.Builder document) {
             setDocument(document);
             setDocumentAttributes(new ArrayList<DocumentAttribute.AbstractBuilder<?>>());
         }
 
         /**
          * Create a builder for the document search result and initialize it with the given document builder.
          * Additionally initializes the list of document attribute builders on the new instance to an empty list.
          *
          * @param document the document builder with which to initialize the returned builder instance
          *
          * @return a builder instance initialized with the given document builder
          *
          * @throws IllegalArgumentException if the given document builder is null
          */
         public static Builder create(Document.Builder document) {
             return new Builder(document);
         }
 
         /**
          * Creates a new builder instance initialized with copies of the properties from the given contract.
          *
          * @param contract the contract from which to copy properties
          *
          * @return a builder instance initialized with properties from the given contract
          *
          * @throws IllegalArgumentException if the given contract is null
          */
         public static Builder create(DocumentSearchResultContract contract) {
             if (contract == null) {
                 throw new IllegalArgumentException("contract was null");
             }
             Document.Builder documentBuilder = Document.Builder.create(contract.getDocument());
             Builder builder = create(documentBuilder);
             List<DocumentAttribute.AbstractBuilder<?>> documentAttributes = new ArrayList<DocumentAttribute.AbstractBuilder<?>>();
             for (DocumentAttributeContract documentAttributeContract : contract.getDocumentAttributes()) {
                 documentAttributes.add(DocumentAttributeFactory.loadContractIntoBuilder(documentAttributeContract));
             }
             builder.setDocumentAttributes(documentAttributes);
             return builder;
         }
 
         public DocumentSearchResult build() {
             return new DocumentSearchResult(this);
         }
 
         @Override
         public Document.Builder getDocument() {
             return this.document;
         }
 
         @Override
         public List<DocumentAttribute.AbstractBuilder<?>> getDocumentAttributes() {
             return this.documentAttributes;
         }
 
         public void setDocument(Document.Builder document) {
             if (document == null) {
                 throw new IllegalArgumentException("document was null");
             }
             this.document = document;
         }
 
         public void setDocumentAttributes(List<DocumentAttribute.AbstractBuilder<?>> documentAttributes) {
             this.documentAttributes = documentAttributes;
         }
 
     }
 
     /**
      * Defines some internal constants used on this class.
      */
     static class Constants {
         final static String ROOT_ELEMENT_NAME = "documentSearchResult";
         final static String TYPE_NAME = "DocumentSearchResultType";
     }
 
     /**
      * 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 DOCUMENT = "document";
         final static String DOCUMENT_ATTRIBUTES = "documentAttributes";
         final static String DOCUMENT_ATTRIBUTE = "documentAttribute";
     }
 
 }