Package advene :: Package model :: Package core :: Module tag :: Class Tag

Class Tag

                object --+        
                         |        
        meta.WithMetaMixin --+    
                             |    
                object --+   |    
                         |   |    
    events.WithEventsMixin --+    
                             |    
                object --+   |    
                         |   |    
tales.WithAbsoluteUrlMixin --+    
                             |    
                    object --+    
                             |    
        element.PackageElement --+
                                 |
                    object --+   |
                             |   |
              group.GroupMixin --+
                                 |
                                Tag

Known Subclasses:

cam.tag.Tag

Instance Methods

[hide private]

__init__(self, owner, id, *a)
Must not be used directly, nor overridden.

source code

__iter__(self)

source code

iter_elements(self, package=None, inherited=True)
Iter over the elements associated with this tag in ``package``.

source code

iter_element_ids(self, package=None, inherited=True, _get=False)
Iter over the id-refs of the elements associated with this tag in ``package``.

source code

_iter_elements_or_element_ids(self, package=None, inherited=True, _get=False)
Iter over the id-refs of the elements associated with this tag in ``package``.

source code

has_element(self, element, package=None, inherited=True)
Is this tag associated to ``element`` by ``package``.

source code

__wrap_with_tales_context__(self, context)
This method is used by adveve.model.tales, when the TALES processor wants to traverse the given object.

source code

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

Inherited from element.PackageElement

__delattr__(self, name)
Make instance lighter when a custom attribute is deleted.

source code

__setattr__(self, name, value)
Make instance heavier when a new custom attribute is created.

source code

_compute_absolute_url(self, aliases)

source code

_decrease_weight(self)
:see: _increase_weight

source code

_get_id(self)
The identifier of this element in the context of its owner package.

source code

_get_owner(self)
The package containing (or owner package) this element.

source code

_get_uriref(self)
The URI-ref identifying this element.

source code

_increase_weight(self)
Elements are created with weight 0.

source code

_iter_my_tags_or_tag_ids(self, package=None, inherited=True, _get=0)
Iter over the id-refs of the tags associated with this element in ``package``.

source code

_make_event_delegate(self)
Required by WithEventsMixin

source code

_self_connect(self, detailed_signal, handler, *args)
This alternative to `connect` can only be used by the element itself.

source code

_set_id(self, new_id)
Rename this element to `new_id`, if it is not already in use in the package, else raises an AssertionError.

source code

_tales_color(self, context)
Return the color of the element.

source code

_tales_my_tags(self, context_package)

source code

_tales_representation(self, context)
Return a concise representation for the element.

source code

_update_caches(self, old_idref, new_idref, element, relation)
This cooperative method is used to update all caches when an element in the cache is renamed.

source code

connect(self, detailed_signal, handler, *args)
Connect a handler to a signal.

source code

delete(self)
Delete this element.

source code

disconnect(self, handler_id)
Disconnect a handler from a signal.

source code

emit(self, detailed_signal, *args)
Override WithEventsMixin.emit in order to automatically emit the package signal corresponding to each element signal.

source code

has_tag(self, tag, package=None, inherited=True)
Is this element associated to ``tag`` by ``package``.

source code

iter_my_tag_ids(self, package=None, inherited=True, _get=0)
Iter over the id-refs of the tags associated with this element in ``package``.

source code

iter_my_tags(self, package=None, inherited=True)
Iter over the tags associated with this element in ``package``.

source code

iter_references(self, package=None)
Iter over all references that are made to this element.

source code

iter_taggers(self, tag, package=None)
Iter over all the packages associating this element to ``tag``.

source code

make_id_in(self, pkg)
Compute an id-ref for this element in the context of the given package.

source code

Inherited from meta.WithMetaMixin

_get_meta_id_or_ref(self, key, default=_RAISE, _return_id=True)
Return the metadata id (string or element) associated to the given key.

source code

_get_ns_dict(self)

source code

_tales_meta(self, context=None)

source code

del_meta(self, key)
Delete the metadata.

source code

get_meta(self, key, default=_RAISE)
Return the metadata (string or element) associated to the given key.

source code

get_meta_id(self, key, default=_RAISE, _return_id=True)
Return the metadata id (string or element) associated to the given key.

source code

iter_meta(self)
Iter over all the metadata of this object.

source code

iter_meta_ids(self)
Iter over all the metadata of this object.

source code

set_meta(self, key, val, val_is_idref=False)
Set the metadata.

source code

Inherited from events.WithEventsMixin

block_handler(self, handler_id)
Prevent the handler identified by handler_id to be invoked until it is unblocked.

source code

emit_lazy(self, lazy_params)
Like emit, but lazy_params is assumed to be a function returning an iterable of the params to send to emit.

source code

enter_no_event_section(self)
Disable all event emission for this object, until `exit_no_event_section` is called.

source code

exit_no_event_section(self)
Re-enables all event emission for this object.

source code

