org.xmldb.api.base

Interface ResourceSet

public interface ResourceSet

ResourceSet is a container for a set of resources. Generally a ResourceSet is obtained as the result of a query.
Method Summary
voidaddResource(Resource res)
Adds a Resource instance to the set.
voidclear()
Removes all Resource instances from the set.
ResourceIteratorgetIterator()
Returns an iterator over all Resource instances stored in the set.
ResourcegetMembersAsResource()
Returns a Resource containing an XML representation of all resources stored in the set.
ResourcegetResource(long index)
Returns the Resource instance stored at the index specified by index.
longgetSize()
Returns the number of resources contained in the set.
voidremoveResource(long index)
Removes the Resource located at index from the set.

Method Detail

addResource

public void addResource(Resource res)
Adds a Resource instance to the set.

Parameters: res The Resource to add to the set.

Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

clear

public void clear()
Removes all Resource instances from the set.

Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

getIterator

public ResourceIterator getIterator()
Returns an iterator over all Resource instances stored in the set.

Returns: a ResourceIterator over all Resource instances in the set.

Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

getMembersAsResource

public Resource getMembersAsResource()
Returns a Resource containing an XML representation of all resources stored in the set.

TODO: Specify the schema used for this

Returns: A Resource instance containing an XML representation of all set members.

Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

getResource

public Resource getResource(long index)
Returns the 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.

Parameters: index the index of the resource to retrieve.

Returns: The Resource instance

Throws: XMLDBException 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.

getSize

public long getSize()
Returns the number of resources contained in the set.

If the underlying implementation uses a paging or streaming optimization for retrieving Resource instances. Calling this method MAY force the downloading of all set members before the size can be determined.

Returns: The number of Resource instances in the set.

Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

removeResource

public void removeResource(long index)
Removes the Resource located at index from the set.

Parameters: index The index of the Resource instance to remove.

Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.