Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Commit

Permalink
Implement qvar highlighting by creating $q var
Browse files Browse the repository at this point in the history 
Just like $x references hit, XQG now generates a $q variable which is a
map of qvar names to their xml:id attributes.
* Created additional unit test to test nested qvars and multiple qvar
  constraints and mappings
* Refactor generateQvarConstraints() to use iterators to improve
  readability
  • Loading branch information
@jimmyli97
jimmyli97 committed Jun 12, 2015
1 parent 502acaa commit 16bcd7a
Show file tree
Hide file tree
Showing 7 changed files with 122 additions and 53 deletions.
133 changes: 80 additions & 53 deletions src/main/java/com/formulasearchengine/mathmlquerygenerator/XQueryGenerator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.regex.Pattern;

Expand All @@ -22,6 +23,8 @@
* Converts MathML queries into XQueries.
* The result is then wrapped around with a header and a footer (defaults to a DB2 header/footer if not given).
* The variable $x always represents a hit, so you can refer to $x in the footer as the result node.
* The variable $q always represents a map of qvars to their respective formula ID, so you can refer to $q in the footer
* to return qvar results.
* Created by Moritz Schubotz on 9/3/14.
* Translated from http://git.wikimedia.org/blob/mediawiki%2Fextensions%2FMathSearch.git/31a80ae48d1aaa50da9103cea2e45a8dc2204b39/XQueryGenerator.php
*/
Expand All @@ -31,7 +34,10 @@ public class XQueryGenerator {
//Qvar map of qvar name to XPaths referenced by each qvar
private Map<String, ArrayList<String>> qvar = new HashMap<>();
private String relativeXPath = "";
private String exactMatchXQuery = "";
private String lengthConstraint = "";
private String qvarConstraint = "";
private String qvarMapVariable = "";
private String header = "declare default element namespace \"http://www.w3.org/1998/Math/MathML\";\n" +
"for $m in db2-fn:xmlcolumn(\"math.math_mathml\") return\n";
private String footer = "data($m/*[1]/@alttext)";
Expand Down Expand Up @@ -134,80 +140,101 @@ public void setMainElement( Node mainElement ) {

/**
* Generates the constraints of the XQuery and then builds the XQuery and returns it as a string
* @return XQuery as string
* @return XQuery as string. Returns null if no main element set.
*/
public String toString() {
if ( mainElement == null ) {
return null;
}
final String fixedConstraints = generateConstraints( mainElement, true );
final StringBuilder qvarConstraintString = new StringBuilder();
//Generate qvar constraint string
//This specifies that the same qvars must refer to the same nodes, using the XQuery "=" equality
//This is equality based on: same text, same node names, and same children by the "=" equality
for ( Map.Entry<String, ArrayList<String>> entry : qvar.entrySet() ) {
final StringBuilder addString = new StringBuilder();
if ( entry.getValue().size() > 1 ) {
final String firstEntry = entry.getValue().get( 0 );
if ( qvarConstraintString.length() != 0 ) {
addString.append("\n and ");
}
String lastEntry = "";
boolean newContent = false;
//begins at second entry
for ( final String currentEntry : entry.getValue() ) {
if ( !currentEntry.equals( firstEntry ) ) {
if ( !lastEntry.isEmpty() ) {
addString.append(" and ");
}
addString.append("$x").append(firstEntry).append(" = $x").append(currentEntry);
lastEntry = currentEntry;
newContent = true;
}
}
if ( newContent ) {
qvarConstraintString.append(addString);
}
}
}
return getString( mainElement, fixedConstraints, qvarConstraintString.toString() );
exactMatchXQuery = generateSimpleConstraints( mainElement, true );
generateQvarConstraints();

return getString( mainElement, exactMatchXQuery, lengthConstraint, qvarConstraint, qvarMapVariable, header, footer );
}

/**
* Builds the XQuery as a string with the set header and footer, given constraint strings and the main element.
* Builds the XQuery as a string given constraint strings, header, footer, qvar map, and the main element.
* @param mainElement Node from which to build XQuery
* @param fixedConstraints Constraint string for basic exact formula matching
* @param lengthConstraint Constraint string for length of variables
* @param qvarConstraintString Constraint string for qvar matching
* @param qvarMapVariable Qvar map variable
* @param header Header
* @param footer Footer
* @return XQuery as string
*/
public String getString( Node mainElement, String fixedConstraints, String qvarConstraintString ) {
public static String getString( Node mainElement, String fixedConstraints, String lengthConstraint,
String qvarConstraintString, String qvarMapVariable, String header, String footer ) {
String out = header;
out += "for $x in $m//*:" + getFirstChild( mainElement ).getLocalName() + "\n" +
fixedConstraints + "\n";
out += getConstraints( qvarConstraintString );
out +=
"return" + "\n" + getFooter();
if ( !lengthConstraint.isEmpty() || !qvarConstraintString.isEmpty() ) {
out += "where" + "\n";
if ( lengthConstraint.isEmpty() ) {
out += qvarConstraintString;
} else {
out += lengthConstraint + (qvarConstraintString.isEmpty() ? "" : " and " + qvarConstraintString);
}
}
out += qvarMapVariable;
out += "\n";
out += "return" + "\n" + footer;
return out;
}

/**
* Appends constraint strings together
* @param qvarConstraintString Qvar constraint portion of query
* @return All constraint strings appended together
* Uses the qvar map to generate a XQuery string containing qvar constraints,
* and the qvar map variable which maps qvar names to their respective formula ID's in the result.
*/
private String getConstraints( String qvarConstraintString ) {
String out = lengthConstraint +
(((qvarConstraintString.length() > 0) && (lengthConstraint.length() > 0)) ? " and " : "") +
qvarConstraintString;
if ( out.trim().length() > 0 ) {
return "where" + "\n" + out + "\n";
} else {
return "";
private void generateQvarConstraints() {
final StringBuilder qvarConstrBuilder = new StringBuilder();
final StringBuilder qvarMapStrBuilder = new StringBuilder();
final Iterator<Map.Entry<String, ArrayList<String>>> entryIterator = qvar.entrySet().iterator();
if ( entryIterator.hasNext() ) {
qvarMapStrBuilder.append( "\nlet $q := map {" );

while ( entryIterator.hasNext() ) {
final Map.Entry<String, ArrayList<String>> currentEntry = entryIterator.next();

final Iterator<String> valueIterator = currentEntry.getValue().iterator();
final String firstValue = valueIterator.next();

qvarMapStrBuilder.append( '"' ).append( currentEntry.getKey() ).append( '"' )
.append( " : (data($x" ).append( firstValue ).append( "/@xml:id)" );

//check if there are additional values that we need to constrain
if ( valueIterator.hasNext() ) {
if ( qvarConstrBuilder.length() > 0 ) {
//only add beginning and if it's an additional constraint in the aggregate qvar string
qvarConstrBuilder.append( "\n and " );
}
while ( valueIterator.hasNext() ) {
//process second value onwards
final String currentValue = valueIterator.next();
qvarMapStrBuilder.append( ",data($x" ).append( currentValue ).append( "/@xml-id)" );
//These constraints specify that the same qvars must refer to the same nodes,
//using the XQuery "=" equality
//This is equality based on: same text, same node names, and same children nodes
qvarConstrBuilder.append( "$x" ).append( firstValue ).append( " = $x" ).append( currentValue );
if ( valueIterator.hasNext() ) {
qvarConstrBuilder.append( " and " );
}
}
}
qvarMapStrBuilder.append( ')' );
if ( entryIterator.hasNext() ) {
qvarMapStrBuilder.append( ',' );
}
}
qvarMapStrBuilder.append( '}' );
}
qvarMapVariable = qvarMapStrBuilder.toString();
qvarConstraint = qvarConstrBuilder.toString();
}

private String generateConstraint( Node node ) {
return generateConstraints( node, false );

private String generateSimpleConstraints( Node node ) {
return generateSimpleConstraints( node, false );
}

/**
Expand All @@ -218,7 +245,7 @@ private String generateConstraint( Node node ) {
* is not added as a constraint here, but in getString())
* @return Exact match XQuery string
*/
private String generateConstraints( Node node, boolean isRoot ) {
private String generateSimpleConstraints( Node node, boolean isRoot ) {
//Index of child node
int childElementIndex = 0;
final StringBuilder out = new StringBuilder();
Expand Down Expand Up @@ -264,10 +291,10 @@ private String generateConstraints( Node node, boolean isRoot ) {
//Add relative constraint so this can be recursively called
out.append( " and *[" ).append( childElementIndex ).append( "]" );
}
final String constraint = generateConstraint( child );
final String constraint = generateSimpleConstraints( child );
if ( !constraint.isEmpty() ) {
//This constraint appears as a child of the relative constraint above (e.g. [*1][constraint])
out.append( "[" ).append( constraint ).append( "]");
out.append( "[" ).append( constraint ).append( "]" );
}
}
}
Expand Down
1 change: 1 addition & 0 deletions src/test/java/com/formulasearchengine/mathmlquerygenerator/XQueryGeneratorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ public void testNoRestriction() throws Exception {
"[*[1]/name() = 'plus' and *[2]/name() = 'apply' and *[2][*[1]/name() = 'csymbol' and *[1][./text() = 'superscript'] and *[3]/name() = 'cn' and *[3][./text() = '2']]]\n" +
"where\n" +
"$x/*[2]/*[2] = $x/*[3]\n" +
"let $q := map {\"x\" : (data($x/*[2]/*[2]/@xml:id),data($x/*[3]/@xml-id))}\n" +
"return\n";
Document query = XMLHelper.String2Doc( testInput );
XQueryGenerator xQueryGenerator = new XQueryGenerator( query );
Expand Down
1 change: 1 addition & 0 deletions src/test/resources/com/formulasearchengine/mathmlquerygenerator/mws/qqx2.xq
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ fn:count($x/*[1]/*) = 0
and fn:count($x/*[3]/*) = 0
and fn:count($x/*) = 3

let $q := map {"x" : (data($x/*[2]/@xml:id))}
return
data($m/*[1]/@alttext)
1 change: 1 addition & 0 deletions src/test/resources/com/formulasearchengine/mathmlquerygenerator/mws/qqx2v2.xq
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ fn:count($x/*[1]/*) = 0
and fn:count($x/*[3]/*) = 0
and fn:count($x/*) = 3

let $q := map {"x" : (data($x/*[2]/@xml:id))}
return
data($m/*[1]/@alttext)
1 change: 1 addition & 0 deletions src/test/resources/com/formulasearchengine/mathmlquerygenerator/mws/qqx2x.xq
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ fn:count($x/*[2]/*[1]/*) = 0
and fn:count($x/*[2]/*) = 3
and fn:count($x/*) = 3
and $x/*[2]/*[2] = $x/*[3]
let $q := map {"x" : (data($x/*[2]/*[2]/@xml:id),data($x/*[3]/@xml-id))}
return
data($m/*[1]/@alttext)
23 changes: 23 additions & 0 deletions src/test/resources/com/formulasearchengine/mathmlquerygenerator/mws/qqx2xy.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0"?>
<mws:query xmlns:mws="http://search.mathweb.org/ns" xmlns:m="http://www.w3.org/1998/Math/MathML" limitmin="0"
answsize="30">
<mws:expr>
<m:apply xml:id="p1.1.m1.1.5.cmml" xref="p1.1.m1.1.5">
<m:plus xml:id="p1.3.7.1.4.cmml" xref="p1.765.21.1"/>
<m:apply xml:id="p5.1.3.1.cmml" xref="p4.2.6.21">
<m:plus xml:id="p1.1.m1.1.3.cmml" xref="p1.1.m1.1.3"/>
<m:apply xml:id="p1.1.m1.1.5.1.cmml" xref="p1.1.m1.1.5.1">
<m:csymbol cd="ambiguous" xml:id="p1.1.m1.1.5.1.1.cmml">superscript</m:csymbol>
<mws:qvar>x</mws:qvar>
<m:apply xml:id="p1.1.m1.1.5.1.2.cmml" xref="p1.2.4.2.cmml">
<m:times xml:id="p1.1.m1.1.6.1.3.cmml" xref="p2.31.41.cmml"/>
<mws:qvar>y</mws:qvar>
<mws:qvar>y</mws:qvar>
</m:apply>
</m:apply>
<mws:qvar>x</mws:qvar>
</m:apply>
<mws:qvar>x</mws:qvar>
</m:apply>
</mws:expr>
</mws:query>
15 changes: 15 additions & 0 deletions src/test/resources/com/formulasearchengine/mathmlquerygenerator/mws/qqx2xy.xq
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
declare default element namespace "http://www.w3.org/1998/Math/MathML";
for $m in db2-fn:xmlcolumn("math.math_mathml") return
for $x in $m//*:apply
[*[1]/name() = 'plus' and *[2]/name() = 'apply' and *[2][*[1]/name() = 'plus' and *[2]/name() = 'apply' and *[2][*[1]/name() = 'csymbol' and *[1][./text() = 'superscript'] and *[3]/name() = 'apply' and *[3][*[1]/name() = 'times']]]]
where
fn:count($x/*[2]/*[2]/*[1]/*) = 0
and fn:count($x/*[2]/*[2]/*[3]/*) = 3
and fn:count($x/*[2]/*[2]/*) = 3
and fn:count($x/*[2]/*) = 3
and fn:count($x/*) = 3
and $x/*[2]/*[2]/*[2] = $x/*[2]/*[3] and $x/*[2]/*[2]/*[2] = $x/*[3]
and $x/*[2]/*[2]/*[3]/*[2] = $x/*[2]/*[2]/*[3]/*[3]
let $q := map {"x" : (data($x/*[2]/*[2]/*[2]/@xml:id),data($x/*[2]/*[3]/@xml-id),data($x/*[3]/@xml-id)),"y" : (data($x/*[2]/*[2]/*[3]/*[2]/@xml:id),data($x/*[2]/*[2]/*[3]/*[3]/@xml-id))}
return
data($m/*[1]/@alttext)

0 comments on commit 16bcd7a

Please sign in to comment.