Spring/spring-integration-extensions
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4 from amolnayak311/INTEXT-14

Browse Source 
* amolnayak311-INTEXT-14:
  INTEXT-14: Fix some of the code compliance issues in the XQuery module
This commit is contained in:
Gunnar Hillert
2012-08-20 17:02:18 -04:00
parent aa0e80f022 72ba2bcc56
commit 0d61dc2da3
9 changed files with 120 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
spring-integration-xquery/src/main/java/org/springframework/integration/xquery/config/xml/XQueryParserUtils.java
View File

@@ -39,11 +39,18 @@ import org.w3c.dom.NodeList;
* etc.
*
* @author Amol Nayak
*
* @since 2.2
*
*/
public class XQueryParserUtils {
private XQueryParserUtils() {
//prevent instantiation
}
/**
* Create the instance of the {@link XQueryExecutor}
* @param element
@@ -54,6 +61,69 @@ public class XQueryParserUtils {
IntegrationNamespaceUtils.setReferenceIfAttributeDefined(builder, element, "converter");
IntegrationNamespaceUtils.setReferenceIfAttributeDefined(builder, element, "xq-datasource","xQDataSource");
IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "format-output");
setXQueryInBuilder(element, builder);
//lets get the parameter nodes
setXQueryParameters(element, builder);
return builder.getBeanDefinition();
}
/**
* The provided xquery may have one or more 'xquery-parameter' child elements, this private helper method sets the parameters in
* the builder for {@link XQueryExecutor} being constructed
*
* @param element
* @param builder
*/
private static void setXQueryParameters(Element element,
BeanDefinitionBuilder builder) {
NodeList parameters = element.getElementsByTagNameNS(element.getNamespaceURI(), "xquery-parameter");
if(parameters != null && parameters.getLength() > 0) {
ManagedList<AbstractBeanDefinition> params = new ManagedList<AbstractBeanDefinition>();
for(int i = 0;i < parameters.getLength();i++) {
Node node = parameters.item(i);
NamedNodeMap attrs = node.getAttributes();
Assert.isTrue(attrs.getLength() > 1,
"One of ref, value or expression should be present with the name attribute");
Attr nameAttr = (Attr)attrs.getNamedItem("name");
//TODO No check for the mutually exclusivity of these attributes, needed?
//create a new XQueryParameter instance
BeanDefinitionBuilder paramBuilder =
BeanDefinitionBuilder.genericBeanDefinition(XQueryParameter.class);
paramBuilder.addConstructorArgValue(nameAttr.getTextContent());
Attr attr;
//add the value if present
if(attrs.getNamedItem("value") != null) {
attr = (Attr)attrs.getNamedItem("value");
paramBuilder.addPropertyValue("parameterValue",attr.getTextContent());
}
else if(attrs.getNamedItem("ref") != null) {
attr = (Attr)attrs.getNamedItem("ref");
paramBuilder.addPropertyReference("parameterValue", attr.getTextContent());
}
else if(attrs.getNamedItem("expression") != null) {
attr = (Attr)attrs.getNamedItem("expression");
paramBuilder.addPropertyValue("expression", attr.getTextContent());
}
params.add(paramBuilder.getBeanDefinition());
}
builder.addPropertyValue("xQueryParameters", params);
}
}
/**
* Private helper method that is used to set the xquery in the builder. The XQuery can be provided
* using wither the xquery attribute, xquery sub element or the resource containing the xquery.
* These attributes/child node are mutually exclusive to each other, the method checks for this mutual
* exclusivity and sets in the builder for {@link XQueryExecutor} the appripriate attribute.
*
* @param element
* @param builder
*/
private static void setXQueryInBuilder(Element element,
BeanDefinitionBuilder builder) {
NodeList list = element.getElementsByTagNameNS(element.getNamespaceURI(), "xquery");
Attr xQueryAttribute = element.getAttributeNode("xquery");
Attr xQueryResource = element.getAttributeNode("xquery-file-resource");
@@ -105,44 +175,5 @@ public class XQueryParserUtils {
builder.addPropertyValue("xQuery", textContent.trim());
}
}
//lets get the parameter nodes
NodeList parameters = element.getElementsByTagNameNS(element.getNamespaceURI(), "xquery-parameter");
if(parameters != null && parameters.getLength() > 0) {
ManagedList<AbstractBeanDefinition> params = new ManagedList<AbstractBeanDefinition>();
for(int i = 0;i < parameters.getLength();i++) {
Node node = parameters.item(i);
NamedNodeMap attrs = node.getAttributes();
Assert.isTrue(attrs.getLength() > 1,
"One of ref, value or expression should be present with the name attribute");
Attr nameAttr = (Attr)attrs.getNamedItem("name");
//TODO No check for the mutually exclusivity of these attributes, needed?
//create a new XQueryParameter instance
BeanDefinitionBuilder paramBuilder =
BeanDefinitionBuilder.genericBeanDefinition(XQueryParameter.class);
paramBuilder.addConstructorArgValue(nameAttr.getTextContent());
Attr attr;
//add the value if present
if(attrs.getNamedItem("value") != null) {
attr = (Attr)attrs.getNamedItem("value");
paramBuilder.addPropertyValue("parameterValue",attr.getTextContent());
}
else if(attrs.getNamedItem("ref") != null) {
attr = (Attr)attrs.getNamedItem("ref");
paramBuilder.addPropertyReference("parameterValue", attr.getTextContent());
}
else if(attrs.getNamedItem("expression") != null) {
attr = (Attr)attrs.getNamedItem("expression");
paramBuilder.addPropertyValue("expression", attr.getTextContent());
}
params.add(paramBuilder.getBeanDefinition());
}
builder.addPropertyValue("xQueryParameters", params);
}
return builder.getBeanDefinition();
}
}

