|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.xquery.DeferredFunctionCall
Field Summary |
Fields inherited from interface org.exist.xquery.value.Sequence |
EMPTY_SEQUENCE |
Method Summary | |
void |
add(Item item)
Add an item to the current sequence. |
void |
addAll(Sequence other)
Add all items of the other sequence to this item. |
void |
clearContext(int contextId)
For every item in the sequence, clear any context-dependant information that is stored during query processing. |
int |
conversionPreference(java.lang.Class javaClass)
Returns a preference indicator, indicating the preference of a value to be converted into the given Java class. |
AtomicValue |
convertTo(int requiredType)
Try to convert the sequence into an atomic value. |
boolean |
effectiveBooleanValue()
Get the effective boolean value of this sequence. |
int |
getCardinality()
Returns the cardinality of this sequence. |
DocumentSet |
getDocumentSet()
Returns the set of documents from which the node items in this sequence have been selected. |
int |
getItemType()
Return the primary type to which all items in this sequence belong. |
int |
getLength()
Returns the number of items contained in the sequence. |
java.lang.String |
getStringValue()
Convert the sequence to a string. |
boolean |
hasMany()
Returns whether the sequence more than one item or not. |
boolean |
hasOne()
Returns whether the sequence has just one item or not. |
boolean |
isCached()
Returns true if the sequence is the result of a previous operation and has been cached. |
boolean |
isEmpty()
Returns whether the sequence is empty or not. |
boolean |
isPersistentSet()
|
Item |
itemAt(int pos)
Returns the item located at the specified position within this sequence. |
SequenceIterator |
iterate()
Returns an iterator over all items in the sequence. |
void |
removeDuplicates()
Explicitely remove all duplicate nodes from this sequence. |
void |
setIsCached(boolean cached)
Indicates that the sequence is the result of a previous operation and has not been recomputed. |
void |
setSelfAsContext(int contextId)
|
java.lang.Object |
toJavaObject(java.lang.Class target)
Convert the value into an instance of the specified Java class. |
NodeSet |
toNodeSet()
Convert the sequence into a NodeSet. |
SequenceIterator |
unorderedIterator()
Returns an iterator over all items in the sequence. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public void add(Item item) throws XPathException
Sequence
XPathException
may be thrown
if the item's type is incompatible with this type of sequence (e.g. if the sequence
is a node set).
The sequence may or may not allow duplicate values.
add
in interface Sequence
item
-
XPathException
public void addAll(Sequence other) throws XPathException
Sequence
XPathException
may
be thrown if the type of the items in the other sequence is incompatible with
the primary type of this sequence.
addAll
in interface Sequence
other
-
XPathException
public void clearContext(int contextId)
Sequence
clearContext
in interface Sequence
public int conversionPreference(java.lang.Class javaClass)
Sequence
conversionPreference
in interface Sequence
javaClass
- public AtomicValue convertTo(int requiredType) throws XPathException
Sequence
Type
. An XPathException
is thrown if the conversion is impossible.
convertTo
in interface Sequence
requiredType
- one of the type constants defined in class Type
XPathException
public boolean effectiveBooleanValue() throws XPathException
Sequence
effectiveBooleanValue
in interface Sequence
XPathException
public int getCardinality()
Sequence
Cardinality
.
getCardinality
in interface Sequence
Cardinality
public DocumentSet getDocumentSet()
Sequence
getDocumentSet
in interface Sequence
public int getItemType()
Sequence
Type.NODE
for node sets, Type.ITEM
for other sequences with mixed items.
getItemType
in interface Sequence
public int getLength()
Sequence
getLength
in interface Sequence
public java.lang.String getStringValue() throws XPathException
Sequence
getStringValue
in interface Sequence
XPathException
public boolean hasMany()
Sequence
hasMany
in interface Sequence
true
is the sequence more than one itempublic boolean hasOne()
Sequence
hasOne
in interface Sequence
true
is the sequence has just one itempublic boolean isCached()
Sequence
isCached
in interface Sequence
public boolean isEmpty()
Sequence
isEmpty
in interface Sequence
true
is the sequence is emptypublic boolean isPersistentSet()
isPersistentSet
in interface Sequence
public Item itemAt(int pos)
Sequence
itemAt
in interface Sequence
pos
- public SequenceIterator iterate() throws XPathException
Sequence
iterate
in interface Sequence
XPathException
- TODOpublic void removeDuplicates()
Sequence
removeDuplicates
in interface Sequence
public void setIsCached(boolean cached)
Sequence
setIsCached
in interface Sequence
cached
- public void setSelfAsContext(int contextId)
setSelfAsContext
in interface Sequence
public java.lang.Object toJavaObject(java.lang.Class target) throws XPathException
Sequence
toJavaObject
in interface Sequence
target
-
XPathException
public NodeSet toNodeSet() throws XPathException
Sequence
toNodeSet
in interface Sequence
XPathException
- if the sequence contains items which are not nodes.public SequenceIterator unorderedIterator()
Sequence
unorderedIterator
in interface Sequence
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |