Package grassyknoll :: Package client :: Module ClientCollection :: Class ClientCollection
[hide private]

Class ClientCollection

source code


a collection that is a client to another remote collection, over HTTP.

Instance Methods [hide private]
 
__init__(self, base_uri="http://localhost:8080/")
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
CollectionIds
create(self, docs)
XXX this should prolly return None
source code
CollectionIds
delete(self, ids)
delete several CollectionDocuments by id
source code
CollectionIds
list(self)
Returns: the ids in the collection
source code
CollectionResultSet
retrieve(self, ids, fields=None)
retrive several CollectionResults by id
source code
 
__getattr__(self, name) source code
 
__query(self, name, **kwargs) source code

Inherited from collection.Collection.Collection: __len__, cleanUp, close

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Methods [hide private]

Inherited from lib.meta.FactoryMixin: factory

Instance Variables [hide private]
RestClient.RestClient restclient
A client to a server collection
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, base_uri="http://localhost:8080/")
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Parameters:
  • base_uri (string) - url to the server. Must end in /
Overrides: object.__init__

create(self, docs)

source code 
XXX this should prolly return None
Returns: CollectionIds
the created ids
Decorators:
  • @Collection.addMetaData
Overrides: collection.Collection.Collection.create
(inherited documentation)

delete(self, ids)

source code 

delete several CollectionDocuments by id

XXX this should prolly return None
Returns: CollectionIds
the deleted ids
Decorators:
  • @Collection.addMetaData
Overrides: collection.Collection.Collection.delete
(inherited documentation)

list(self)

source code 
Returns: CollectionIds
the ids in the collection
Decorators:
  • @Collection.addMetaData
Overrides: collection.Collection.Collection.list
(inherited documentation)

retrieve(self, ids, fields=None)

source code 
retrive several CollectionResults by id
Returns: CollectionResultSet
the results
Decorators:
  • @Collection.addMetaData
Overrides: collection.Collection.Collection.retrieve
(inherited documentation)

__query(self, name, **kwargs)

source code 
Decorators:
  • @Collection.addMetaData