org.exist.xmldb
Class RemoteCollection

java.lang.Object
  org.exist.xmldb.RemoteCollection

All Implemented Interfaces:

CollectionImpl

public class RemoteCollection

extends java.lang.Object

implements CollectionImpl

A remote implementation of the Collection interface. This implementation communicates with the server through the XMLRPC protocol.

Author:

wolf

Field Summary

protected java.util.Map	childCollections
protected java.lang.String	name
protected RemoteCollection	parent
protected Permission	permissions
protected java.util.Properties	properties
protected XmlRpcClient	rpcClient

Constructor Summary

RemoteCollection(XmlRpcClient client, RemoteCollection parent, java.lang.String collection)

RemoteCollection(XmlRpcClient client, java.lang.String collection)

Method Summary

protected void	addChildCollection(Collection child)
void	close()
java.lang.String	createId()
Resource	createResource(java.lang.String id, java.lang.String type)
Collection	getChildCollection(java.lang.String name)
int	getChildCollectionCount()
java.lang.String[]	getChildCollections()
protected XmlRpcClient	getClient()
java.util.Date	getCreationTime() Returns the time of creation of the collection.
java.lang.String	getName()
Collection	getParentCollection()
java.lang.String	getPath()
Permission	getPermissions()
java.util.Properties	getProperties()
java.lang.String	getProperty(java.lang.String property)
Resource	getResource(java.lang.String name)
int	getResourceCount()
java.lang.String[]	getResources()
Service	getService(java.lang.String name, java.lang.String version)
Service[]	getServices()
XmldbURI	getURI()
protected boolean	hasChildCollection(java.lang.String name)
boolean	isOpen()
boolean	isRemoteCollection()
java.lang.String[]	listChildCollections() Returns a list of collection names naming all child collections of the current collection.
java.lang.String[]	listResources()
void	registerService(Service serv)
void	removeChildCollection(java.lang.String name)
void	removeResource(Resource res)
void	setProperty(java.lang.String property, java.lang.String value)
void	storeResource(Resource res)
void	storeResource(Resource res, java.util.Date a, java.util.Date b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

childCollections

protected java.util.Map childCollections

name

protected java.lang.String name

permissions

protected Permission permissions

parent

protected RemoteCollection parent

rpcClient

protected XmlRpcClient rpcClient

properties

protected java.util.Properties properties

Constructor Detail

RemoteCollection

public RemoteCollection(XmlRpcClient client,
                        java.lang.String collection)
                 throws XMLDBException

RemoteCollection

public RemoteCollection(XmlRpcClient client,
                        RemoteCollection parent,
                        java.lang.String collection)
                 throws XMLDBException

Method Detail

addChildCollection

protected void addChildCollection(Collection child)
                           throws XMLDBException

Throws:

XMLDBException

close

public void close()
           throws XMLDBException

Throws:

XMLDBException

createId

public java.lang.String createId()
                          throws XMLDBException

Throws:

XMLDBException

createResource

public Resource createResource(java.lang.String id,
                               java.lang.String type)
                        throws XMLDBException

Throws:

XMLDBException

getChildCollection

public Collection getChildCollection(java.lang.String name)
                              throws XMLDBException

Throws:

XMLDBException

getChildCollectionCount

public int getChildCollectionCount()
                            throws XMLDBException

Throws:

XMLDBException

getClient

protected XmlRpcClient getClient()

getName

public java.lang.String getName()
                         throws XMLDBException

Throws:

XMLDBException

getParentCollection

public Collection getParentCollection()
                               throws XMLDBException

Throws:

XMLDBException

getPath

public java.lang.String getPath()
                         throws XMLDBException

Throws:

XMLDBException

getProperty

public java.lang.String getProperty(java.lang.String property)
                             throws XMLDBException

Throws:

XMLDBException

getProperties

public java.util.Properties getProperties()

getResourceCount

public int getResourceCount()
                     throws XMLDBException

Throws:

XMLDBException

getService

public Service getService(java.lang.String name,
                          java.lang.String version)
                   throws XMLDBException

Throws:

XMLDBException

getServices

public Service[] getServices()
                      throws XMLDBException

Throws:

XMLDBException

hasChildCollection

protected boolean hasChildCollection(java.lang.String name)
                              throws XMLDBException

Throws:

XMLDBException

isOpen

public boolean isOpen()
               throws XMLDBException

Throws:

XMLDBException

listChildCollections

public java.lang.String[] listChildCollections()
                                        throws XMLDBException

Returns a list of collection names naming all child collections of the current collection. Only the name of the collection is returned - not the entire path to the collection.

Returns:

Description of the Return Value

Throws:

XMLDBException - Description of the Exception

getChildCollections

public java.lang.String[] getChildCollections()
                                       throws XMLDBException

Specified by:

getChildCollections in interface CollectionImpl

Throws:

XMLDBException

listResources

public java.lang.String[] listResources()
                                 throws XMLDBException

Throws:

XMLDBException

getResources

public java.lang.String[] getResources()
                                throws XMLDBException

Specified by:

getResources in interface CollectionImpl

Throws:

XMLDBException

getResource

public Resource getResource(java.lang.String name)
                     throws XMLDBException

Throws:

XMLDBException

registerService

public void registerService(Service serv)
                     throws XMLDBException

Throws:

XMLDBException

removeChildCollection

public void removeChildCollection(java.lang.String name)
                           throws XMLDBException

Throws:

XMLDBException

removeResource

public void removeResource(Resource res)
                    throws XMLDBException

Throws:

XMLDBException

getCreationTime

public java.util.Date getCreationTime()
                               throws XMLDBException

Description copied from interface: CollectionImpl

Returns the time of creation of the collection.

Specified by:

getCreationTime in interface CollectionImpl

Returns:

Throws:

XMLDBException

setProperty

public void setProperty(java.lang.String property,
                        java.lang.String value)
                 throws XMLDBException

Throws:

XMLDBException

storeResource

public void storeResource(Resource res)
                   throws XMLDBException

Throws:

XMLDBException

storeResource

public void storeResource(Resource res,
                          java.util.Date a,
                          java.util.Date b)
                   throws XMLDBException

Specified by:

storeResource in interface CollectionImpl

Throws:

XMLDBException

getPermissions

public Permission getPermissions()

isRemoteCollection

public boolean isRemoteCollection()
                           throws XMLDBException

Specified by:

isRemoteCollection in interface CollectionImpl

Throws:

XMLDBException

getURI

public XmldbURI getURI()

Specified by:

getURI in interface CollectionImpl