#1294 bind(), existsJoin(), notExistsJoin(), sem.defaultGraphIri()

Author: ehennum

marklogic-client-api/src/main/java/com/marklogic/client/expression/PlanBuilder.java

@@ -322,7 +322,7 @@ protected PlanBuilder(
   public abstract PlanExprColSeq colSeq(String... col);
   /**
    * Passes multiple columns as a parameter to an operation.
-   * @param col the columns. See {@link PlanBuilder#col(String)} and {@link PlanBuilder#as(String, ServerExpression)}  
+   * @param col the columns. See {@link PlanBuilder#col(String)} and {@link PlanBuilder#as(String, ServerExpression)}
    * @return the sequence of columns
    */
   public abstract PlanExprColSeq colSeq(PlanExprCol... col);
@@ -1276,6 +1276,7 @@ public interface ExportablePlan extends Plan, PlanBuilderBase.ExportablePlanBase
  * of the plan for executing a row pipeline on the server.
  */
   public interface ModifyPlan extends PreparePlan, PlanBuilderBase.ModifyPlanBase {
+public abstract ModifyPlan bind(PlanExprColSeq columns);
 /**
   * This function adds a column based on an expression without altering the existing columns in the row set.
   * @param column  The name of the column to be defined.
@@ -1296,6 +1297,42 @@ public interface ModifyPlan extends PreparePlan, PlanBuilderBase.ModifyPlanBase
   * @return  a ModifyPlan object
   */
   public abstract ModifyPlan except(ModifyPlan right);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan existsJoin(ModifyPlan right);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @param keys  The equijoin from one or more calls to the op:on function.
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan existsJoin(ModifyPlan right, PlanJoinKey... keys);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @param keys  The equijoin from one or more calls to the op:on function.
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan existsJoin(ModifyPlan right, PlanJoinKeySeq keys);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @param keys  The equijoin from one or more calls to the op:on function.
+  * @param condition  A boolean expression that filters the join output rows.  (of <a href="{@docRoot}/doc-files/types/xs_boolean.html">xs:boolean</a>)
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan existsJoin(ModifyPlan right, PlanJoinKeySeq keys, boolean condition);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @param keys  The equijoin from one or more calls to the op:on function.
+  * @param condition  A boolean expression that filters the join output rows.  (of <a href="{@docRoot}/doc-files/types/xs_boolean.html">xs:boolean</a>)
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan existsJoin(ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition);
 /**
   * This method counts values for multiple grouping key columns. 
   * @param keys  This parameter specifies the list of column keys for performing counts. For each column, the operation determines the unique values of that column and produces a separate count for the rows with that value.  A column can be named with a string or a column parameter function such as op:col or constructed from an expression with the op:as function. See {@link PlanBuilder#colSeq(String...)}
@@ -1491,6 +1528,42 @@ public interface ModifyPlan extends PreparePlan, PlanBuilderBase.ModifyPlanBase
   * @return  a ModifyPlan object
   */
   public abstract ModifyPlan joinFullOuter(ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan notExistsJoin(ModifyPlan right);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @param keys  The equijoin from one or more calls to the op:on function.
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan notExistsJoin(ModifyPlan right, PlanJoinKey... keys);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @param keys  The equijoin from one or more calls to the op:on function.
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan notExistsJoin(ModifyPlan right, PlanJoinKeySeq keys);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @param keys  The equijoin from one or more calls to the op:on function.
+  * @param condition  A boolean expression that filters the join output rows.  (of <a href="{@docRoot}/doc-files/types/xs_boolean.html">xs:boolean</a>)
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan notExistsJoin(ModifyPlan right, PlanJoinKeySeq keys, boolean condition);
+/**
+  * This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. 
+  * @param right  The row set from the right view.
+  * @param keys  The equijoin from one or more calls to the op:on function.
+  * @param condition  A boolean expression that filters the join output rows.  (of <a href="{@docRoot}/doc-files/types/xs_boolean.html">xs:boolean</a>)
+  * @return  a ModifyPlan object
+  */
+  public abstract ModifyPlan notExistsJoin(ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition);
 /**
   * This method sorts the row set by the specified order definition.
   * @param keys  The specified column or sortdef output from the op:asc or op:desc function. See {@link PlanBuilder#sortKeySeq(PlanSortKey...)}

marklogic-client-api/src/main/java/com/marklogic/client/expression/SemExpr.java

@@ -75,6 +75,16 @@ public interface SemExpr extends SemValue {
   * @return  a server expression with the <a href="{@docRoot}/doc-files/types/sem_iri.html">sem:iri</a> server data type
   */
   public ServerExpression datatype(ServerExpression value);
+/**
+  * Returns the iri of the default graph. 
+  *
+  * <a name="ml-server-type-default-graph-iri"></a>
+  
+  * <p>
+  * Provides a client interface to the <a href="http://docs.marklogic.com/sem:default-graph-iri" target="mlserverdoc">sem:default-graph-iri</a> server function.
+  * @return  a server expression with the <a href="{@docRoot}/doc-files/types/sem_iri.html">sem:iri</a> server data type
+  */
+  public ServerExpression defaultGraphIri();
 /**
   * The IF function form evaluates the first argument, interprets it as a effective boolean value, then returns the value of expression2 if the EBV is true, otherwise it returns the value of expression3. Only one of expression2 and expression3 is evaluated. If evaluating the first argument raises an error, then an error is raised for the evaluation of the IF expression. This XQuery function backs up the SPARQL IF() functional form. 
   *

marklogic-client-api/src/main/java/com/marklogic/client/impl/PlanBuilderImpl.java

@@ -1539,6 +1539,15 @@ static abstract class ModifyPlanImpl extends PlanBuilderSubImpl.PreparePlanSubIm
     }
 
 
+  @Override
+  public ModifyPlan bind(PlanExprColSeq columns) {
+    if (columns == null) {
+      throw new IllegalArgumentException("columns parameter for bind() cannot be null");
+    }
+    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "bind", new Object[]{ columns });
+  }
+
+    
   @Override
   public ModifyPlan bindAs(String column, ServerExpression expression) {
     return bindAs((column == null) ? (PlanColumn) null : col(column), expression);
@@ -1563,6 +1572,45 @@ public ModifyPlan except(ModifyPlan right) {
   }
 
 
+  @Override
+  public ModifyPlan existsJoin(ModifyPlan right) {
+    if (right == null) {
+      throw new IllegalArgumentException("right parameter for existsJoin() cannot be null");
+    }
+    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "exists-join", new Object[]{ right });
+  }
+
+    
+  @Override
+  public ModifyPlan existsJoin(ModifyPlan right, PlanJoinKey... keys) {
+    return existsJoin(right, new JoinKeySeqListImpl(keys));
+  }
+
+    
+  @Override
+  public ModifyPlan existsJoin(ModifyPlan right, PlanJoinKeySeq keys) {
+    if (right == null) {
+      throw new IllegalArgumentException("right parameter for existsJoin() cannot be null");
+    }
+    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "exists-join", new Object[]{ right, keys });
+  }
+
+    
+  @Override
+  public ModifyPlan existsJoin(ModifyPlan right, PlanJoinKeySeq keys, boolean condition) {
+    return existsJoin(right, keys, xs.booleanVal(condition));
+  }
+
+    
+  @Override
+  public ModifyPlan existsJoin(ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition) {
+    if (right == null) {
+      throw new IllegalArgumentException("right parameter for existsJoin() cannot be null");
+    }
+    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "exists-join", new Object[]{ right, keys, condition });
+  }
+
+    
   @Override
   public ModifyPlan facetBy(PlanExprColSeq keys) {
     if (keys == null) {
@@ -1785,6 +1833,45 @@ public ModifyPlan joinLeftOuter(ModifyPlan right, PlanJoinKeySeq keys, ServerExp
   }
 
 
+  @Override
+  public ModifyPlan notExistsJoin(ModifyPlan right) {
+    if (right == null) {
+      throw new IllegalArgumentException("right parameter for notExistsJoin() cannot be null");
+    }
+    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "not-exists-join", new Object[]{ right });
+  }
+
+    
+  @Override
+  public ModifyPlan notExistsJoin(ModifyPlan right, PlanJoinKey... keys) {
+    return notExistsJoin(right, new JoinKeySeqListImpl(keys));
+  }
+
+    
+  @Override
+  public ModifyPlan notExistsJoin(ModifyPlan right, PlanJoinKeySeq keys) {
+    if (right == null) {
+      throw new IllegalArgumentException("right parameter for notExistsJoin() cannot be null");
+    }
+    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "not-exists-join", new Object[]{ right, keys });
+  }
+
+    
+  @Override
+  public ModifyPlan notExistsJoin(ModifyPlan right, PlanJoinKeySeq keys, boolean condition) {
+    return notExistsJoin(right, keys, xs.booleanVal(condition));
+  }
+
+    
+  @Override
+  public ModifyPlan notExistsJoin(ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition) {
+    if (right == null) {
+      throw new IllegalArgumentException("right parameter for notExistsJoin() cannot be null");
+    }
+    return new PlanBuilderSubImpl.ModifyPlanSubImpl(this, "op", "not-exists-join", new Object[]{ right, keys, condition });
+  }
+
+    
   @Override
   public ModifyPlan orderBy(PlanSortKeySeq keys) {
     if (keys == null) {

marklogic-client-api/src/main/java/com/marklogic/client/impl/SemExprImpl.java

@@ -72,6 +72,12 @@ public ServerExpression datatype(ServerExpression value) {
   }
 
 
+  @Override
+  public ServerExpression defaultGraphIri() {
+    return new IriCallImpl("sem", "default-graph-iri", new Object[]{  });
+  }
+
+  
   @Override
   public ServerExpression ifExpr(ServerExpression condition, ServerExpression then, ServerExpression elseExpr) {
     if (condition == null) {

marklogic-client-api/src/main/javadoc/doc-files/types/sem_iri.html

@@ -58,23 +58,29 @@
 	    <td><a href="http://docs.marklogic.com/sem:datatype" target="mlserverdoc">server</a></td>
 	  </tr>
 <tr class="rowColor">
+	    <td class="colFirst">sem:iri</td>
+	    <td class="colLast"><span class="memberNameLink">sem:default-graph-iri</span>()</td>
+	    <td><a href="../../com/marklogic/client/expression/SemExpr.html#ml-server-type-default-graph-iri">java</a></td>
+	    <td><a href="http://docs.marklogic.com/sem:default-graph-iri" target="mlserverdoc">server</a></td>
+	  </tr>
+<tr class="altColor">
 	    <td class="colFirst">sem:iri</td>
 	    <td class="colLast"><span class="memberNameLink">sem:invalid-datatype</span>(<span><a href="sem_invalid.html">sem:invalid</a> <i>val</i></span>)</td>
 	    <td><a href="../../com/marklogic/client/expression/SemExpr.html#ml-server-type-invalid-datatype">java</a></td>
 	    <td><a href="http://docs.marklogic.com/sem:invalid-datatype" target="mlserverdoc">server</a></td>
 	  </tr>
-<tr class="altColor">
+<tr class="rowColor">
 	    <td class="colFirst">sem:iri</td>
 	    <td class="colLast"><span class="memberNameLink">sem:QName-to-iri</span>(<span><a href="xs_QName.html">xs:QName</a> <i>arg1</i></span>)</td>
 	    <td><a href="../../com/marklogic/client/expression/SemExpr.html#ml-server-type-QName-to-iri">java</a></td>
 	  </tr>
-<tr class="rowColor">
+<tr class="altColor">
 	    <td class="colFirst">sem:iri</td>
 	    <td class="colLast"><span class="memberNameLink">sem:unknown-datatype</span>(<span><a href="sem_unknown.html">sem:unknown</a> <i>val</i></span>)</td>
 	    <td><a href="../../com/marklogic/client/expression/SemExpr.html#ml-server-type-unknown-datatype">java</a></td>
 	    <td><a href="http://docs.marklogic.com/sem:unknown-datatype" target="mlserverdoc">server</a></td>
 	  </tr>
-<tr class="altColor">
+<tr class="rowColor">
 	    <td class="colFirst">sem:iri</td>
 	    <td class="colLast"><span class="memberNameLink">sem:uuid</span>()</td>
 	    <td><a href="../../com/marklogic/client/expression/SemExpr.html#ml-server-type-uuid">java</a></td>

marklogic-client-api/src/test/java/com/marklogic/client/test/PlanGeneratedTest.java

@@ -968,6 +968,11 @@ public void testSemDatatype1Exec() {
         executeTester("testSemDatatype1", p.sem.datatype(p.col("1")), false, "sem:iri", null, null, "http://www.w3.org/2001/XMLSchema#string", new ServerExpression[]{ p.xs.string("a") });
     }
 
+    @Test
+    public void testSemDefaultGraphIri0Exec() {
+        executeTester("testSemDefaultGraphIri0", p.sem.defaultGraphIri(), false, "sem:iri", null, null, "http://marklogic.com/semantics#default-graph", new ServerExpression[]{  });
+    }
+
     @Test
     public void testSemIfExpr3Exec() {
         executeTester("testSemIfExpr3", p.sem.ifExpr(p.col("1"), p.col("2"), p.col("3")), false, null, null, null, "a", new ServerExpression[]{ p.xs.booleanVal(true), p.xs.string("a"), p.xs.string("b") });