2
spring-integration-xquery/src/main/java/org/springframework/integration/xquery/config/xml/XQueryTransformerParser.java
View File

@@ -74,7 +74,7 @@ public class XQueryTransformerParser extends AbstractTransformerParser {
try {
type = Class.forName(resultType);
} catch (ClassNotFoundException e) {
new IllegalArgumentException("Class " + resultType + " specified in result-type not found, " +
throw new IllegalArgumentException("Class " + resultType + " specified in result-type not found, " +
"have you provided the fully qualified name?",e);
}
}

13
spring-integration-xquery/src/main/java/org/springframework/integration/xquery/core/XQueryExecutor.java
View File

@@ -186,19 +186,19 @@ public class XQueryExecutor implements InitializingBean,BeanClassLoaderAware {
* @return the instantiated {@link XQDataSource}
*/
private XQDataSource discoverXQDataSource() {
Object xqDataSource = null;
Object dataSource = null;
try {
if(ClassUtils.isPresent(SAXON_XQ_DATASOURCE_CLASS, classLoader)) {
xqDataSource = Class.forName(SAXON_XQ_DATASOURCE_CLASS).newInstance();
dataSource = Class.forName(SAXON_XQ_DATASOURCE_CLASS).newInstance();
}
//For now its just Saxon we will discover, we can add other implementations here later
} catch (Exception e) {
throw new MessagingException("Unable to discover/instantiate an XQDataSource, " +
"see nested exception for details", e);
}
Assert.notNull(xqDataSource, "No XQDataSource provided nor any known implementation discovered in the classpath");
logger.info("Using \"" + xqDataSource.getClass() + "\" as the XQDataSource implementation");
return (XQDataSource)xqDataSource;
Assert.notNull(dataSource, "No XQDataSource provided nor any known implementation discovered in the classpath");
logger.info("Using \"" + dataSource.getClass() + "\" as the XQDataSource implementation");
return (XQDataSource)dataSource;
}
/**
@@ -444,8 +444,9 @@ public class XQueryExecutor implements InitializingBean,BeanClassLoaderAware {
*/
public void setXQueryParameters(List<XQueryParameter> params) {
if(params != null && params.size() > 0) {
if(xQueryParameterMap == null)
if(xQueryParameterMap == null) {
xQueryParameterMap = new HashMap<String, XQueryParameter>();
}
for(XQueryParameter param:params) {
xQueryParameterMap.put(param.getParameterName(), param);
}

12
spring-integration-xquery/src/main/java/org/springframework/integration/xquery/support/AbstractXQueryResultMapper.java
View File

@@ -58,7 +58,6 @@ import javax.xml.xquery.XQException;
import javax.xml.xquery.XQItemType;
import javax.xml.xquery.XQResultSequence;
import org.springframework.integration.xquery.support.XQueryResultMapper;
import org.springframework.util.StringUtils;
import org.w3c.dom.Attr;
import org.w3c.dom.Node;
@@ -71,7 +70,8 @@ import org.w3c.dom.Node;
*/
public abstract class AbstractXQueryResultMapper<T> implements XQueryResultMapper<T> {
protected volatile boolean formatOutput;
private volatile boolean formatOutput;
/**
* The getBaseType method throws an exception if the item kind is of some specific types
* This method will be used to check if the getBaseType method can be invoked or not
@@ -155,7 +155,7 @@ public abstract class AbstractXQueryResultMapper<T> implements XQueryResultMappe
Number value = null;
try {
if(StringUtils.hasText(strValue)) {
if(strValue.indexOf(".") > 0) {
if(strValue.indexOf('.') > 0) {
value = Double.valueOf(strValue);
}
else {
@@ -263,13 +263,13 @@ public abstract class AbstractXQueryResultMapper<T> implements XQueryResultMappe
* @throws TransformerException
*/
protected String transformNodeToString(Node n)
throws TransformerConfigurationException,
TransformerFactoryConfigurationError, TransformerException {
throws TransformerException {
String value;
StringWriter writer = new StringWriter();
Transformer transformer = TransformerFactory.newInstance().newTransformer();
if(formatOutput)
if(formatOutput) {
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
}
transformer.transform( new DOMSource(n), new StreamResult(writer));
value = writer.toString();
return value;

8
spring-integration-xquery/src/main/java/org/springframework/integration/xquery/support/BooleanResultMapper.java
View File

@@ -42,11 +42,9 @@ public class BooleanResultMapper extends AbstractXQueryResultMapper<Boolean> {
while(result.next()) {
XQItemType type = result.getItemType();
Boolean value = convertToBoolean(type, result);
if(value == null) {
if(isNodeType(type)) {
Node n = result.getNode();
value = Boolean.valueOf(transformNodeToString(n));
}
if(value == null && isNodeType(type)) {
Node n = result.getNode();
value = Boolean.valueOf(transformNodeToString(n));
}
results.add(value);
}

20
spring-integration-xquery/src/main/java/org/springframework/integration/xquery/support/NumberResultMapper.java
View File

@@ -42,17 +42,15 @@ public class NumberResultMapper extends AbstractXQueryResultMapper<Number> {
XQItemType type = result.getItemType();
Number value = convertToNumber(type, result);
if(value == null) {
if(isNodeType(type)) {
Node n = result.getNode();
String strValue = transformNodeToString(n);
if(StringUtils.hasText(strValue)) {
if(strValue.indexOf(".") > 0) {
value = Double.valueOf(strValue);
}
else {
value = Long.valueOf(strValue);
}
if(value == null && isNodeType(type)) {
Node n = result.getNode();
String strValue = transformNodeToString(n);
if(StringUtils.hasText(strValue)) {
if(strValue.indexOf('.') > 0) {
value = Double.valueOf(strValue);
}
else {
value = Long.valueOf(strValue);
}
}
}

2
spring-integration-xquery/src/main/java/org/springframework/integration/xquery/support/XQueryParameter.java
View File

@@ -99,7 +99,7 @@ public class XQueryParameter {
* Sets the expression that would be evaluated to get the parameter value
* @param expression
*/
public void setExpression(String expression) {
public final void setExpression(String expression) {
Assert.isTrue(parameterValue == null, "The parameter value and expression are mutually exclusive" +
", parameter value already set");
Assert.isTrue(!StringUtils.hasText(this.expression), "Expression string is already set once, cannot reset it");

23
spring-integration-xquery/src/main/java/org/springframework/integration/xquery/support/XQueryUtils.java
View File

@@ -21,6 +21,8 @@ import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.core.io.Resource;
import org.springframework.integration.MessagingException;
import org.springframework.util.Assert;
@@ -37,6 +39,16 @@ import org.springframework.util.Assert;
*/
public class XQueryUtils {
private static final Log logger = LogFactory.getLog(XQueryUtils.class);
private XQueryUtils() {
//prevent instantiation
throw new AssertionError("Cannot instantiate a utility class");
}
/**
* Reads the XQuery string from the resource file specified
*
@@ -49,10 +61,11 @@ public class XQueryUtils {
Assert.notNull(resource, "null resource provided");
Assert.isTrue(resource.exists(), "Provided XQuery resource does not exist");
Assert.isTrue(resource.isReadable(), "Provided XQuery resource is not readable");
BufferedReader reader = null;
try {
URL url = resource.getURL();
InputStream inStream = url.openStream();
BufferedReader reader = new BufferedReader(new InputStreamReader(inStream));
reader = new BufferedReader(new InputStreamReader(inStream));
String line = reader.readLine();
StringBuilder builder = new StringBuilder();
while(line != null) {
@@ -64,6 +77,14 @@ public class XQueryUtils {
return xQuery;
} catch (IOException e) {
throw new MessagingException("Error while reading the xQuery resource", e);
} finally {
if(reader != null) {
try {
reader.close();
} catch (IOException e) {
logger.error("Exception while closing reader", e);
}
}
}
}
}

2
spring-integration-xquery/src/main/java/org/springframework/integration/xquery/transformer/XQueryTransformer.java
View File

@@ -66,7 +66,7 @@ public class XQueryTransformer extends AbstractTransformer {
*/
@SuppressWarnings("unchecked")
@Override
protected Object doTransform(Message<?> message) throws Exception {
protected Object doTransform(Message<?> message) {
Object transformed;
List<Object> queryResult;
if(resultType != null) {