KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > ofbiz > minilang > method > entityops > GetRelatedOne


1 /*
2  * $Id: GetRelatedOne.java 5462 2005-08-05 18:35:48Z jonesde $
3  *
4  * Copyright (c) 2001-2005 The Open For Business Project - www.ofbiz.org
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included
14  * in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
21  * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 package org.ofbiz.minilang.method.entityops;
25
26 import org.ofbiz.base.util.Debug;
27 import org.ofbiz.entity.GenericEntityException;
28 import org.ofbiz.entity.GenericValue;
29 import org.ofbiz.minilang.SimpleMethod;
30 import org.ofbiz.minilang.method.ContextAccessor;
31 import org.ofbiz.minilang.method.MethodContext;
32 import org.ofbiz.minilang.method.MethodOperation;
33 import org.w3c.dom.Element JavaDoc;
34
35 /**
36  * Gets a list of related entity instance according to the specified relation-name
37  *
38  * @author <a HREF="mailto:jonesde@ofbiz.org">David E. Jones</a>
39  * @version $Rev: 5462 $
40  * @since 2.0
41  */
42 public class GetRelatedOne extends MethodOperation {
43     
44     public static final String JavaDoc module = GetRelatedOne.class.getName();
45     
46     ContextAccessor valueAcsr;
47     ContextAccessor toValueAcsr;
48     String JavaDoc relationName;
49     String JavaDoc useCacheStr;
50
51     public GetRelatedOne(Element JavaDoc element, SimpleMethod simpleMethod) {
52         super(element, simpleMethod);
53         valueAcsr = new ContextAccessor(element.getAttribute("value-name"));
54         toValueAcsr = new ContextAccessor(element.getAttribute("to-value-name"));
55         relationName = element.getAttribute("relation-name");
56         useCacheStr = element.getAttribute("use-cache");
57     }
58
59     public boolean exec(MethodContext methodContext) {
60         String JavaDoc relationName = methodContext.expandString(this.relationName);
61         String JavaDoc useCacheStr = methodContext.expandString(this.useCacheStr);
62         boolean useCache = "true".equals(useCacheStr);
63
64         Object JavaDoc valueObject = valueAcsr.get(methodContext);
65         if (!(valueObject instanceof GenericValue)) {
66             String JavaDoc errMsg = "ERROR: Could not complete the " + simpleMethod.getShortDescription() + " process [env variable for value-name " + valueAcsr.toString() + " is not a GenericValue object; for the relation-name: " + relationName + "]";
67             Debug.logError(errMsg, module);
68             methodContext.setErrorReturn(errMsg, simpleMethod);
69             return false;
70         }
71         GenericValue value = (GenericValue) valueObject;
72         if (value == null) {
73             Debug.logWarning("Value not found with name: " + valueAcsr + ", not getting related...", module);
74             return true;
75         }
76         try {
77             if (useCache) {
78                 toValueAcsr.put(methodContext, value.getRelatedOneCache(relationName));
79             } else {
80                 toValueAcsr.put(methodContext, value.getRelatedOne(relationName));
81             }
82         } catch (GenericEntityException e) {
83             String JavaDoc errMsg = "ERROR: Could not complete the " + simpleMethod.getShortDescription() + " process [problem getting related one from entity with name " + value.getEntityName() + " for the relation-name: " + relationName + ": " + e.getMessage() + "]";
84             Debug.logError(e, errMsg, module);
85             methodContext.setErrorReturn(errMsg, simpleMethod);
86             return false;
87         }
88         return true;
89     }
90
91     public String JavaDoc rawString() {
92         // TODO: something more than the empty tag
93 return "<get-related-one/>";
94     }
95     public String JavaDoc expandedString(MethodContext methodContext) {
96         // TODO: something more than a stub/dummy
97 return this.rawString();
98     }
99 }
100
Popular Tags