View Javadoc
1   /*
2    * Copyright 2001-2008 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   */
17  
18  package org.apache.juddi.query;
19  
20  import java.util.List;
21  
22  import javax.persistence.EntityManager;
23  
24  import org.apache.juddi.query.util.DynamicQuery;
25  import org.apache.juddi.query.util.FindQualifiers;
26  import org.uddi.api_v3.CategoryBag;
27  
28  /**
29   * Returns the list of binding keys possessing the keyedReferenceGroups in the passed category bag.
30   * Output is restricted by list of binding keys passed in.  If null, all binding templates are searched.
31   * Output is produced by building the appropriate JPA query based on input and find qualifiers.
32   * 
33   * From specification:
34   * "This optional argument is a list of category references in the form of keyedReference elements and keyedReferenceGroup 
35   * structures.  When used, the returned bindingDetail for this API will contain elements matching all of the categories 
36   * passed (logical AND by default).   Specifying the appropriate findQualifiers can override this behavior.
37   * 
38   * A given keyedReferenceGroup "X" (e.g., within a given categoryBag) matches a keyedReferenceGroup "Y" in the registry if 
39   * and only if the tModelKey assigned to the keyedReferenceGroup X matches the tModelKey assigned to the keyedReferenceGroup 
40   * Y and the set of keyedReferences in "X" are a subset of the set of keyedReferences in "Y."  The order of individual 
41   * keyedReferences within a keyedReferenceGroup is not important. Matching rules for the individual contained keyedReference 
42   * elements are the same as above."
43   * 
44   * @author <a href="mailto:jfaath@apache.org">Jeff Faath</a>
45   */
46  public class FindBindingByCategoryGroupQuery {
47  	
48  	private static final String ENTITY_NAME_CHILD = "BindingCategoryBag";
49  	
50  	private static final FindEntityByCategoryGroupQuery findQuery;
51  	
52  	static {
53  		findQuery = new FindEntityByCategoryGroupQuery(BindingTemplateQuery.ENTITY_NAME, 
54  													   BindingTemplateQuery.ENTITY_ALIAS, 
55  													   BindingTemplateQuery.KEY_NAME, 
56  													   BindingTemplateQuery.ENTITY_FIELD, 
57  													   ENTITY_NAME_CHILD,
58  													   BindingTemplateQuery.SIGNATURE_PRESENT);
59  	}
60  	
61  	public static List<Object> select(EntityManager em, FindQualifiers fq, CategoryBag categoryBag, String parentKey, List<Object> keysIn) {
62  		if (parentKey != null && parentKey.length() > 0) {
63  			DynamicQuery.Parameter param = new DynamicQuery.Parameter(BindingTemplateQuery.ENTITY_ALIAS + "." + BindingTemplateQuery.KEY_NAME_PARENT, parentKey, DynamicQuery.PREDICATE_EQUALS); 
64  			return findQuery.select(em, fq, categoryBag, keysIn, param);
65  		}
66  		else
67  			return findQuery.select(em, fq, categoryBag, keysIn);
68  	}
69  }