Added: jena/site/trunk/content/documentation/javadoc/extras/querybuilder/org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html URL: http://svn.apache.org/viewvc/jena/site/trunk/content/documentation/javadoc/extras/querybuilder/org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html?rev=1818108&view=auto ============================================================================== --- jena/site/trunk/content/documentation/javadoc/extras/querybuilder/org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html (added) +++ jena/site/trunk/content/documentation/javadoc/extras/querybuilder/org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html Thu Dec 14 11:26:25 2017 @@ -0,0 +1,582 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_151) on Wed Dec 13 21:53:38 GMT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SolutionModifierClause (Apache Jena - Extras - Query Builder 3.6.0)</title> +<meta name="date" content="2017-12-13"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SolutionModifierClause (Apache Jena - Extras - Query Builder 3.6.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SolutionModifierClause.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SelectClause.html" title="interface in org.apache.jena.arq.querybuilder.clauses"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="interface in org.apache.jena.arq.querybuilder.clauses"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" target="_top">Frames</a></li> +<li><a href="SolutionModifierClause.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.jena.arq.querybuilder.clauses</div> +<h2 title="Interface SolutionModifierClause" class="title">Interface SolutionModifierClause<T extends <a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html" title="class in org.apache.jena.arq.querybuilder">AbstractQueryBuilder</a><T>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - The Builder type that the clause is part of.</dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../../org/apache/jena/arq/querybuilder/AskBuilder.html" title="class in org.apache.jena.arq.querybuilder">AskBuilder</a>, <a href="../../../../../../org/apache/jena/arq/querybuilder/ConstructBuilder.html" title="class in org.apache.jena.arq.querybuilder">ConstructBuilder</a>, <a href="../../../../../../org/apache/jena/arq/querybuilder/DescribeBuilder.html" title="class in org.apache.jena.arq.querybuilder">DescribeBuilder</a>, <a href="../../../../../../org/apache/jena/arq/querybuilder/SelectBuilder.html" title="class in org.apache.jena.arq.querybuilder">SelectBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">SolutionModifierClause<T extends <a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html" title="class in org.apache.jena.arq.querybuilder">AbstractQueryBuilder</a><T>></span></pre> +<div class="block">Interface that defines the SolutionClause as per + http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rSolutionModifier</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addGroupBy-org.apache.jena.sparql.expr.Expr-">addGroupBy</a></span>(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> groupBy)</code> +<div class="block">Add an expression to the group by clause.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addGroupBy-java.lang.Object-">addGroupBy</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> groupBy)</code> +<div class="block">Add a variable to the group by clause.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addGroupBy-java.lang.Object-org.apache.jena.sparql.expr.Expr-">addGroupBy</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var, + <a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> expr)</code> +<div class="block">Add var and expression to the group by clause.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addGroupBy-java.lang.Object-java.lang.String-">addGroupBy</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> expr)</code> +<div class="block">Add var and expression to the group by clause.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addHaving-org.apache.jena.sparql.expr.Expr-">addHaving</a></span>(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> expression)</code> +<div class="block">Add a having expression.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addHaving-java.lang.Object-">addHaving</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var)</code> +<div class="block">Add a having expression.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addHaving-java.lang.String-">addHaving</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> expression)</code> +<div class="block">Add a having expression.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addOrderBy-org.apache.jena.sparql.expr.Expr-">addOrderBy</a></span>(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> orderBy)</code> +<div class="block">Add an ascending order by.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addOrderBy-org.apache.jena.sparql.expr.Expr-org.apache.jena.arq.querybuilder.Order-">addOrderBy</a></span>(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> orderBy, + <a href="../../../../../../org/apache/jena/arq/querybuilder/Order.html" title="enum in org.apache.jena.arq.querybuilder">Order</a> order)</code> +<div class="block">Add an order by with direction specified.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addOrderBy-java.lang.Object-">addOrderBy</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> orderBy)</code> +<div class="block">Add an ascending order by.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addOrderBy-java.lang.Object-org.apache.jena.arq.querybuilder.Order-">addOrderBy</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> orderBy, + <a href="../../../../../../org/apache/jena/arq/querybuilder/Order.html" title="enum in org.apache.jena.arq.querybuilder">Order</a> order)</code> +<div class="block">Add an order by with direction specified.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#addOrderBy-org.apache.jena.query.SortCondition-">addOrderBy</a></span>(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/query/SortCondition.html?is-external=true"; title="class or interface in org.apache.jena.query">SortCondition</a> orderBy)</code> +<div class="block">Add an ascending order by.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/handlers/SolutionModifierHandler.html" title="class in org.apache.jena.arq.querybuilder.handlers">SolutionModifierHandler</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#getSolutionModifierHandler--">getSolutionModifierHandler</a></span>()</code> +<div class="block">Get the Solution modifier for this clause.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#setLimit-int-">setLimit</a></span>(int limit)</code> +<div class="block">Set the limit.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html#setOffset-int-">setOffset</a></span>(int offset)</code> +<div class="block">Set the offset.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addOrderBy-org.apache.jena.sparql.expr.Expr-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addOrderBy</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addOrderBy(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> orderBy)</pre> +<div class="block">Add an ascending order by. + + Use ExprFactory or NodeValue static or the AbstractQueryBuilder.makeExpr + methods to create the expression.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>orderBy</code> - The expression to order by.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>ExprFactory</code>, +<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/NodeValue.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr"><code>NodeValue</code></a>, +<a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeExpr-java.lang.String-"><code>AbstractQueryBuilder.makeExpr(String)</code></a></dd> +</dl> +</li> +</ul> +<a name="addOrderBy-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addOrderBy</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addOrderBy(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> orderBy)</pre> +<div class="block">Add an ascending order by.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>orderBy</code> - The object to order by.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +</dl> +</li> +</ul> +<a name="addOrderBy-org.apache.jena.query.SortCondition-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addOrderBy</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addOrderBy(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/query/SortCondition.html?is-external=true"; title="class or interface in org.apache.jena.query">SortCondition</a> orderBy)</pre> +<div class="block">Add an ascending order by.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>orderBy</code> - The SortCondition to order by.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +</dl> +</li> +</ul> +<a name="addOrderBy-org.apache.jena.sparql.expr.Expr-org.apache.jena.arq.querybuilder.Order-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addOrderBy</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addOrderBy(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> orderBy, + <a href="../../../../../../org/apache/jena/arq/querybuilder/Order.html" title="enum in org.apache.jena.arq.querybuilder">Order</a> order)</pre> +<div class="block">Add an order by with direction specified.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>orderBy</code> - The expression to order by.</dd> +<dd><code>order</code> - The direction to order.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +</dl> +</li> +</ul> +<a name="addOrderBy-java.lang.Object-org.apache.jena.arq.querybuilder.Order-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addOrderBy</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addOrderBy(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> orderBy, + <a href="../../../../../../org/apache/jena/arq/querybuilder/Order.html" title="enum in org.apache.jena.arq.querybuilder">Order</a> order)</pre> +<div class="block">Add an order by with direction specified.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>orderBy</code> - The object to order by.</dd> +<dd><code>order</code> - The direction to order.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +</dl> +</li> +</ul> +<a name="addGroupBy-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addGroupBy</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addGroupBy(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> groupBy)</pre> +<div class="block">Add a variable to the group by clause.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>groupBy</code> - The object to group by.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +</dl> +</li> +</ul> +<a name="addGroupBy-org.apache.jena.sparql.expr.Expr-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addGroupBy</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addGroupBy(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> groupBy)</pre> +<div class="block">Add an expression to the group by clause. The expression may be created + from a string using the makeExpr() method.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>groupBy</code> - The expression to add.</dd> +</dl> +</li> +</ul> +<a name="addGroupBy-java.lang.Object-org.apache.jena.sparql.expr.Expr-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addGroupBy</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addGroupBy(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var, + <a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> expr)</pre> +<div class="block">Add var and expression to the group by clause.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>var</code> - The variable to add.</dd> +<dd><code>expr</code> - The expression to add.</dd> +</dl> +</li> +</ul> +<a name="addGroupBy-java.lang.Object-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addGroupBy</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addGroupBy(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> expr)</pre> +<div class="block">Add var and expression to the group by clause.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>var</code> - The variable to add.</dd> +<dd><code>expr</code> - The expression to add.</dd> +</dl> +</li> +</ul> +<a name="addHaving-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addHaving</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addHaving(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> expression) + throws <a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/lang/sparql_11/ParseException.html?is-external=true"; title="class or interface in org.apache.jena.sparql.lang.sparql_11">ParseException</a></pre> +<div class="block">Add a having expression.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>expression</code> - Expression to evaluate for the having.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/lang/sparql_11/ParseException.html?is-external=true"; title="class or interface in org.apache.jena.sparql.lang.sparql_11">ParseException</a></code></dd> +</dl> +</li> +</ul> +<a name="addHaving-org.apache.jena.sparql.expr.Expr-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addHaving</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addHaving(<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/Expr.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr">Expr</a> expression) + throws <a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/lang/sparql_11/ParseException.html?is-external=true"; title="class or interface in org.apache.jena.sparql.lang.sparql_11">ParseException</a></pre> +<div class="block">Add a having expression. + + Use ExprFactory or NodeValue static or the AbstractQueryBuilder.makeExpr + methods to create the expression.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>expression</code> - Expression to evaluate for the having.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/lang/sparql_11/ParseException.html?is-external=true"; title="class or interface in org.apache.jena.sparql.lang.sparql_11">ParseException</a></code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>ExprFactory</code>, +<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/expr/NodeValue.html?is-external=true"; title="class or interface in org.apache.jena.sparql.expr"><code>NodeValue</code></a>, +<a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeExpr-java.lang.String-"><code>AbstractQueryBuilder.makeExpr(String)</code></a></dd> +</dl> +</li> +</ul> +<a name="addHaving-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addHaving</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> addHaving(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var) + throws <a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/lang/sparql_11/ParseException.html?is-external=true"; title="class or interface in org.apache.jena.sparql.lang.sparql_11">ParseException</a></pre> +<div class="block">Add a having expression.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>var</code> - the variable to have.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/lang/sparql_11/ParseException.html?is-external=true"; title="class or interface in org.apache.jena.sparql.lang.sparql_11">ParseException</a></code></dd> +</dl> +</li> +</ul> +<a name="setLimit-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLimit</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> setLimit(int limit)</pre> +<div class="block">Set the limit. + + Setting the limit to 0 (zero) sets no limit.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>limit</code> - the maximum number of results to return.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +</dl> +</li> +</ul> +<a name="setOffset-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOffset</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="type parameter in SolutionModifierClause">T</a> setOffset(int offset)</pre> +<div class="block">Set the offset. + + Setting the offset to 0 (zero) sets no offset.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>offset</code> - the number of results to skip before returning results..</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +</dl> +</li> +</ul> +<a name="getSolutionModifierHandler--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSolutionModifierHandler</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/handlers/SolutionModifierHandler.html" title="class in org.apache.jena.arq.querybuilder.handlers">SolutionModifierHandler</a> getSolutionModifierHandler()</pre> +<div class="block">Get the Solution modifier for this clause.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The SolutionModifierHandler the clause is using.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SolutionModifierClause.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SelectClause.html" title="interface in org.apache.jena.arq.querybuilder.clauses"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="interface in org.apache.jena.arq.querybuilder.clauses"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" target="_top">Frames</a></li> +<li><a href="SolutionModifierClause.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Licensed under the Apache License, Version 2.0</small></p> +</body> +</html>
Added: jena/site/trunk/content/documentation/javadoc/extras/querybuilder/org/apache/jena/arq/querybuilder/clauses/ValuesClause.html URL: http://svn.apache.org/viewvc/jena/site/trunk/content/documentation/javadoc/extras/querybuilder/org/apache/jena/arq/querybuilder/clauses/ValuesClause.html?rev=1818108&view=auto ============================================================================== --- jena/site/trunk/content/documentation/javadoc/extras/querybuilder/org/apache/jena/arq/querybuilder/clauses/ValuesClause.html (added) +++ jena/site/trunk/content/documentation/javadoc/extras/querybuilder/org/apache/jena/arq/querybuilder/clauses/ValuesClause.html Thu Dec 14 11:26:25 2017 @@ -0,0 +1,478 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_151) on Wed Dec 13 21:53:38 GMT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ValuesClause (Apache Jena - Extras - Query Builder 3.6.0)</title> +<meta name="date" content="2017-12-13"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ValuesClause (Apache Jena - Extras - Query Builder 3.6.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ValuesClause.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="interface in org.apache.jena.arq.querybuilder.clauses"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/WhereClause.html" title="interface in org.apache.jena.arq.querybuilder.clauses"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" target="_top">Frames</a></li> +<li><a href="ValuesClause.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.jena.arq.querybuilder.clauses</div> +<h2 title="Interface ValuesClause" class="title">Interface ValuesClause<T extends <a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html" title="class in org.apache.jena.arq.querybuilder">AbstractQueryBuilder</a><T>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - The Builder type that the clause is part of.</dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html" title="class in org.apache.jena.arq.querybuilder">AbstractQueryBuilder</a>, <a href="../../../../../../org/apache/jena/arq/querybuilder/AskBuilder.html" title="class in org.apache.jena.arq.querybuilder">AskBuilder</a>, <a href="../../../../../../org/apache/jena/arq/querybuilder/ConstructBuilder.html" title="class in org.apache.jena.arq.querybuilder">ConstructBuilder</a>, <a href="../../../../../../org/apache/jena/arq/querybuilder/DescribeBuilder.html" title="class in org.apache.jena.arq.querybuilder">DescribeBuilder</a>, <a href="../../../../../../org/apache/jena/arq/querybuilder/SelectBuilder.html" title="class in org.apache.jena.arq.querybuilder">SelectBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ValuesClause<T extends <a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html" title="class in org.apache.jena.arq.querybuilder">AbstractQueryBuilder</a><T>></span></pre> +<div class="block">Interface that defines the ValueClause as per + https://www.w3.org/TR/sparql11-query/#rValuesClause + + Conceptually this the values clause constructs a table comprising columns named + by variables and rows of data for those columns. Most of the methods specified here + add variable columns and/or add values for them. + + The order that variables are added to the table is retained.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html#addValueRow-java.util.Collection-">addValueRow</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><?> values)</code> +<div class="block">Add a collection of objects as row of values.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html#addValueRow-java.lang.Object...-">addValueRow</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... values)</code> +<div class="block">Add objects as a row of values.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html#addValueVar-java.lang.Object-">addValueVar</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var)</code> +<div class="block">Add a variable or variable and values to the value statement.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html#addValueVar-java.lang.Object-java.lang.Object...-">addValueVar</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... values)</code> +<div class="block">Add a variable and values to the value statement.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><K extends <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><?>><br><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html#addValueVars-java.util.Map-">addValueVars</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><?,K> dataTable)</code> +<div class="block">Add a data table to the value statement.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html#clearValues--">clearValues</a></span>()</code> +<div class="block">Reset the values table to the initial undefined state.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/jena/arq/querybuilder/handlers/ValuesHandler.html" title="class in org.apache.jena.arq.querybuilder.handlers">ValuesHandler</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html#getValuesHandler--">getValuesHandler</a></span>()</code> +<div class="block">Get the value handler for this clause.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/core/Var.html?is-external=true"; title="class or interface in org.apache.jena.sparql.core">Var</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://jena.apache.org/documentation/javadoc/jena/org/apache/jena/graph/Node.html?is-external=true"; title="class or interface in org.apache.jena.graph">Node</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html#getValuesMap--">getValuesMap</a></span>()</code> +<div class="block">Get an unmodifiable map of vars and their values.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/core/Var.html?is-external=true"; title="class or interface in org.apache.jena.sparql.core">Var</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html#getValuesVars--">getValuesVars</a></span>()</code> +<div class="block">Get an unmodifiable list of vars in the order that they appear in the values table.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getValuesHandler--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValuesHandler</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/handlers/ValuesHandler.html" title="class in org.apache.jena.arq.querybuilder.handlers">ValuesHandler</a> getValuesHandler()</pre> +<div class="block">Get the value handler for this clause.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The ValueHandler this clause is using.</dd> +</dl> +</li> +</ul> +<a name="addValueVar-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addValueVar</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a> addValueVar(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var)</pre> +<div class="block">Add a variable or variable and values to the value statement. + + The first var (or first item in a collection) is converted to a variable using + the makeVar strategy. A variable may be added multiple times, doing so + will append values to the list of variable values. The order in which variables + are added to the values table is preserved. + + Adding a collection as the var will use the first object in the collection as + the var and the remaining objects as values. + + Values are created using makeNode() strategy except that null values are converted + to UNDEF.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>var</code> - The variable or collection to add.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeNode-java.lang.Object-"><code>AbstractQueryBuilder.makeNode(Object)</code></a>, +<a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeVar-java.lang.Object-"><code>AbstractQueryBuilder.makeVar(Object)</code></a></dd> +</dl> +</li> +</ul> +<a name="addValueVar-java.lang.Object-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addValueVar</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a> addValueVar(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> var, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... values)</pre> +<div class="block">Add a variable and values to the value statement. + + The var is converted to a variable using + the makeVar strategy. A variable may be added multiple times, doing so + will append values to the list of variable values. The order in which variables + are added to the values table is preserved. + + Values are created using makeNode() strategy except that null values are converted + to UNDEF.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>var</code> - The variable to add.</dd> +<dd><code>values</code> - The values for the variable</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeNode-java.lang.Object-"><code>AbstractQueryBuilder.makeNode(Object)</code></a>, +<a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeVar-java.lang.Object-"><code>AbstractQueryBuilder.makeVar(Object)</code></a></dd> +</dl> +</li> +</ul> +<a name="addValueVars-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addValueVars</h4> +<pre><K extends <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><?>> <a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a> addValueVars(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><?,K> dataTable)</pre> +<div class="block">Add a data table to the value statement. + + Each key in the map is used converted into a variable using the makeVar strategy. + The order in which variables + are added to the values table is preserved. + + Each item in the value collection is converted into a node using makeNode() strategy except that null values are converted + to UNDEF. + + If there are already values in the value statement the data table is adds as follows: + <ul> + <li>If the variable already exists in the table the map values are appended to the list of values</li> + <li>If the variable does not exist in the table and there are other variables defined, an appropriate + number of nulls is added to the front of the map values to create UNDEF entries for the existing rows</li> + <li>If there are variables in the value statement that are not specified in the map additional UNDEF + entries are appended to them to account for new rows that are added.</li> + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dataTable</code> - The data table to add.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeNode-java.lang.Object-"><code>AbstractQueryBuilder.makeNode(Object)</code></a>, +<a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeVar-java.lang.Object-"><code>AbstractQueryBuilder.makeVar(Object)</code></a></dd> +</dl> +</li> +</ul> +<a name="addValueRow-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addValueRow</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a> addValueRow(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... values)</pre> +<div class="block">Add objects as a row of values. This method is different from the other methods in that + the values are appended to each of the variables in the clause. There must be + sufficient entries in the list to provide data for each variable in the table. + Values objects are converted to nodes using the makeNode strategy. Variables will always + be in the order added to the values table.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>values</code> - the collection of values to add.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeNode-java.lang.Object-"><code>AbstractQueryBuilder.makeNode(Object)</code></a></dd> +</dl> +</li> +</ul> +<a name="addValueRow-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addValueRow</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a> addValueRow(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><?> values)</pre> +<div class="block">Add a collection of objects as row of values. This method is different from the other methods in that + the values are appended to each of the variables in the clause. There must be + sufficient entries in the list to provide data for each variable in the table. + Values objects are converted to nodes using the makeNode strategy. Variables will always + be in the order added to the values table.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>values</code> - the collection of values to add.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../org/apache/jena/arq/querybuilder/AbstractQueryBuilder.html#makeNode-java.lang.Object-"><code>AbstractQueryBuilder.makeNode(Object)</code></a></dd> +</dl> +</li> +</ul> +<a name="clearValues--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearValues</h4> +<pre><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" title="type parameter in ValuesClause">T</a> clearValues()</pre> +<div class="block">Reset the values table to the initial undefined state. Used primarily to reset the builder values table + to a known state.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The builder for chaining.</dd> +</dl> +</li> +</ul> +<a name="getValuesVars--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValuesVars</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/core/Var.html?is-external=true"; title="class or interface in org.apache.jena.sparql.core">Var</a>> getValuesVars()</pre> +<div class="block">Get an unmodifiable list of vars in the order that they appear in the values table.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an unmodifiable list of vars.</dd> +</dl> +</li> +</ul> +<a name="getValuesMap--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getValuesMap</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://jena.apache.org/documentation/javadoc/arq/org/apache/jena/sparql/core/Var.html?is-external=true"; title="class or interface in org.apache.jena.sparql.core">Var</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://jena.apache.org/documentation/javadoc/jena/org/apache/jena/graph/Node.html?is-external=true"; title="class or interface in org.apache.jena.graph">Node</a>>> getValuesMap()</pre> +<div class="block">Get an unmodifiable map of vars and their values. + + Null values are considered as UNDEF values.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an unmodifiable map of vars and their values.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ValuesClause.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/SolutionModifierClause.html" title="interface in org.apache.jena.arq.querybuilder.clauses"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/jena/arq/querybuilder/clauses/WhereClause.html" title="interface in org.apache.jena.arq.querybuilder.clauses"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/jena/arq/querybuilder/clauses/ValuesClause.html" target="_top">Frames</a></li> +<li><a href="ValuesClause.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Licensed under the Apache License, Version 2.0</small></p> +</body> +</html>
