Package omero :: Package gateway :: Class AnnotationWrapper
[hide private]
[frames] | no frames]

Class AnnotationWrapper

source code


omero_model_AnnotationI class wrapper extends BlitzObjectWrapper.

Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
Initialises the Annotation wrapper and 'link' if in kwargs
source code
Boolean
__eq__(self, a)
Returns true if type, id, value and ns are equal
source code
 
_getQueryString(self)
Used for building queries in generic methods such as getObjects("Annotation")
source code
String
getNs(self)
Gets annotation namespace
source code
 
setNs(self, val)
Sets annotation namespace
source code
 
getValue(self)
Needs to be implemented by subclasses
source code
 
setValue(self, val)
Needs to be implemented by subclasses
source code
List of BlitzObjectWrapper
getParentLinks(self, ptype, pids=None)
Get a list of parent objects links.
source code

Inherited from BlitzObjectWrapper: __bstrap__, __getattr__, __loadedHotSwap__, __prepare__, __repr__, canDelete, canOwnerWrite, canWrite, countChildren, countChildren_cached, creationEventDate, findChildByName, getAncestry, getAnnotation, getChildLinks, getDate, getDescription, getDetails, getId, getName, getOwner, getOwnerFullName, getOwnerOmeName, getParent, isEditable, isLeaded, isOwned, isPrivate, isPublic, isReadOnly, isShared, linkAnnotation, listAnnotations, listChildren, listOrphanedAnnotations, listParents, removeAnnotations, save, saveAs, setDescription, setName, simpleMarshal, unlinkAnnotations, updateEventDate

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]
 
_register(klass, regklass)
Adds the AnnotationWrapper regklass to class registry
source code
AnnotationWrapper subclass
_wrap(klass, conn=None, obj=None, link=None)
Class method for creating AnnotationWrapper subclasses based on the type of annotation object, using previously registered mapping between OMERO types and wrapper classes
source code
 
createAndLink(klass, target, ns, val=None)
Class method for creating an instance of this AnnotationWrapper, setting ns and value and linking to the target.
source code
Static Methods [hide private]

Inherited from BlitzObjectWrapper: LINK_PARENT

Class Variables [hide private]
  registry = {}
  OMERO_TYPE = None
hash(x)

Inherited from BlitzObjectWrapper: CHILD_WRAPPER_CLASS, LINK_CHILD, LINK_CLASS, OMERO_CLASS, PARENT_WRAPPER_CLASS

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args, **kwargs)
(Constructor)

source code 

Initialises the Annotation wrapper and 'link' if in kwargs

Parameters:
  • conn - The omero.gateway.BlitzGateway connection.
  • obj - The object to wrap. E.g. omero.model.Image
  • cache - Cache which is passed to new child wrappers
Overrides: object.__init__

__eq__(self, a)
(Equality operator)

source code 

Returns true if type, id, value and ns are equal

Parameters:
  • a - The annotation to compare
Returns: Boolean
True if annotations are the same - see above
Overrides: BlitzObjectWrapper.__eq__

_getQueryString(self)

source code 

Used for building queries in generic methods such as getObjects("Annotation")

Overrides: BlitzObjectWrapper._getQueryString

_register(klass, regklass)
Class Method

source code 

Adds the AnnotationWrapper regklass to class registry

Parameters:

_wrap(klass, conn=None, obj=None, link=None)
Class Method

source code 

Class method for creating AnnotationWrapper subclasses based on the type of annotation object, using previously registered mapping between OMERO types and wrapper classes

Parameters:
  • conn (BlitzGateway) - The BlitzGateway connection
  • obj (omero.model.Annotation subclass) - The OMERO annotation object. E.g. omero.model.DoubleAnnotation
  • link (E.g. omero.model.DatasetAnnotationLink) - The link for this annotation
Returns: AnnotationWrapper subclass
Wrapped AnnotationWrapper object or None if obj.__class__ not registered

createAndLink(klass, target, ns, val=None)
Class Method

source code 

Class method for creating an instance of this AnnotationWrapper, setting ns and value and linking to the target.

Parameters:
  • target (BlitzObjectWrapper subclass) - The object to link annotation to
  • ns (String) - Annotation namespace
  • val - Value of annotation. E.g Long, Text, Boolean etc.

getNs(self)

source code 

Gets annotation namespace

Returns: String
Namespace or None

setNs(self, val)

source code 

Sets annotation namespace

Parameters:
  • val (String) - Namespace value

getParentLinks(self, ptype, pids=None)

source code 

Get a list of parent objects links.

Parameters:
  • pids - List of parent IDs
Returns: List of BlitzObjectWrapper
List of parent object links
Overrides: BlitzObjectWrapper.getParentLinks
(inherited documentation)