lux.functions
Class FieldTerms

java.lang.Object
  net.sf.saxon.lib.ExtensionFunctionDefinition
      lux.functions.FieldTerms

All Implemented Interfaces:

Serializable

public class FieldTerms
extends net.sf.saxon.lib.ExtensionFunctionDefinition

function lux:field-terms($field-name as xs:string?, $start as xs:string?) as xs:anyAtomicItem*

This function accepts the name of a Lucene field, and a starting value, and returns the sequence of terms drawn from the field, ordered according to its natural order, starting with the first term that is >= the starting value.

If the $field-name argument is empty, the terms are drawn from the default field defined by the IndexConfiguration, generally the XmlTextField.

See Also:

Serialized Form

Constructor Summary

FieldTerms()

Method Summary

net.sf.saxon.value.SequenceType[]	getArgumentTypes()
net.sf.saxon.om.StructuredQName	getFunctionQName()
int	getMaximumNumberOfArguments()
int	getMinimumNumberOfArguments()
net.sf.saxon.value.SequenceType	getResultType(net.sf.saxon.value.SequenceType[] suppliedArgumentTypes)
net.sf.saxon.lib.ExtensionFunctionCall	makeCallExpression()
boolean	trustResultType()

Methods inherited from class net.sf.saxon.lib.ExtensionFunctionDefinition

dependsOnFocus, hasSideEffects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldTerms

public FieldTerms()

Method Detail

getFunctionQName

public net.sf.saxon.om.StructuredQName getFunctionQName()

Specified by:

getFunctionQName in class net.sf.saxon.lib.ExtensionFunctionDefinition

getArgumentTypes

public net.sf.saxon.value.SequenceType[] getArgumentTypes()

Specified by:

getArgumentTypes in class net.sf.saxon.lib.ExtensionFunctionDefinition

getMinimumNumberOfArguments

public int getMinimumNumberOfArguments()

Overrides:

getMinimumNumberOfArguments in class net.sf.saxon.lib.ExtensionFunctionDefinition

getMaximumNumberOfArguments

public int getMaximumNumberOfArguments()

Overrides:

getMaximumNumberOfArguments in class net.sf.saxon.lib.ExtensionFunctionDefinition

trustResultType

public boolean trustResultType()

Overrides:

trustResultType in class net.sf.saxon.lib.ExtensionFunctionDefinition

getResultType

public net.sf.saxon.value.SequenceType getResultType(net.sf.saxon.value.SequenceType[] suppliedArgumentTypes)

Specified by:

getResultType in class net.sf.saxon.lib.ExtensionFunctionDefinition

makeCallExpression

public net.sf.saxon.lib.ExtensionFunctionCall makeCallExpression()

Specified by:

makeCallExpression in class net.sf.saxon.lib.ExtensionFunctionDefinition