[Xmldb-org-xapi] xapi/src/api/org/xmldb/api/base ResourceSet.java,1.1,1.2
Brought to you by:
reinhapa
Menu
▾
▴
[Xmldb-org-xapi] xapi/src/api/org/xmldb/api/base ResourceSet.java,1.1,1.2
|
From: Per N. <per...@us...> - 2004-07-17 16:59:46
|
Update of /cvsroot/xmldb-org/xapi/src/api/org/xmldb/api/base In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25394/xmldb.org/xapi/src/api/org/xmldb/api/base Modified Files: ResourceSet.java Log Message: Fixed data type for ResourceSets (long in IDL is an int in Java, a java long is a long long in IDL) Xalan is needed for common to build properly Index: ResourceSet.java =================================================================== RCS file: /cvsroot/xmldb-org/xapi/src/api/org/xmldb/api/base/ResourceSet.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- ResourceSet.java 30 May 2004 11:54:44 -0000 1.1 +++ ResourceSet.java 17 Jul 2004 16:59:37 -0000 1.2 @@ -53,94 +53,107 @@ * on the XML:DB Initiative, please see <http://www.xmldb.org/>. */ - /** - * ResourceSet is a container for a set of resources. Generally a +/** + * ResourceSet is a container for a set of resources. Generally a * <code>ResourceSet</code> is obtained as the result of a query. */ public interface ResourceSet { - /** - * Returns the <code>Resource</code> instance stored at the index specified - * by index. - * <p /> - * 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. - * - * @param index the index of the resource to retrieve. - * @return The <code>Resource</code> instance - * @exception XMLDBException with expected error codes.<br /> - * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor - * specific errors that occur.<br /> - * <code>ErrorCodes.NO_SUCH_RESOURCE if the index is out of range for the - * set. - */ - Resource getResource(long index) throws XMLDBException; + /** + * Returns the <code>Resource</code> instance stored at the index specified + * by index. + * <p /> + * 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. + * + * @param index the index of the resource to retrieve. + * @return The <code>Resource</code> instance + * @throws XMLDBException with expected error codes.<br /> + * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor + * specific errors that occur.<br /> + * <code>ErrorCodes.NO_SUCH_RESOURCE if the index is out of range for the + * set. + */ + Resource getResource(int index) throws XMLDBException; - /** - * Adds a <code>Resource</code> instance to the set. - * - * @param res The <code>Resource</code> to add to the set. - * @exception XMLDBException with expected error codes.<br /> - * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor - * specific errors that occur.<br /> - */ - void addResource(Resource res) throws XMLDBException; + /** + * Adds a <code>Resource</code> instance to the set. + * + * @param res The <code>Resource</code> to add to the set. + * @throws XMLDBException with expected error codes.<br /> + * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor + * specific errors that occur.<br /> + */ + void addResource(Resource res) throws XMLDBException; - /** - * Removes the Resource located at <code>index</code> from the set. - * - * @param index The index of the <code>Resource</code> instance to remove. - * @exception XMLDBException with expected error codes.<br /> - * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor - * specific errors that occur.<br /> - */ - void removeResource(long index) throws XMLDBException; + /** + * Adds all <code>Resource</code> instances in the resourceSet + * to this set. + * + * @param rSet The <code>ResourceSet</code> containing all the <code>Resource</code>'s + * to add to the set. + * @throws XMLDBException with expected error codes.<br /> + * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor + * specific errors that occur.<br /> + */ + void addAll(ResourceSet rSet) throws XMLDBException; - /** - * Returns an iterator over all <code>Resource</code> instances stored in the set. - * - * @return a <code>ResourceIterator</code> over all <code>Resource</code> - * instances in the set. - * @exception XMLDBException with expected error codes.<br /> - * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor - * specific errors that occur.<br /> - */ - ResourceIterator getIterator() throws XMLDBException; - /** - * Returns a Resource containing an XML representation of all resources - * stored in the set. <p /> - * TODO: Specify the schema used for this - * - * @return A <code>Resource</code> instance containing an XML representation - * of all set members. - * @exception XMLDBException with expected error codes.<br /> - * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor - * specific errors that occur.<br /> - */ - Resource getMembersAsResource() throws XMLDBException; + /** + * Removes the Resource located at <code>index</code> from the set. + * + * @param index The index of the <code>Resource</code> instance to remove. + * @throws XMLDBException with expected error codes.<br /> + * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor + * specific errors that occur.<br /> + */ + void removeResource(int index) throws XMLDBException; - /** - * Returns the number of resources contained in the set. - * <p /> - * If the underlying implementation uses a paging or streaming optimization - * for retrieving <code>Resource</code> instances. Calling this method MAY - * force the downloading of all set members before the size can be determined. - * - * @return The number of <code>Resource</code> instances in the set. - * @exception XMLDBException with expected error codes.<br /> - * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor - * specific errors that occur.<br /> - */ - long getSize() throws XMLDBException; + /** + * Returns an iterator over all <code>Resource</code> instances stored in the set. + * + * @return a <code>ResourceIterator</code> over all <code>Resource</code> + * instances in the set. + * @throws XMLDBException with expected error codes.<br /> + * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor + * specific errors that occur.<br /> + */ + ResourceIterator getIterator() throws XMLDBException; - /** - * Removes all <code>Resource</code> instances from the set. - * - * @exception XMLDBException with expected error codes.<br /> - * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor - * specific errors that occur.<br /> - */ - void clear() throws XMLDBException; + /** + * Returns a Resource containing an XML representation of all resources + * stored in the set. <p /> + * TODO: Specify the schema used for this + * + * @return A <code>Resource</code> instance containing an XML representation + * of all set members. + * @throws XMLDBException with expected error codes.<br /> + * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor + * specific errors that occur.<br /> + */ + Resource getMembersAsResource() throws XMLDBException; + + /** + * Returns the number of resources contained in the set. + * <p /> + * If the underlying implementation uses a paging or streaming optimization + * for retrieving <code>Resource</code> instances. Calling this method MAY + * force the downloading of all set members before the size can be determined. + * + * @return The number of <code>Resource</code> instances in the set. + * @throws XMLDBException with expected error codes.<br /> + * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor + * specific errors that occur.<br /> + */ + int getSize() throws XMLDBException; + + /** + * Removes all <code>Resource</code> instances from the set. + * + * @throws XMLDBException with expected error codes.<br /> + * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor + * specific errors that occur.<br /> + */ + void clear() throws XMLDBException; } |
