org.xmldb.api.base
public interface ResourceSet
ResourceSet
is obtained as the result of a query.Modifier and Type | Method and Description |
---|---|
void |
addResource(Resource res)
Adds a
Resource instance to the set. |
void |
clear()
Removes all
Resource instances from the set. |
ResourceIterator |
getIterator()
Returns an iterator over all
Resource instances stored in the set. |
Resource |
getMembersAsResource()
Returns a Resource containing an XML representation of all resources
stored in the set.
|
Resource |
getResource(long index)
Returns the
Resource instance stored at the index specified
by index. |
long |
getSize()
Returns the number of resources contained in the set.
|
void |
removeResource(long index)
Removes the Resource located at
index from the set. |
Resource getResource(long index) throws XMLDBException
Resource
instance stored at the index specified
by index.
If the underlying implementation uses a paging or streaming optimization
for retrieving Resource instances. Calling this method MAY result in a
block until the requested Resource has been downloaded.index
- the index of the resource to retrieve.Resource
instanceXMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.ErrorCodes.NO_SUCH_RESOURCE if the index is out of range for the
set.
void addResource(Resource res) throws XMLDBException
Resource
instance to the set.res
- The Resource
to add to the set.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.void removeResource(long index) throws XMLDBException
index
from the set.index
- The index of the Resource
instance to remove.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.ResourceIterator getIterator() throws XMLDBException
Resource
instances stored in the set.ResourceIterator
over all Resource
instances in the set.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.Resource getMembersAsResource() throws XMLDBException
Resource
instance containing an XML representation
of all set members.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.long getSize() throws XMLDBException
Resource
instances. Calling this method MAY
force the downloading of all set members before the size can be determined.Resource
instances in the set.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.void clear() throws XMLDBException
Resource
instances from the set.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.