A Collection is a persistent sequence of node items.
More...
|
void | close () throws XQException |
| Closes the collection. More...
|
|
XQSequence | contents () throws XQException |
| This function returns the sequence of nodes of the collection. More...
|
|
void | deleteNodeFirst () throws XQException |
| This function deletes the first node from a collection. More...
|
|
void | deleteNodeLast () throws XQException |
| This function deletes the last node from a collection. More...
|
|
void | deleteNodes (XQSequence aNodes) throws XQException |
| This function deletes zero of more nodes from a collection. More...
|
|
void | deleteNodesFirst (long aNumNodes) throws XQException |
| This function deletes the n first nodes from a collection. More...
|
|
void | deleteNodesLast (long aNumNodes) throws XQException |
| This function deletes the n last nodes from a collection. More...
|
|
String | getName () throws XQException |
| Get the name of the collection. More...
|
|
ZorbaXQItemType | getType () throws XQException |
| Retrieves the sequence type for this (static declared) collection. More...
|
|
long | indexOf (XQItem aNode) throws XQException |
| This function returns the index of the given node in the collection. More...
|
|
void | insertNodesAfter (XQItem aTarget, XQSequence aNodes) throws XQException |
| This function inserts copies of the given nodes into a collection at the position directly following the given target node. More...
|
|
void | insertNodesBefore (XQItem aTarget, XQSequence aNodes) throws XQException |
| This function inserts copies of the given nodes into a collection at the position directly preceding the given target node. More...
|
|
void | insertNodesFirst (XQSequence aNodes) throws XQException |
| This function inserts copies of the given nodes at the beginning of the collection. More...
|
|
void | insertNodesLast (XQSequence aNodes) throws XQException |
| This function inserts copies of the given nodes at the end of the collection. More...
|
|
boolean | isClosed () |
| Checks if the collection is closed. More...
|
|
boolean | isStatic () throws XQException |
| The function checks if this collection has been statically declared. More...
|
|
A Collection is a persistent sequence of node items.
Instances of this class can be used to modify or retrieve the contents of a collection.
Definition at line 31 of file ZorbaXQCollection.java.
org.zorbaxquery.api.xqj.ZorbaXQCollection.ZorbaXQCollection |
( |
Collection |
col | ) |
|
|
inlineprotected |
void org.zorbaxquery.api.xqj.ZorbaXQCollection.close |
( |
| ) |
throws XQException |
|
inline |
Closes the collection.
Once the collection is closed, no method other than close or the isClosed method may be called on the collection object. Calling close on an ZorbaXQCollection object that is already closed has no effect.
- Exceptions
-
XQException | - if there is an error during closing the collection. |
Definition at line 47 of file ZorbaXQCollection.java.
XQSequence org.zorbaxquery.api.xqj.ZorbaXQCollection.contents |
( |
| ) |
throws XQException |
|
inline |
This function returns the sequence of nodes of the collection.
- Returns
- The sequence contained in the given collection.
Definition at line 71 of file ZorbaXQCollection.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollection.deleteNodeFirst |
( |
| ) |
throws XQException |
|
inline |
This function deletes the first node from a collection.
- Exceptions
-
XQException | if the collection doesn't contain any node. |
Definition at line 84 of file ZorbaXQCollection.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollection.deleteNodeLast |
( |
| ) |
throws XQException |
|
inline |
This function deletes the last node from a collection.
- Exceptions
-
XQException | if the collection doesn't contain any node. |
Definition at line 95 of file ZorbaXQCollection.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollection.deleteNodes |
( |
XQSequence |
aNodes | ) |
throws XQException |
|
inline |
This function deletes zero of more nodes from a collection.
- Parameters
-
aNodes | the nodes in the collection that should be deleted. |
- Exceptions
-
XQException | if any nodes in the given sequence is not a member of a collection or not all nodes of the sequence belong to the same collection. |
Definition at line 109 of file ZorbaXQCollection.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollection.deleteNodesFirst |
( |
long |
aNumNodes | ) |
throws XQException |
|
inline |
This function deletes the n first nodes from a collection.
- Exceptions
-
XQException | if the collection doesn't contain any node. |
Definition at line 125 of file ZorbaXQCollection.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollection.deleteNodesLast |
( |
long |
aNumNodes | ) |
throws XQException |
|
inline |
This function deletes the n last nodes from a collection.
- Exceptions
-
XQException | if the collection doesn't contain any node. |
Definition at line 136 of file ZorbaXQCollection.java.
String org.zorbaxquery.api.xqj.ZorbaXQCollection.getName |
( |
| ) |
throws XQException |
|
inline |
ZorbaXQItemType org.zorbaxquery.api.xqj.ZorbaXQCollection.getType |
( |
| ) |
throws XQException |
|
inline |
Retrieves the sequence type for this (static declared) collection.
- Returns
- the sequence type for the said collection, or 0 if this collection is not statically declared.
- See Also
- isStatic()
Definition at line 159 of file ZorbaXQCollection.java.
long org.zorbaxquery.api.xqj.ZorbaXQCollection.indexOf |
( |
XQItem |
aNode | ) |
throws XQException |
|
inline |
This function returns the index of the given node in the collection.
- Parameters
-
aNode | The node to retrieve the index from. |
- Returns
- Returns the position of the given node in the collection.
- Exceptions
-
XQException | if node is not contained in any collection. |
Definition at line 174 of file ZorbaXQCollection.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollection.insertNodesAfter |
( |
XQItem |
aTarget, |
|
|
XQSequence |
aNodes |
|
) |
| throws XQException |
|
inline |
This function inserts copies of the given nodes into a collection at the position directly following the given target node.
- Parameters
-
aTarget | the node in the collection after which the sequence should be inserted. |
aNodes | The sequences of nodes whose copies should be added to the collection. |
- Exceptions
-
XQException | if any nodes in the sequence is not a member of a collection or not all nodes of the sequence belong to the same collection. |
Definition at line 193 of file ZorbaXQCollection.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollection.insertNodesBefore |
( |
XQItem |
aTarget, |
|
|
XQSequence |
aNodes |
|
) |
| throws XQException |
|
inline |
This function inserts copies of the given nodes into a collection at the position directly preceding the given target node.
- Parameters
-
aTarget | the node in the collection before which the sequence should be inserted. |
aNodes | The sequences of nodes whose copies should be added to the collection. |
- Exceptions
-
XQException | if any nodes in the sequence is not a member of a collection or not all nodes of the sequence belong to the same collection. |
Definition at line 217 of file ZorbaXQCollection.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollection.insertNodesFirst |
( |
XQSequence |
aNodes | ) |
throws XQException |
|
inline |
This function inserts copies of the given nodes at the beginning of the collection.
- Parameters
-
aNodes | The sequences of nodes whose copies should be added to the collection. |
Definition at line 235 of file ZorbaXQCollection.java.
void org.zorbaxquery.api.xqj.ZorbaXQCollection.insertNodesLast |
( |
XQSequence |
aNodes | ) |
throws XQException |
|
inline |
This function inserts copies of the given nodes at the end of the collection.
- Parameters
-
aNodes | The sequences of nodes whose copies should be added to the collection. |
Definition at line 253 of file ZorbaXQCollection.java.
boolean org.zorbaxquery.api.xqj.ZorbaXQCollection.isClosed |
( |
| ) |
|
|
inline |
Checks if the collection is closed.
- Returns
- true if the collection is in a closed state, false otherwise
Definition at line 61 of file ZorbaXQCollection.java.
boolean org.zorbaxquery.api.xqj.ZorbaXQCollection.isStatic |
( |
| ) |
throws XQException |
|
inline |
The function checks if this collection has been statically declared.
- Returns
- true if the collection is a static collection, false otherwise.
Definition at line 268 of file ZorbaXQCollection.java.
The documentation for this class was generated from the following file: