java/alt2xml-out-xpath/src/cz/frantovo/alt2xml/out/xpath/XPathAction.java
author František Kučera <franta-hg@frantovo.cz>
Thu, 04 Sep 2014 18:33:34 +0200
changeset 72 4ba54a632eb8
parent 71 75556166817a
child 79 3581fe8cd4fe
permissions -rw-r--r--
out-xpath: support parameter types: [STRING, BOOLEAN, INTEGER, LONG, DOUBLE]
     1 /**
     2  * Alt2XML
     3  * Copyright © 2014 František Kučera (frantovo.cz)
     4  *
     5  * This program is free software: you can redistribute it and/or modify
     6  * it under the terms of the GNU General Public License as published by
     7  * the Free Software Foundation, either version 3 of the License, or
     8  * (at your option) any later version.
     9  *
    10  * This program is distributed in the hope that it will be useful,
    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    13  * GNU General Public License for more details.
    14  *
    15  * You should have received a copy of the GNU General Public License
    16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
    17  */
    18 package cz.frantovo.alt2xml.out.xpath;
    19 
    20 import cz.frantovo.alt2xml.out.AbstractDOMAction;
    21 import cz.frantovo.alt2xml.out.ActionContext;
    22 import cz.frantovo.alt2xml.out.OutputActionException;
    23 import java.io.PrintWriter;
    24 import java.util.Arrays;
    25 import java.util.HashMap;
    26 import java.util.List;
    27 import java.util.Map;
    28 import javax.xml.transform.dom.DOMResult;
    29 import javax.xml.xpath.XPath;
    30 import javax.xml.xpath.XPathExpression;
    31 import javax.xml.xpath.XPathExpressionException;
    32 import javax.xml.xpath.XPathFactory;
    33 
    34 /**
    35  *
    36  * @author Ing. František Kučera (frantovo.cz)
    37  */
    38 public class XPathAction extends AbstractDOMAction {
    39 
    40 	public static final String PARAMETER_TYPED_PARAMETERS = "typed-parameters";
    41 	private final XPathFactory xpathFactory;
    42 	private final XPath xpath;
    43 	private final String expressionString;
    44 	private final XPathExpression xpathExpression;
    45 
    46 	public XPathAction(ActionContext actionContext) throws OutputActionException {
    47 		super(actionContext);
    48 		xpathFactory = XPathFactory.newInstance();
    49 		xpath = xpathFactory.newXPath();
    50 
    51 		final List<String> actionData = getActionContext().getActionData();
    52 
    53 		if (actionData.size() < 1) {
    54 			throw new OutputActionException("Please specify the XPath expression as action data");
    55 		} else {
    56 
    57 			boolean typedParameters = Boolean.parseBoolean(actionContext.getActionProperties().getProperty(PARAMETER_TYPED_PARAMETERS));
    58 
    59 			Map<String, Object> xpathParameters = new HashMap<>();
    60 
    61 			for (int i = 1; i < actionData.size(); i++) {
    62 				String parameterName = actionData.get(i++);
    63 				String parameterType = typedParameters ? actionData.get(i++) : PARAMETER_TYPE.STRING.name();
    64 				Object parameterValue = parseParameterValue(parameterType, actionData.get(i));
    65 				xpathParameters.put(parameterName, parameterValue);
    66 			}
    67 
    68 			xpath.setXPathVariableResolver(new PropertiesVariableResolver(xpathParameters));
    69 
    70 			expressionString = actionData.get(0);
    71 			try {
    72 				xpathExpression = xpath.compile(expressionString);
    73 			} catch (XPathExpressionException e) {
    74 				throw new OutputActionException("Unable to compile XPath: " + expressionString, e);
    75 			}
    76 
    77 		}
    78 	}
    79 
    80 	private enum PARAMETER_TYPE {
    81 
    82 		// TODO: wait for Java 8 widespread and rewrite with lambdas :-)
    83 		STRING {
    84 					@Override
    85 					public Object parse(String value) {
    86 						return value;
    87 					}
    88 				},
    89 		BOOLEAN {
    90 					@Override
    91 					public Object parse(String value) {
    92 						return Boolean.valueOf(value);
    93 					}
    94 				},
    95 		INTEGER {
    96 					@Override
    97 					public Object parse(String value) {
    98 						return Integer.parseInt(value);
    99 					}
   100 				},
   101 		LONG {
   102 					@Override
   103 					public Object parse(String value) {
   104 						return Long.parseLong(value);
   105 					}
   106 				},
   107 		DOUBLE {
   108 					@Override
   109 					public Object parse(String value) {
   110 						return Double.parseDouble(value);
   111 					}
   112 				};
   113 
   114 		public abstract Object parse(String value);
   115 
   116 	}
   117 
   118 	private static Object parseParameterValue(String type, String value) throws OutputActionException {
   119 
   120 		try {
   121 			PARAMETER_TYPE parameterType = PARAMETER_TYPE.valueOf(type.toUpperCase());
   122 
   123 			try {
   124 				return parameterType.parse(value);
   125 			} catch (IllegalArgumentException e) {
   126 				throw new OutputActionException("Unable to parse value: „" + value + "“ as " + parameterType.name());
   127 			}
   128 		} catch (IllegalArgumentException e) {
   129 			throw new OutputActionException(
   130 					"Invalid XPath parameter type: „" + type
   131 					+ "“. Possible values are: " + Arrays.toString(PARAMETER_TYPE.values())
   132 					+ " and are case insensitive.",
   133 					e);
   134 		}
   135 	}
   136 
   137 	@Override
   138 	public void run(DOMResult domResult) throws OutputActionException {
   139 		try {
   140 			String result = xpathExpression.evaluate(domResult.getNode());
   141 			try (PrintWriter out = new PrintWriter(getActionContext().getOutputStream())) {
   142 				out.println(result);
   143 			}
   144 		} catch (XPathExpressionException e) {
   145 			throw new OutputActionException("Unable to evaluate XPath: " + xpathExpression, e);
   146 		}
   147 	}
   148 }