Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-18497 Add xmlcomment function

This commit is contained in:
Christian Beikov 2024-09-20 22:34:16 +02:00
parent 4baba673cb
commit f10ec5db1d
19 changed files with 145 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
documentation/src/main/asciidoc/userguide/chapters/query/hql/QueryLanguage.adoc
View File

@ -2172,6 +2172,7 @@ it is necessary to enable the `hibernate.query.hql.xml_functions_enabled` config
| Function | Purpose
| `xmlelement()` | Constructs an XML element from arguments
| `xmlcomment()` | Constructs an XML comment from the single argument
|===
@ -2209,6 +2210,21 @@ include::{xml-example-dir-hql}/XmlElementTest.java[tags=hql-xmlelement-attribute
WARNING: SAP HANA, MySQL, MariaDB, H2 and HSQLDB do not support this function.
[[hql-xmlcomment-function]]
===== `xmlcomment()`
Constructs an XML comment from the single string argument.
[[hql-xmlcomment-example]]
====
[source, java, indent=0]
----
include::{xml-example-dir-hql}/XmlCommentTest.java[tags=hql-xmlcomment-example]
----
====
WARNING: SAP HANA, MySQL, MariaDB, H2 and HSQLDB do not support this function.
[[hql-user-defined-functions]]
==== Native and user-defined functions

1
hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2LegacyDialect.java
View File

@ -442,6 +442,7 @@ public class DB2LegacyDialect extends Dialect {
}
functionFactory.xmlelement();
functionFactory.xmlcomment();
}
@Override

1
hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/H2LegacyDialect.java
View File

@ -419,6 +419,7 @@ public class H2LegacyDialect extends Dialect {
}
functionFactory.xmlelement_h2();
functionFactory.xmlcomment();
}
else {
functionFactory.listagg_groupConcat();

1
hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/OracleLegacyDialect.java
View File

@ -327,6 +327,7 @@ public class OracleLegacyDialect extends Dialect {
}
functionFactory.xmlelement();
functionFactory.xmlcomment();
}
@Override

1
hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/PostgreSQLLegacyDialect.java
View File

@ -670,6 +670,7 @@ public class PostgreSQLLegacyDialect extends Dialect {
functionFactory.jsonArrayInsert_postgresql();
functionFactory.xmlelement();
functionFactory.xmlcomment();
if ( getVersion().isSameOrAfter( 9, 4 ) ) {
functionFactory.makeDateTimeTimestamp();

1
hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SQLServerLegacyDialect.java
View File

@ -414,6 +414,7 @@ public class SQLServerLegacyDialect extends AbstractTransactSQLDialect {
functionFactory.jsonArrayInsert_sqlserver();
}
functionFactory.xmlelement_sqlserver();
functionFactory.xmlcomment_sqlserver();
if ( getVersion().isSameOrAfter( 14 ) ) {
functionFactory.listagg_stringAggWithinGroup( "varchar(max)" );
functionFactory.jsonArrayAgg_sqlserver( getVersion().isSameOrAfter( 16 ) );

1
hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java
View File

@ -427,6 +427,7 @@ public class DB2Dialect extends Dialect {
}
functionFactory.xmlelement();
functionFactory.xmlcomment();
}
@Override

1
hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java
View File

@ -354,6 +354,7 @@ public class H2Dialect extends Dialect {
}
functionFactory.xmlelement_h2();
functionFactory.xmlcomment();
}
/**

1
hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java
View File

@ -417,6 +417,7 @@ public class OracleDialect extends Dialect {
functionFactory.jsonArrayInsert_oracle();
functionFactory.xmlelement();
functionFactory.xmlcomment();
}
@Override

1
hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQLDialect.java
View File

@ -631,6 +631,7 @@ public class PostgreSQLDialect extends Dialect {
functionFactory.jsonArrayInsert_postgresql();
functionFactory.xmlelement();
functionFactory.xmlcomment();
functionFactory.makeDateTimeTimestamp();
// Note that PostgreSQL doesn't support the OVER clause for ordered set-aggregate functions

1
hibernate-core/src/main/java/org/hibernate/dialect/SQLServerDialect.java
View File

@ -432,6 +432,7 @@ public class SQLServerDialect extends AbstractTransactSQLDialect {
functionFactory.jsonArrayInsert_sqlserver();
}
functionFactory.xmlelement_sqlserver();
functionFactory.xmlcomment_sqlserver();
if ( getVersion().isSameOrAfter( 14 ) ) {
functionFactory.listagg_stringAggWithinGroup( "varchar(max)" );
functionFactory.jsonArrayAgg_sqlserver( getVersion().isSameOrAfter( 16 ) );

22
hibernate-core/src/main/java/org/hibernate/dialect/function/CommonFunctionFactory.java
View File

@ -4121,4 +4121,26 @@ public class CommonFunctionFactory {
public void xmlelement_sqlserver() {
functionRegistry.register( "xmlelement", new SQLServerXmlElementFunction( typeConfiguration ) );
}
/**
* Standard xmlcomment() function
*/
public void xmlcomment() {
functionRegistry.namedDescriptorBuilder( "xmlcomment" )
.setExactArgumentCount( 1 )
.setParameterTypes( STRING )
.setInvariantType( typeConfiguration.getBasicTypeRegistry().resolve( String.class, SqlTypes.SQLXML ) )
.register();
}
/**
* Standard xmlcomment() function
*/
public void xmlcomment_sqlserver() {
functionRegistry.patternDescriptorBuilder( "xmlcomment", "cast(('<!--'+?1+'-->') AS xml)" )
.setExactArgumentCount( 1 )
.setParameterTypes( STRING )
.setInvariantType( typeConfiguration.getBasicTypeRegistry().resolve( String.class, SqlTypes.SQLXML ) )
.register();
}
}

