Namespace: xs

planBuilder. xs

Builds expressions to call functions in the xs server library for a row pipeline.
Since:
  • 2.1.1

Methods


anyURI(arg1) → {XsAnyURI}

Constructs or casts an expression to a XsAnyURI object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsAnyURI

base64Binary(arg1) → {XsBase64Binary}

Constructs or casts an expression to a XsBase64Binary object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsBase64Binary

boolean(arg1) → {XsBoolean}

Constructs or casts an expression to a XsBoolean object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsBoolean

byte(arg1) → {XsByte}

Constructs or casts an expression to a XsByte object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsByte

date(arg1) → {XsDate}

Constructs or casts an expression to a XsDate object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsDate

dateTime(arg1) → {XsDateTime}

Constructs or casts an expression to a XsDateTime object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsDateTime

dayTimeDuration(arg1) → {XsDayTimeDuration}

Constructs or casts an expression to a XsDayTimeDuration object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsDayTimeDuration

decimal(arg1) → {XsDecimal}

Constructs or casts an expression to a XsDecimal object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsDecimal

double(arg1) → {XsDouble}

Constructs or casts an expression to a XsDouble object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsDouble

float(arg1) → {XsFloat}

Constructs or casts an expression to a XsFloat object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsFloat

gDay(arg1) → {XsGDay}

Constructs or casts an expression to a XsGDay object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsGDay

gMonth(arg1) → {XsGMonth}

Constructs or casts an expression to a XsGMonth object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsGMonth

gMonthDay(arg1) → {XsGMonthDay}

Constructs or casts an expression to a XsGMonthDay object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsGMonthDay

gYear(arg1) → {XsGYear}

Constructs or casts an expression to a XsGYear object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsGYear

gYearMonth(arg1) → {XsGYearMonth}

Constructs or casts an expression to a XsGYearMonth object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsGYearMonth

hexBinary(arg1) → {XsHexBinary}

Constructs or casts an expression to a XsHexBinary object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsHexBinary

int(arg1) → {XsInt}

Constructs or casts an expression to a XsInt object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsInt

integer(arg1) → {XsInteger}

Constructs or casts an expression to a XsInteger object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsInteger

language(arg1) → {XsLanguage}

Constructs or casts an expression to a XsLanguage object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsLanguage

long(arg1) → {XsLong}

Constructs or casts an expression to a XsLong object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsLong

Name(arg1) → {XsName}

Constructs or casts an expression to a XsName object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsName

NCName(arg1) → {XsNCName}

Constructs or casts an expression to a XsNCName object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsNCName

negativeInteger(arg1) → {XsNegativeInteger}

Constructs or casts an expression to a XsNegativeInteger object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsNegativeInteger

NMTOKEN(arg1) → {XsNMTOKEN}

Constructs or casts an expression to a XsNMTOKEN object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsNMTOKEN

nonNegativeInteger(arg1) → {XsNonNegativeInteger}

Constructs or casts an expression to a XsNonNegativeInteger object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsNonNegativeInteger

nonPositiveInteger(arg1) → {XsNonPositiveInteger}

Constructs or casts an expression to a XsNonPositiveInteger object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsNonPositiveInteger

normalizedString(arg1) → {XsNormalizedString}

Constructs or casts an expression to a XsNormalizedString object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsNormalizedString

numeric(arg1) → {XsNumeric}

Constructs or casts an expression to a XsNumeric object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsNumeric

positiveInteger(arg1) → {XsPositiveInteger}

Constructs or casts an expression to a XsPositiveInteger object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsPositiveInteger

QName(arg1) → {XsQName}

Constructs or casts an expression to a XsQName object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsQName

short(arg1) → {XsShort}

Constructs or casts an expression to a XsShort object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsShort

string(arg1) → {XsString}

Constructs or casts an expression to a XsString object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsString

time(arg1) → {XsTime}

Constructs or casts an expression to a XsTime object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsTime

token(arg1) → {XsToken}

Constructs or casts an expression to a XsToken object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsToken

unsignedByte(arg1) → {XsUnsignedByte}

Constructs or casts an expression to a XsUnsignedByte object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsUnsignedByte

unsignedInt(arg1) → {XsUnsignedInt}

Constructs or casts an expression to a XsUnsignedInt object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsUnsignedInt

unsignedLong(arg1) → {XsUnsignedLong}

Constructs or casts an expression to a XsUnsignedLong object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsUnsignedLong

unsignedShort(arg1) → {XsUnsignedShort}

Constructs or casts an expression to a XsUnsignedShort object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsUnsignedShort

untypedAtomic(arg1) → {XsUntypedAtomic}

Constructs or casts an expression to a XsUntypedAtomic object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsUntypedAtomic

yearMonthDuration(arg1) → {XsYearMonthDuration}

Constructs or casts an expression to a XsYearMonthDuration object. Provides a client interface to a server function.
Parameters:
Name Type Argument Description
arg1 XsAnyAtomicType <optional>
the expression to construct or cast
Since:
  • 2.1.1
Returns:
Type
XsYearMonthDuration
Copyright 2014-2018 MarkLogic Corporation Documentation generated by JSDoc 3.5.5 on 2018-01-18T02:49:31-08:00 using the DocStrap template.