handler_block(self, handler_id)
Prevent the handler identified by handler_id to be invoked until it is unblocked.

source code

handler_is_connected(self, handler_id)
Return True iff the given handler_id represents a connected handler.

source code

handler_unblock(self, handler_id)
Unblock the blocked handler identified by handler_id so it can be invoked again.

source code

has_handler(self, handler_id)
Return True iff the given handler_id represents a connected handler.

source code

stop_emission(self, detailed_signal)
Stop the current emission of the signal specified by detailed_signal.

source code

unblock_handler(self, handler_id)
Unblock the blocked handler identified by handler_id so it can be invoked again.

source code

Inherited from tales.WithAbsoluteUrlMixin

_absolute_url_fail(self, msg='') source code

_tales_absolute_url(self, context)
See class documentation.

source code

Inherited from group.GroupMixin

count_annotations(self)

source code

count_imports(self)

source code

count_lists(self)

source code

count_medias(self)

source code

count_queries(self)

source code

count_relations(self)

source code

count_resources(self)

source code

count_tags(self)

source code

count_views(self)

source code

iter_annotations(self)

source code

iter_imports(self)

source code

iter_lists(self)

source code

iter_medias(self)

source code

iter_queries(self)

source code

iter_relations(self)

source code

iter_resources(self)

source code

iter_tags(self)

source code

iter_views(self)

source code

Class Methods

[hide private]

create_new(cls, owner, id, *args)
Factory method to create a new instance both in memory and backend.

source code

Inherited from element.PackageElement

instantiate(cls, owner, id, *args)
Factory method to create an instance from backend data.

source code

Inherited from meta.WithMetaMixin

make_metadata_property(cls, key, alias=None, default=_RAISE, doc=None)
Attempts to create a python property in cls mapping to metadata key.

source code

Static Methods

[hide private]

Inherited from element.PackageElement

_check_reference(pkg, element, type=None, required=False)
Raise a ModelError if element is not referenceable by pkg, and (if provided) if it has not the given type.

source code

Class Variables

[hide private]

ADVENE_TYPE = 't'

Inherited from element.PackageElement

_id = None

_owner = None

_weight = 0

Properties

[hide private]

Inherited from object: __class__

Inherited from element.PackageElement

id
The identifier of this element in the context of its owner package.

owner
The package containing (or owner package) this element.

uriref
The URI-ref identifying this element.

Inherited from meta.WithMetaMixin

init(self, owner, id, a)
(Constructor)*

source code

Must not be used directly, nor overridden. Use class methods instantiate or create_new instead.

Overrides: object.__init__: (inherited documentation)

create_new(cls, owner, id, args)
Class Method*

source code

Factory method to create a new instance both in memory and backend.

This method will usually perform checks and conversions from its actual arguments to the data expected to the backend. It is responsible for 1/ storing the data in the backend and 2/ initializing the instance (for which it should reuse instantiate to reduce redundancy).

Note that this method *should* be tolerant w.r.t. its parameters, especially accepting both element instances or ID-refs.

NB: this method does nothing and must not be invoked by superclasses (indeed, it raises an exception).

Overrides: element.PackageElement.create_new: (inherited documentation)

iter(self)

source code

Overrides: group.GroupMixin.__iter__

iter_elements(self, package=None, inherited=True)

source code

Iter over the elements associated with this tag in ``package``.

If ``inherited`` is set to False, the elements associated by imported packages of ``package`` will not be yielded.

If an element is unreachable, None is yielded.

iter_element_ids(self, package=None, inherited=True, _get=False)

source code

Iter over the id-refs of the elements associated with this tag in ``package``.

If ``package`` is not provided, the ``package`` session variable is used. If the latter is unset, a TypeError is raised.

If ``inherited`` is set to False, the elements associated by imported packages of ``package`` will not be yielded.

_iter_elements_or_element_ids(self, package=None, inherited=True, _get=False)

source code

Iter over the id-refs of the elements associated with this tag in ``package``.

If ``package`` is not provided, the ``package`` session variable is used. If the latter is unset, a TypeError is raised.

If ``inherited`` is set to False, the elements associated by imported packages of ``package`` will not be yielded.

has_element(self, element, package=None, inherited=True)

source code

Is this tag associated to ``element`` by ``package``.

If ``package`` is not provided, the ``package`` session variable is used. If the latter is unset, a TypeError is raised.

If ``inherited`` is set to False, only returns True if ``package`` itself associates this tag to ``element``; else returns True also if the association is inherited from an imported package.

Class Tag

__init__(self, owner, id, *a) (Constructor)

create_new(cls, owner, id, *args) Class Method

__iter__(self)

iter_elements(self, package=None, inherited=True)

iter_element_ids(self, package=None, inherited=True, _get=False)

_iter_elements_or_element_ids(self, package=None, inherited=True, _get=False)

has_element(self, element, package=None, inherited=True)

init(self, owner, id, a)
(Constructor)*

create_new(cls, owner, id, args)
Class Method*

iter(self)