8
hibernate-core/src/main/java/org/hibernate/query/criteria/HibernateCriteriaBuilder.java
View File

@ -4055,6 +4055,14 @@ public interface HibernateCriteriaBuilder extends CriteriaBuilder {
@Incubating
JpaXmlElementExpression xmlelement(String elementName);
/**
* Creates an XML comment with the given argument as content.
*
* @since 7.0
*/
@Incubating
JpaExpression<String> xmlcomment(String comment);
@Override
JpaPredicate and(List<Predicate> restrictions);

6
hibernate-core/src/main/java/org/hibernate/query/criteria/spi/HibernateCriteriaBuilderDelegate.java
View File

@ -3638,4 +3638,10 @@ public class HibernateCriteriaBuilderDelegate implements HibernateCriteriaBuilde
public JpaXmlElementExpression xmlelement(String elementName) {
return criteriaBuilder.xmlelement( elementName );
}
@Override
@Incubating
public JpaExpression<String> xmlcomment(String comment) {
return criteriaBuilder.xmlcomment( comment );
}
}

3
hibernate-core/src/main/java/org/hibernate/query/sqm/NodeBuilder.java
View File

@ -753,6 +753,9 @@ public interface NodeBuilder extends HibernateCriteriaBuilder, BindingContext {
@Override
SqmXmlElementExpression xmlelement(String elementName);
@Override
SqmExpression<String> xmlcomment(String comment);
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Covariant overrides

9
hibernate-core/src/main/java/org/hibernate/query/sqm/internal/SqmCriteriaNodeBuilder.java
View File

@ -5687,4 +5687,13 @@ public class SqmCriteriaNodeBuilder implements NodeBuilder, Serializable {
queryEngine
);
}
@Override
public SqmExpression<String> xmlcomment(String comment) {
return getFunctionDescriptor( "xmlcomment" ).generateSqmExpression(
List.of( value( comment ) ),
null,
queryEngine
);
}
}

36
hibernate-core/src/test/java/org/hibernate/orm/test/function/xml/XmlCommentTest.java Normal file
View File

