SemExpr (MarkLogic Java Client API 4.0.1 2017-05-03)

All Superinterfaces:

SemValue
```
public interface SemExpr
extends SemValue
```
Builds expressions to call functions in the sem server library for a row pipeline and constructs client values with sem.* server types.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`SemBlankSeqExpr`	`blankSeq(SemBlankExpr... items)` Constructs a sequence of SemBlankExpr items.
`SemBlankExpr`	`bnode()` This function returns an identifier for a blank node, allowing the construction of a triple that refers to a blank node.
`SemBlankExpr`	`bnode(XsAnyAtomicTypeExpr value)` This function returns an identifier for a blank node, allowing the construction of a triple that refers to a blank node.
`ItemSeqExpr`	`coalesce(ItemExpr... parameter1)` Returns the value of the first argument that evaluates without error.
`SemIriExpr`	`datatype(XsAnyAtomicTypeExpr value)` Returns the name of the simple type of the atomic value argument as a SPARQL style IRI.
`ItemSeqExpr`	`ifExpr(XsBooleanExpr condition, ItemSeqExpr then, ItemSeqExpr elseExpr)` 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.
`SemInvalidExpr`	`invalid(XsStringExpr string, SemIriExpr datatype)` Returns a `sem:invalid` value with the given literal value and datatype IRI.
`SemInvalidExpr`	`invalid(XsStringExpr string, String datatype)` Returns a `sem:invalid` value with the given literal value and datatype IRI.
`SemIriExpr`	`invalidDatatype(SemInvalidExpr val)` Returns the datatype IRI of a `sem:invalid` value.
`SemInvalidSeqExpr`	`invalidSeq(SemInvalidExpr... items)` Constructs a sequence of SemInvalidExpr items.
`SemIriExpr`	`iri(XsAnyAtomicTypeExpr stringIri)` This is a constructor function that takes a string and constructs an item of type `sem:iri` from it.
`SemIriSeqExpr`	`iriSeq(SemIriExpr... items)` Constructs a sequence of SemIriExpr items.
`XsQNameExpr`	`iriToQName(XsStringExpr arg1)`
`XsBooleanExpr`	`isBlank(XsAnyAtomicTypeExpr value)` Returns true if the argument is an RDF blank node - that is, derived from type `sem:blank`.
`XsBooleanExpr`	`isIRI(XsAnyAtomicTypeExpr value)` Returns true if the argument is an RDF IRI - that is, derived from type `sem:iri`, but not derived from type `sem:blank`.
`XsBooleanExpr`	`isLiteral(XsAnyAtomicTypeExpr value)` Returns true if the argument is an RDF literal - that is, derived from type `xs:anyAtomicType`, but not derived from type `sem:iri`.
`XsBooleanExpr`	`isNumeric(XsAnyAtomicTypeExpr value)` Returns true if the argument is a valid numeric RDF literal.
`XsStringExpr`	`lang(XsAnyAtomicTypeExpr value)` Returns the language of the value passed in, or the empty string if the value has no language.
`XsBooleanExpr`	`langMatches(XsStringExpr langTag, String langRange)` Returns true if `lang-tag` matches `lang-range` according to the basic filtering scheme defined in RFC4647.
`XsBooleanExpr`	`langMatches(XsStringExpr langTag, XsStringExpr langRange)` Returns true if `lang-tag` matches `lang-range` according to the basic filtering scheme defined in RFC4647.
`SemIriExpr`	`QNameToIri(XsQNameExpr arg1)`
`XsDoubleExpr`	`random()` Returns a random double between 0 and 1.
`XsBooleanExpr`	`sameTerm(XsAnyAtomicTypeExpr a, String b)` Returns true if the arguments are the same RDF term as defined by the RDF concepts specification.
`XsBooleanExpr`	`sameTerm(XsAnyAtomicTypeExpr a, XsAnyAtomicTypeExpr b)` Returns true if the arguments are the same RDF term as defined by the RDF concepts specification.
`XsStringExpr`	`timezoneString(XsDateTimeExpr value)` Returns the timezone of an `xs:dateTime` value as a string.
`XsAnyAtomicTypeExpr`	`typedLiteral(XsStringExpr value, SemIriExpr datatype)` Returns a value to represent the RDF typed literal with lexical value `value` and datatype IRI `datatype`.
`XsAnyAtomicTypeExpr`	`typedLiteral(XsStringExpr value, String datatype)` Returns a value to represent the RDF typed literal with lexical value `value` and datatype IRI `datatype`.
`SemUnknownExpr`	`unknown(XsStringExpr string, SemIriExpr datatype)` Returns a `sem:unknown` value with the given literal value and datatype IRI.
`SemUnknownExpr`	`unknown(XsStringExpr string, String datatype)` Returns a `sem:unknown` value with the given literal value and datatype IRI.
`SemIriExpr`	`unknownDatatype(SemUnknownExpr val)` Returns the datatype IRI of a `sem:unknown` value.
`SemUnknownSeqExpr`	`unknownSeq(SemUnknownExpr... items)` Constructs a sequence of SemUnknownExpr items.
`SemIriExpr`	`uuid()` Return a UUID URN (RFC4122) as a `sem:iri` value.
`XsStringExpr`	`uuidString()` Return a string that is the scheme specific part of random UUID URN (RFC4122).

