Trees | Indices | Help |
|
---|
|
Object wrapper class which provides various methods for hierarchy traversing, saving, handling permissions etc. This is the 'abstract' super class which is subclassed by E.g. _ProjectWrapper, _DatasetWrapper etc. All ojbects have a reference to the BlitzGateway connection, and therefore all services are available for handling calls on the object wrapper. E.g listChildren() uses queryservice etc.
|
|||
|
|||
Boolean |
|
||
|
|||
|
|||
String |
|
||
|
|||
class |
|
||
class |
|
||
|
|||
Boolean |
|
||
BlitzObjectWrapper |
|
||
DetailsWrapper |
|
||
datetime |
|
||
None |
|
||
|
|||
Boolean |
|
||
Boolean |
|
||
Boolean |
|
||
Boolean |
|
||
Boolean |
|
||
Boolean |
|
||
Boolean |
|
||
Boolean |
|
||
|
|||
|
|||
Boolean |
|
||
|
|||
Long |
|
||
Long |
|
||
generator of Ice client proxy objects for the child nodes |
|
||
generator of BlitzObjectWrapper objs |
|
||
BlitzObjectWrapper ( or tuple(BlitzObjectWrapper, BlitzObjectWrapper) ) |
|
||
list of BlitzObjectWrapper ( or tuple(BlitzObjectWrapper, BlitzObjectWrapper) ) |
|
||
List of BlitzObjectWrapper |
|
||
List of BlitzObjectWrapper |
|
||
List of BlitzObjectWrapper |
|
||
|
|||
List of Annotation Links |
|
||
|
|||
|
|||
|
|||
AnnotationWrapper generator |
|
||
AnnotationWrapper generator |
|
||
|
|||
|
|||
AnnotationWrapper |
|
||
|
|||
method, value (string, long etc) |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
datetime.datetime |
|
||
datetime.datetime |
|
||
|
|||
|
|||
Inherited from |
|
|||
|
|
|||
OMERO_CLASS = None hash(x) |
|||
LINK_CLASS = None hash(x) |
|||
LINK_CHILD = 'child'
|
|||
CHILD_WRAPPER_CLASS = None hash(x) |
|||
PARENT_WRAPPER_CLASS = None hash(x) |
|
|||
Inherited from |
|
Initialises the wrapper object, setting the various class variables etc
|
Returns true if the object is of the same type and has same id and name
|
Returns a String representation of the Object, including ID if set.
|
Returns the wrapper class of children of this object. Checks that this is one of the Wrapper objects in the omero.gateway module Raises NotImplementedError if this is not true or class is not defined (None) This is used internally by the listChildren and countChildren methods.
|
Returns the wrapper classes of the parent of this object. This is used internally by the listParents method.
|
Loads the object that is wrapped by this class. This includes linked objects. This method can be overwritten by subclasses that want to specify how/which linked objects are loaded. |
Moves this object from a parent container (first one if there are more than one) to a new parent. TODO: might be more useful if it didn't assume only 1 parent - option allowed you to specify the oldParent.
|
Find the first child object with a matching name, and description if specified.
|
Gets the details of the wrapped object
|
Returns the object's acquisitionDate, or creation date (details.creationEvent.time)
|
Save this object, keeping the object owner the same as the one on provided details If the current user is an admin but is NOT the owner specified in 'details', then create a new connection for that owner, clone the current object under that connection and save. Otherwise, simply save.
|
Delegates to the connection BlitzGateway.canWrite method
|
Returns True if the object owner is the same user specified in the connection's Event Context
|
Returns True if the group that this object belongs to is lead by the currently logged-in user
|
Determines if the object permissions are world readable, ie permissions.isWorldRead()
|
Determines if the object is sharable between groups (but not public)
|
Determines if the object is private |
Determines if the current user can Edit (E.g. name, description) link (E.g. Project, Dataset, Image etc) or Delete this object. The canEdit() property is set on the permissions of every object as it is read from the server, based on the current user, event context and group permissions.
|
Determines whether user can create 'hard' links (Not annotation links). E.g. Between Project/Dataset/Image etc. Previously (4.4.6 and earlier) we only allowed this for object owners, but now we delegate to what the server will allow. |
Determines if the current user can annotate this object: ie create annotation links. The canAnnotate() property is set on the permissions of every object as it is read from the server, based on the current user, event context and group permissions.
|
Specifies whether the current user can move this object to another group. Web client will only allow this for the data Owner. Admin CAN move other user's data, but we don't support this in Web yet. |
Counts available number of child objects.
|
countChildren, but caching the first result, useful if you need to call this multiple times in a single sequence, but have no way of storing the value between them. It is actually a hack to support django template's lack of break in for loops
|
Lists available child objects.
|
Lists available child objects.
|
List a single parent, if available. While the model suports many to many relationships between most objects, there are implementations that assume a single project per dataset, a single dataset per image, etc. This is just a shortcut method to return a single parent object.
|
Lists available parent objects.
|
Get a list of Ancestors. First in list is parent of this object. TODO: Assumes getParent() returns a single parent.
|
Get a list of parent objects links.
|
Get a list of child objects links.
|
Checks links are loaded and returns a list of Annotation Links filtered by namespace if specified
|
Uses updateService to unlink annotations, with specified ns
|
Uses the delete service to delete annotations, with a specified ns,
and their links on the object and any other objects. Will raise a
|
Gets the first annotation on the object, filtered by ns if specified
|
List annotations in the ns namespace, linked to this object
|
Retrieve all Annotations not linked to the given Project, Dataset, Image, Screen, Plate, Well ID controlled by the security system.
|
Saves the object to DB if needed - setting the permissions manually. Creates the object link and saves it, setting permissions manually. TODO: Can't set permissions manually in 4.2 - Assumes world & group writable
|
Saves the annotation to DB if needed - setting the permissions manually. Creates the annotation link and saves it, setting permissions manually. TODO: Can't set permissions manually in 4.2 - Assumes world & group writable
|
Link the annotation to this object.
|
Creates a dict representation of this object. E.g. for Image: {'description': '', 'author': 'Will Moore', 'date': 1286332557.0, 'type': 'Image', 'id': 3841L, 'name': 'cb_4_w500_t03_z01.tif'} @param xtra: A dict of extra keys to include. E.g. 'childCount' @type xtra: Dict @param parents: If True, include a list of ancestors (in simpleMarshal form) as 'parents' @type parents: Boolean @return: A dict representation of this object @rtype: Dict |
Attempts to return the named attribute of this object. E.g. image.__getattr__('name') or 'getName' In cases where the attribute E.g. 'getImmersion' should return an enumeration, this is specified by the attr name starting with '#' #immersion. In cases where the attribute E.g. 'getLightSource' should return a wrapped object, this is handled by the parent encoding the wrapper in the attribute name. E.g 'lightSource|LightSourceWrapper' In both cases this returns a method that will return the object. In addition, lookup of methods that return an rtype are wrapped to the method instead returns a primitive type. E.g. image.getArchived() will return a boolean instead of rbool.
|
Gets this object ID
|
Gets this object name
|
Gets this object description
|
Gets user who is the owner of this object.
|
Gets full name of the owner of this object.
|
Gets omeName of the owner of this object.
|
Gets event time in timestamp format (yyyy-mm-dd hh:mm:ss.fffffff) when object was created.
|
Gets event time in timestamp format (yyyy-mm-dd hh:mm:ss.fffffff) when object was updated.
|
Sets the name of the object
|
Sets the description of the object
|
Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Tue Sep 23 15:04:50 2014 | http://epydoc.sourceforge.net |