@ -0,0 +1,36 @@
/*
* SPDX-License-Identifier: LGPL-2.1-or-later
* Copyright Red Hat Inc. and Hibernate Authors
*/
package org.hibernate.orm.test.function.xml;
import org.hibernate.cfg.QuerySettings;
import org.hibernate.testing.orm.junit.DialectFeatureChecks;
import org.hibernate.testing.orm.junit.DomainModel;
import org.hibernate.testing.orm.junit.RequiresDialectFeature;
import org.hibernate.testing.orm.junit.ServiceRegistry;
import org.hibernate.testing.orm.junit.SessionFactory;
import org.hibernate.testing.orm.junit.SessionFactoryScope;
import org.hibernate.testing.orm.junit.Setting;
import org.junit.jupiter.api.Test;
/**
* @author Christian Beikov
*/
@DomainModel
@SessionFactory
@ServiceRegistry(settings = @Setting(name = QuerySettings.XML_FUNCTIONS_ENABLED, value = "true"))
@RequiresDialectFeature( feature = DialectFeatureChecks.SupportsXmlcomment.class)
public class XmlCommentTest {
@Test
public void testSimple(SessionFactoryScope scope) {
scope.inSession( em -> {
//tag::hql-xmlcomment-example[]
em.createQuery( "select xmlcomment('This is my comment')" ).getResultList();
//end::hql-xmlcomment-example[]
} );
}
}

40
hibernate-core/src/test/java/org/hibernate/orm/test/query/hql/XmlFunctionTests.java
View File

@ -43,7 +43,6 @@ import jakarta.persistence.Entity;
import jakarta.persistence.Id;
import jakarta.persistence.Tuple;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;
@ -137,24 +136,40 @@ public class XmlFunctionTests {
);
}
private void assertXmlEquals(String doc1, String doc2) {
final Document d1 = parseXml( xmlNormalize( doc1 ) );
final Document d2 = parseXml( xmlNormalize( doc2 ) );
normalize( d1 );
normalize( d2 );
assertEquals( toXml( d1 ), toXml( d2 ) );
@Test
@RequiresDialectFeature(feature = DialectFeatureChecks.SupportsXmlcomment.class)
public void testXmlcomment(SessionFactoryScope scope) {
scope.inTransaction(
session -> {
Tuple tuple = session.createQuery(
"select " +
"xmlcomment('Abc'), " +
"xmlcomment('<>')",
Tuple.class
).getSingleResult();
assertXmlEquals( "<!--Abc--><a/>", tuple.get( 0, String.class ) + "<a/>" );
assertXmlEquals( "<!--<>--><a/>", tuple.get( 1 , String.class ) + "<a/>" );
}
);
}
private void assertXmlEquals(String expected, String actual) {
final Document expectedDoc = parseXml( xmlNormalize( expected ) );
final Document actualDoc = parseXml( xmlNormalize( actual ) );
normalize( expectedDoc );
normalize( actualDoc );
assertEquals( toXml( expectedDoc ).trim(), toXml( actualDoc ).trim() );
}
private void normalize(Document document) {
normalize( document.getDocumentElement() );
normalize( document.getChildNodes() );
}
private void normalize(Element element) {
final NodeList childNodes = element.getChildNodes();
private void normalize(NodeList childNodes) {
for ( int i = 0; i < childNodes.getLength(); i++ ) {
final Node childNode = childNodes.item( i );
if ( childNode.getNodeType() == Node.ELEMENT_NODE ) {
normalize( (Element) childNode );
normalize( childNode.getChildNodes() );
}
else if ( childNode.getNodeType() == Node.TEXT_NODE ) {
if ( childNode.getNodeValue().isBlank() ) {
@ -164,6 +179,9 @@ public class XmlFunctionTests {
childNode.setNodeValue( childNode.getNodeValue().trim() );
}
}
else if ( childNode.getNodeType() == Node.COMMENT_NODE ) {
childNode.setNodeValue( childNode.getNodeValue().trim() );
}
}
}

6
hibernate-testing/src/main/java/org/hibernate/testing/orm/junit/DialectFeatureChecks.java
View File

@ -844,6 +844,12 @@ abstract public class DialectFeatureChecks {
}
}
public static class SupportsXmlcomment implements DialectFeatureCheck {
public boolean apply(Dialect dialect) {
return definesFunction( dialect, "xmlcomment" );
}
}
public static class IsJtds implements DialectFeatureCheck {
public boolean apply(Dialect dialect) {
return dialect instanceof SybaseDialect && ( (SybaseDialect) dialect ).getDriverKind() == SybaseDriverKind.JTDS;