|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.xmldb.LocalResourceSet
Field Summary | |
protected BrokerPool |
brokerPool
|
protected LocalCollection |
collection
|
protected java.util.Map |
properties
|
protected java.util.Vector |
resources
|
Constructor Summary | |
LocalResourceSet(User user,
BrokerPool pool,
LocalCollection col)
|
|
LocalResourceSet(User user,
BrokerPool pool,
LocalCollection col,
Value val,
java.util.Map properties,
java.lang.String sortExpr)
|
Method Summary | |
void |
addResource(Resource resource)
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. |
ResourceIterator |
getIterator(long start)
|
Resource |
getMembersAsResource()
Returns a Resource containing an XML representation of all resources stored in the set. |
Resource |
getResource(long pos)
Returns the Resource instance stored at the index specified
by index. |
long |
getSize()
Gets the size attribute of the LocalResourceSet object |
void |
removeResource(long pos)
Description of the Method |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected BrokerPool brokerPool
protected LocalCollection collection
protected java.util.Vector resources
protected java.util.Map properties
Constructor Detail |
public LocalResourceSet(User user, BrokerPool pool, LocalCollection col)
public LocalResourceSet(User user, BrokerPool pool, LocalCollection col, Value val, java.util.Map properties, java.lang.String sortExpr) throws XMLDBException
Method Detail |
public void addResource(Resource resource) throws XMLDBException
ResourceSet
Resource
instance to the set.
addResource
in interface ResourceSet
resource
- The Resource
to add to the set.
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void clear() throws XMLDBException
ResourceSet
Resource
instances from the set.
clear
in interface ResourceSet
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public ResourceIterator getIterator() throws XMLDBException
ResourceSet
Resource
instances stored in the set.
getIterator
in interface ResourceSet
ResourceIterator
over all Resource
instances in the set.
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public ResourceIterator getIterator(long start) throws XMLDBException
XMLDBException
public Resource getMembersAsResource() throws XMLDBException
ResourceSet
getMembersAsResource
in interface ResourceSet
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.public Resource getResource(long pos) throws XMLDBException
ResourceSet
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.
getResource
in interface ResourceSet
pos
- the index of the resource to retrieve.
Resource
instance
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.
public long getSize() throws XMLDBException
getSize
in interface ResourceSet
XMLDBException
- Description of the Exceptionpublic void removeResource(long pos) throws XMLDBException
removeResource
in interface ResourceSet
pos
- Description of the Parameter
XMLDBException
- Description of the Exception
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |