lux.functions
Class FieldValues

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

All Implemented Interfaces:

Serializable

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

function lux:field-values($field-name as xs:string, $node as node()) as xs:anyAtomicItem*

Accepts the name of a lucene field and optionally, a node, and returns any stored value(s) of the field for the document containing the node, or the context item if no node is specified.

If the node (or context item) is not a node drawn from the index, lux:field will return the empty sequence.

Order by expressions containing lux:field-values calls are subject to special optimization and are often able to be implemented by index-optimized sorting in Lucene (only for string-valued fields). An error results if an attempt is made to sort by a field that has multiple values for any of the documents in the sequence.

See Also:

Serialized Form

Constructor Summary

FieldValues()

Method Summary

boolean	dependsOnFocus()
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

hasSideEffects

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldValues

public FieldValues()

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

dependsOnFocus

public boolean dependsOnFocus()

Overrides:

dependsOnFocus 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