Methods inherited from interface com.marklogic.client.expression.SemValue
iri, iriSeq, iriSeq, rulesetStore, rulesetStore, rulesetStore, store, store, stores

- Method Detail
  - bnode
```
SemBlankExpr bnode()
```
    This function returns an identifier for a blank node, allowing the construction of a triple that refers to a blank node. This XQuery function backs up the SPARQL BNODE() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:bnode
    
    Returns:
    
    a SemBlankExpr expression
  - bnode
```
SemBlankExpr bnode(XsAnyAtomicTypeExpr value)
```
    This function returns an identifier for a blank node, allowing the construction of a triple that refers to a blank node. This XQuery function backs up the SPARQL BNODE() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:bnode
    
    Parameters:
    
    value - If provided, the same blank node identifier is returned for the same argument value passed to the function.
    
    Returns:
    
    a SemBlankExpr expression
  - coalesce
```
ItemSeqExpr coalesce(ItemExpr... parameter1)
```
    Returns the value of the first argument that evaluates without error. This XQuery function backs up the SPARQL COALESCE() functional form.
    This function is a built-in.
    Provides a client interface to a server function. See sem:coalesce
    
    Parameters:
    
    parameter1 - A value.
    
    Returns:
    
    a ItemSeqExpr expression sequence
  - datatype
```
SemIriExpr datatype(XsAnyAtomicTypeExpr value)
```
    Returns the name of the simple type of the atomic value argument as a SPARQL style IRI. If the value is derived from sem:unknown or sem:invalid, the datatype IRI part of those values is returned. This XQuery function backs up the SPARQL datatype() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:datatype
    
    Parameters:
    
    value - The value to return the type of.
    
    Returns:
    
    a SemIriExpr expression
  - ifExpr
```
ItemSeqExpr ifExpr(XsBooleanExpr condition,
                   ItemSeqExpr then,
                   ItemSeqExpr elseExpr)
```
    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.
    This function is a built-in.
    Provides a client interface to a server function. See sem:if
    
    Parameters:
    
    condition - The condition.
    
    then - The then expression.
    
    elseExpr - The else expression.
    
    Returns:
    
    a ItemSeqExpr expression sequence
  - invalid
```
SemInvalidExpr invalid(XsStringExpr string,
                       String datatype)
```
    Returns a sem:invalid value with the given literal value and datatype IRI. The sem:invalid type extends xs:untypedAtomic, and represents an RDF value whose literal string is invalid according to the schema for it’s datatype.
    This function is a built-in.
    Provides a client interface to a server function. See sem:invalid
    
    Parameters:
    
    string - The lexical value.
    
    datatype - The datatype IRI.
    
    Returns:
    
    a SemInvalidExpr expression
  - invalid
```
SemInvalidExpr invalid(XsStringExpr string,
                       SemIriExpr datatype)
```
    Returns a sem:invalid value with the given literal value and datatype IRI. The sem:invalid type extends xs:untypedAtomic, and represents an RDF value whose literal string is invalid according to the schema for it’s datatype.
    This function is a built-in.
    Provides a client interface to a server function. See sem:invalid
    
    Parameters:
    
    string - The lexical value.
    
    datatype - The datatype IRI.
    
    Returns:
    
    a SemInvalidExpr expression
  - invalidDatatype
```
SemIriExpr invalidDatatype(SemInvalidExpr val)
```
    Returns the datatype IRI of a sem:invalid value.
    This function is a built-in.
    Provides a client interface to a server function. See sem:invalid-datatype
    
    Parameters:
    
    val - The sem:invalid value.
    
    Returns:
    
    a SemIriExpr expression
  - iri
