| /******************************************************************************* |
| * 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.envops; |
| |
| import java.util.ArrayList; |
| import java.util.Collections; |
| import java.util.List; |
| import java.util.Map; |
| |
| import org.ofbiz.base.util.UtilXml; |
| import org.ofbiz.base.util.collections.FlexibleMapAccessor; |
| import org.ofbiz.base.util.collections.MapComparator; |
| import org.ofbiz.minilang.MiniLangException; |
| import org.ofbiz.minilang.MiniLangRuntimeException; |
| import org.ofbiz.minilang.MiniLangValidate; |
| import org.ofbiz.minilang.SimpleMethod; |
| import org.ofbiz.minilang.method.MethodContext; |
| import org.ofbiz.minilang.method.MethodOperation; |
| import org.w3c.dom.Element; |
| |
| /** |
| * Implements the <order-map-list> element. |
| * |
| * @see <a href="https://cwiki.apache.org/OFBADMIN/mini-language-reference.html#Mini-languageReference-{{%3Cordermaplist%3E}}">Mini-language Reference</a> |
| */ |
| public final class OrderMapList extends MethodOperation { |
| |
| private final FlexibleMapAccessor<List<Map<Object, Object>>> listFma; |
| private final MapComparator mc; |
| |
| public OrderMapList(Element element, SimpleMethod simpleMethod) throws MiniLangException { |
| super(element, simpleMethod); |
| if (MiniLangValidate.validationOn()) { |
| MiniLangValidate.attributeNames(simpleMethod, element, "list"); |
| MiniLangValidate.requiredAttributes(simpleMethod, element, "list"); |
| MiniLangValidate.expressionAttributes(simpleMethod, element, "list"); |
| MiniLangValidate.childElements(simpleMethod, element, "order-by"); |
| MiniLangValidate.requiredChildElements(simpleMethod, element, "order-by"); |
| } |
| listFma = FlexibleMapAccessor.getInstance(element.getAttribute("list")); |
| List<? extends Element> orderByElements = UtilXml.childElementList(element, "order-by"); |
| if (orderByElements.size() > 0) { |
| ArrayList<FlexibleMapAccessor<String>> orderByList = new ArrayList<FlexibleMapAccessor<String>>(orderByElements.size()); |
| for (Element orderByElement : orderByElements) { |
| FlexibleMapAccessor<String> fma = FlexibleMapAccessor.getInstance(orderByElement.getAttribute("field")); |
| orderByList.add(fma); |
| } |
| mc = new MapComparator(orderByList); |
| } else { |
| mc = null; |
| } |
| } |
| |
| @Override |
| public boolean exec(MethodContext methodContext) throws MiniLangException { |
| if (mc == null) { |
| throw new MiniLangRuntimeException("order-by sub-elements not found.", this); |
| } |
| List<Map<Object, Object>> orderList = listFma.get(methodContext.getEnvMap()); |
| if (orderList != null) { |
| Collections.sort(orderList, mc); |
| } |
| return true; |
| } |
| |
| @Override |
| public String toString() { |
| StringBuilder sb = new StringBuilder("<order-map-list "); |
| sb.append("list=\"").append(this.listFma).append("\" />"); |
| return sb.toString(); |
| } |
| |
| /** |
| * A factory for the <order-map-list> element. |
| */ |
| public static final class OrderMapListFactory implements Factory<OrderMapList> { |
| @Override |
| public OrderMapList createMethodOperation(Element element, SimpleMethod simpleMethod) throws MiniLangException { |
| return new OrderMapList(element, simpleMethod); |
| } |
| |
| @Override |
| public String getName() { |
| return "order-map-list"; |
| } |
| } |
| } |