| /******************************************************************************* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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.ofbiz.minilang.method.entityops; |
| |
| import org.ofbiz.base.util.Debug; |
| import org.ofbiz.base.util.GeneralException; |
| import org.ofbiz.entity.Delegator; |
| import org.ofbiz.entity.finder.ByConditionFinder; |
| import org.ofbiz.minilang.MiniLangException; |
| import org.ofbiz.minilang.MiniLangValidate; |
| import org.ofbiz.minilang.SimpleMethod; |
| import org.ofbiz.minilang.artifact.ArtifactInfoContext; |
| import org.ofbiz.minilang.method.MethodContext; |
| import org.w3c.dom.Element; |
| |
| /** |
| * Implements the <entity-condition> element. |
| * |
| * @see <a href="https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{%3Centitycondition%3E}}">Mini-language Reference</a> |
| */ |
| public final class EntityCondition extends EntityOperation { |
| |
| public static final String module = EntityCondition.class.getName(); |
| |
| private final ByConditionFinder finder; |
| |
| public EntityCondition(Element element, SimpleMethod simpleMethod) throws MiniLangException { |
| super(element, simpleMethod); |
| if (MiniLangValidate.validationOn()) { |
| MiniLangValidate.attributeNames(simpleMethod, element, "entity-name", "use-cache", "filter-by-date", "list", "distinct", "delegator-name"); |
| MiniLangValidate.requiredAttributes(simpleMethod, element, "entity-name", "list"); |
| MiniLangValidate.expressionAttributes(simpleMethod, element, "list", "delegator-name"); |
| MiniLangValidate.childElements(simpleMethod, element, "condition-expr", "condition-list", "condition-object", "having-condition-list", "select-field", "order-by", "limit-range", "limit-view", "use-iterator"); |
| MiniLangValidate.requireAnyChildElement(simpleMethod, element, "condition-expr", "condition-list", "condition-object"); |
| } |
| this.finder = new ByConditionFinder(element); |
| } |
| |
| @Override |
| public boolean exec(MethodContext methodContext) throws MiniLangException { |
| try { |
| Delegator delegator = getDelegator(methodContext); |
| finder.runFind(methodContext.getEnvMap(), delegator); |
| } catch (GeneralException e) { |
| String errMsg = "Exception thrown while performing entity find: " + e.getMessage(); |
| Debug.logWarning(e, errMsg, module); |
| simpleMethod.addErrorMessage(methodContext, errMsg); |
| return false; |
| } |
| return true; |
| } |
| |
| @Override |
| public void gatherArtifactInfo(ArtifactInfoContext aic) { |
| aic.addEntityName(this.finder.getEntityName()); |
| } |
| |
| @Override |
| public String toString() { |
| StringBuilder sb = new StringBuilder("<entity-condition "); |
| sb.append("entity-name=\"").append(this.finder.getEntityName()).append("\" />"); |
| return sb.toString(); |
| } |
| |
| public static final class EntityConditionFactory implements Factory<EntityCondition> { |
| @Override |
| public EntityCondition createMethodOperation(Element element, SimpleMethod simpleMethod) throws MiniLangException { |
| return new EntityCondition(element, simpleMethod); |
| } |
| |
| @Override |
| public String getName() { |
| return "entity-condition"; |
| } |
| } |
| } |