```
SemIriExpr iri(XsAnyAtomicTypeExpr stringIri)
```
    This is a constructor function that takes a string and constructs an item of type sem:iri from it.
    Provides a client interface to a server function. See sem:iri
    
    Parameters:
    
    stringIri - The string with which to construct the sem:iri.
    
    Returns:
    
    a SemIriExpr expression
  - iriToQName
```
XsQNameExpr iriToQName(XsStringExpr arg1)
```
  - isBlank
```
XsBooleanExpr isBlank(XsAnyAtomicTypeExpr value)
```
    Returns true if the argument is an RDF blank node - that is, derived from type sem:blank. This XQuery function backs up the SPARQL isBlank() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:isBlank
    
    Parameters:
    
    value - The value to test.
    
    Returns:
    
    a XsBooleanExpr expression
  - isIRI
```
XsBooleanExpr isIRI(XsAnyAtomicTypeExpr value)
```
    Returns true if the argument is an RDF IRI - that is, derived from type sem:iri, but not derived from type sem:blank. This XQuery function backs up the SPARQL isIRI() and isURI() functions.
    This function is a built-in.
    Provides a client interface to a server function. See sem:isIRI
    
    Parameters:
    
    value - The value to test.
    
    Returns:
    
    a XsBooleanExpr expression
  - isLiteral
```
XsBooleanExpr isLiteral(XsAnyAtomicTypeExpr value)
```
    Returns true if the argument is an RDF literal - that is, derived from type xs:anyAtomicType, but not derived from type sem:iri. This XQuery function backs up the SPARQL isLiteral() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:isLiteral
    
    Parameters:
    
    value - The value to test.
    
    Returns:
    
    a XsBooleanExpr expression
  - isNumeric
```
XsBooleanExpr isNumeric(XsAnyAtomicTypeExpr value)
```
    Returns true if the argument is a valid numeric RDF literal. This XQuery function backs up the SPARQL isNumeric() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:isNumeric
    
    Parameters:
    
    value - The value to test.
    
    Returns:
    
    a XsBooleanExpr expression
  - lang
```
XsStringExpr lang(XsAnyAtomicTypeExpr value)
```
    Returns the language of the value passed in, or the empty string if the value has no language. Only values derived from rdf:langString have a language. This XQuery function backs up the SPARQL lang() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:lang
    
    Parameters:
    
    value - The value to return the language of.
    
    Returns:
    
    a XsStringExpr expression
  - langMatches
```
XsBooleanExpr langMatches(XsStringExpr langTag,
                          String langRange)
```
    Returns true if lang-tag matches lang-range according to the basic filtering scheme defined in RFC4647. This XQuery function backs up the SPARQL langMatches() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:langMatches
    
    Parameters:
    
    langTag - The language tag.
    
    langRange - The language range.
    
    Returns:
    
    a XsBooleanExpr expression
  - langMatches
```
XsBooleanExpr langMatches(XsStringExpr langTag,
                          XsStringExpr langRange)
```
    Returns true if lang-tag matches lang-range according to the basic filtering scheme defined in RFC4647. This XQuery function backs up the SPARQL langMatches() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:langMatches
    
    Parameters:
    
    langTag - The language tag.
    
    langRange - The language range.
    
    Returns:
    
    a XsBooleanExpr expression
  - QNameToIri
```
SemIriExpr QNameToIri(XsQNameExpr arg1)
```
  - random
```
XsDoubleExpr random()
```
    Returns a random double between 0 and 1. This XQuery function backs up the SPARQL RAND() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:random
  - sameTerm
```
XsBooleanExpr sameTerm(XsAnyAtomicTypeExpr a,
                       String b)
```
    Returns true if the arguments are the same RDF term as defined by the RDF concepts specification. This XQuery function backs up the SPARQL sameTerm() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:sameTerm
    
    Parameters:
    
    a - The first value to test.
    
    b - The second value to test.
    
    Returns:
    
    a XsBooleanExpr expression
  - sameTerm
```
XsBooleanExpr sameTerm(XsAnyAtomicTypeExpr a,
                       XsAnyAtomicTypeExpr b)
```
    Returns true if the arguments are the same RDF term as defined by the RDF concepts specification. This XQuery function backs up the SPARQL sameTerm() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:sameTerm
    
    Parameters:
    
    a - The first value to test.
    
    b - The second value to test.
    
    Returns:
    
    a XsBooleanExpr expression
  - timezoneString
