/*
    * Copyright 2001-2008 The Apache Software Foundation.
    * 
    * 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 org.apache.juddi.query;
  
  import java.util.List;
  
  import javax.persistence.EntityManager;
  
  import org.apache.juddi.query.util.DynamicQuery;
  import org.apache.juddi.query.util.FindQualifiers;
  import org.uddi.api_v3.CategoryBag;
  
  /**
   * Returns the list of binding keys possessing the keyedReferences in the passed category bag.
   * Output is restricted by list of binding keys passed in.  If null, all binding templates are searched.
   * Output is produced by building the appropriate JPA query based on input and find qualifiers.
   * 
   * From specification:
   * "This optional argument is a list of category references in the form of keyedReference elements and keyedReferenceGroup
   *  structures.  When used, the returned bindingDetail for this API will contain elements matching all of the categories 
   *  passed (logical AND by default).   Specifying the appropriate findQualifiers can override this behavior."
   * 
   * @author <a href="mailto:jfaath@apache.org">Jeff Faath</a>
   */
  public class FindBindingByCategoryQuery {
  	
  	private static final String ENTITY_NAME_CHILD = "BindingCategoryBag";
  	
  	private static final FindEntityByCategoryQuery findQuery;
  	
  	static {
  		findQuery = new FindEntityByCategoryQuery(BindingTemplateQuery.ENTITY_NAME, 
  												  BindingTemplateQuery.ENTITY_ALIAS, 
  												  BindingTemplateQuery.KEY_NAME, 
  												  BindingTemplateQuery.ENTITY_FIELD, 
  												  ENTITY_NAME_CHILD,
  												  BindingTemplateQuery.SIGNATURE_PRESENT);
  	}
  	
  	public static List<Object> select(EntityManager em, FindQualifiers fq, CategoryBag categoryBag, String parentKey, List<Object> keysIn) {
  		if (parentKey != null && parentKey.length() > 0) {
  			DynamicQuery.Parameter param = new DynamicQuery.Parameter(BindingTemplateQuery.ENTITY_ALIAS + "." + BindingTemplateQuery.KEY_NAME_PARENT, parentKey, DynamicQuery.PREDICATE_EQUALS); 
  			return findQuery.select(em, fq, categoryBag, keysIn, param);
  		}
  		else
  			return findQuery.select(em, fq, categoryBag, keysIn);
  	}
  }