org.exist.xquery.value
Class FunctionReference

java.lang.Object
  extended byorg.exist.xquery.value.AtomicValue
      extended byorg.exist.xquery.value.FunctionReference
All Implemented Interfaces:
java.lang.Comparable, Indexable, Item, Sequence

public class FunctionReference
extends AtomicValue

Represents a reference to a function created by util:function that can be used with util:call.

Author:
wolf

Field Summary
 
Fields inherited from class org.exist.xquery.value.AtomicValue
EMPTY_VALUE
 
Fields inherited from interface org.exist.xquery.value.Sequence
EMPTY_SEQUENCE
 
Constructor Summary
FunctionReference(FunctionCall fcall)
           
 
Method Summary
 int compareTo(java.text.Collator collator, AtomicValue other)
           
 boolean compareTo(java.text.Collator collator, int operator, AtomicValue other)
           
 AtomicValue convertTo(int requiredType)
          Convert this item into an atomic value, whose type corresponds to the specified target type.
 FunctionCall getFunctionCall()
           
 java.lang.String getStringValue()
          Return the string value of this item (see the definition of string value in XPath).
 int getType()
          Return the type of this item according to the type constants defined in class Type.
 AtomicValue max(java.text.Collator collator, AtomicValue other)
           
 AtomicValue min(java.text.Collator collator, AtomicValue other)
           
 
Methods inherited from class org.exist.xquery.value.AtomicValue
add, addAll, atomize, clearContext, compareTo, contains, conversionPreference, copyTo, deserialize, dump, effectiveBooleanValue, endsWith, getCardinality, getDocumentSet, getItemType, getLength, hasMany, hasOne, isCached, isEmpty, isPersistentSet, itemAt, iterate, promote, removeDuplicates, serialize, serializeValue, setIsCached, setSelfAsContext, startsWith, toJavaObject, toNodeSet, toSAX, toSequence, toString, unorderedIterator
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FunctionReference

public FunctionReference(FunctionCall fcall)
Method Detail

getFunctionCall

public FunctionCall getFunctionCall()

getType

public int getType()
Description copied from interface: Item
Return the type of this item according to the type constants defined in class Type.

Specified by:
getType in interface Item
Overrides:
getType in class AtomicValue

getStringValue

public java.lang.String getStringValue()
                                throws XPathException
Description copied from interface: Item
Return the string value of this item (see the definition of string value in XPath).

Specified by:
getStringValue in interface Item
Specified by:
getStringValue in class AtomicValue
Throws:
XPathException

convertTo

public AtomicValue convertTo(int requiredType)
                      throws XPathException
Description copied from interface: Item
Convert this item into an atomic value, whose type corresponds to the specified target type. requiredType should be one of the type constants defined in Type. An XPathException is thrown if the conversion is impossible.

Specified by:
convertTo in interface Item
Specified by:
convertTo in class AtomicValue
Throws:
XPathException

compareTo

public boolean compareTo(java.text.Collator collator,
                         int operator,
                         AtomicValue other)
                  throws XPathException
Specified by:
compareTo in class AtomicValue
Throws:
XPathException

compareTo

public int compareTo(java.text.Collator collator,
                     AtomicValue other)
              throws XPathException
Specified by:
compareTo in class AtomicValue
Throws:
XPathException

max

public AtomicValue max(java.text.Collator collator,
                       AtomicValue other)
                throws XPathException
Specified by:
max in class AtomicValue
Throws:
XPathException

min

public AtomicValue min(java.text.Collator collator,
                       AtomicValue other)
                throws XPathException
Specified by:
min in class AtomicValue
Throws:
XPathException


Copyright (C) Wolfgang Meier. All rights reserved.