```
XsStringExpr timezoneString(XsDateTimeExpr value)
```
    Returns the timezone of an xs:dateTime value as a string. This XQuery function backs up the SPARQL TZ() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:timezone-string
    
    Parameters:
    
    value - The dateTime value
    
    Returns:
    
    a XsStringExpr expression
  - typedLiteral
```
XsAnyAtomicTypeExpr typedLiteral(XsStringExpr value,
                                 String datatype)
```
    Returns a value to represent the RDF typed literal with lexical value value and datatype IRI datatype. Returns a value of type sem:unknown for datatype IRIs for which there is no schema, and a value of type sem:invalid for lexical values which are invalid according to the schema for the given datatype. This XQuery function backs up the SPARQL STRDT() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:typed-literal
    
    Parameters:
    
    value - The lexical value.
    
    datatype - The datatype IRI.
    
    Returns:
    
    a XsAnyAtomicTypeExpr expression
  - typedLiteral
```
XsAnyAtomicTypeExpr typedLiteral(XsStringExpr value,
                                 SemIriExpr datatype)
```
    Returns a value to represent the RDF typed literal with lexical value value and datatype IRI datatype. Returns a value of type sem:unknown for datatype IRIs for which there is no schema, and a value of type sem:invalid for lexical values which are invalid according to the schema for the given datatype. This XQuery function backs up the SPARQL STRDT() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:typed-literal
    
    Parameters:
    
    value - The lexical value.
    
    datatype - The datatype IRI.
    
    Returns:
    
    a XsAnyAtomicTypeExpr expression
  - unknown
```
SemUnknownExpr unknown(XsStringExpr string,
                       String datatype)
```
    Returns a sem:unknown value with the given literal value and datatype IRI. The sem:unknown type extends xs:untypedAtomic, and represents an RDF value with a datatype IRI for which no schema is available.
    This function is a built-in.
    Provides a client interface to a server function. See sem:unknown
    
    Parameters:
    
    string - The lexical value.
    
    datatype - The datatype IRI.
    
    Returns:
    
    a SemUnknownExpr expression
  - unknown
```
SemUnknownExpr unknown(XsStringExpr string,
                       SemIriExpr datatype)
```
    Returns a sem:unknown value with the given literal value and datatype IRI. The sem:unknown type extends xs:untypedAtomic, and represents an RDF value with a datatype IRI for which no schema is available.
    This function is a built-in.
    Provides a client interface to a server function. See sem:unknown
    
    Parameters:
    
    string - The lexical value.
    
    datatype - The datatype IRI.
    
    Returns:
    
    a SemUnknownExpr expression
  - unknownDatatype
```
SemIriExpr unknownDatatype(SemUnknownExpr val)
```
    Returns the datatype IRI of a sem:unknown value.
    This function is a built-in.
    Provides a client interface to a server function. See sem:unknown-datatype
    
    Parameters:
    
    val - The sem:unknown value.
    
    Returns:
    
    a SemIriExpr expression
  - uuid
```
SemIriExpr uuid()
```
    Return a UUID URN (RFC4122) as a sem:iri value. This XQuery function backs up the SPARQL UUID() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:uuid
  - uuidString
```
XsStringExpr uuidString()
```
    Return a string that is the scheme specific part of random UUID URN (RFC4122). This XQuery function backs up the SPARQL STRUUID() function.
    This function is a built-in.
    Provides a client interface to a server function. See sem:uuid-string
  - blankSeq
```
SemBlankSeqExpr blankSeq(SemBlankExpr... items)
```
    Constructs a sequence of SemBlankExpr items.
  - invalidSeq
```
SemInvalidSeqExpr invalidSeq(SemInvalidExpr... items)
```
    Constructs a sequence of SemInvalidExpr items.
  - iriSeq
```
SemIriSeqExpr iriSeq(SemIriExpr... items)
```
    Constructs a sequence of SemIriExpr items.
  - unknownSeq
```
SemUnknownSeqExpr unknownSeq(SemUnknownExpr... items)
```
    Constructs a sequence of SemUnknownExpr items.

Interface SemExpr

Method Summary

Methods inherited from interface com.marklogic.client.expression.SemValue

Method Detail

bnode

bnode

coalesce

datatype

ifExpr

invalid

invalid

invalidDatatype

iri

iriToQName

isBlank

isIRI

isLiteral

isNumeric

lang

langMatches

langMatches

QNameToIri

random

sameTerm

sameTerm

timezoneString

typedLiteral

typedLiteral

unknown

unknown

unknownDatatype

uuid

uuidString

blankSeq

invalidSeq

iriSeq

unknownSeq