imagination.locator

Author:Juti Noppornpitak

The module contains the entity locator used to promote reusability of components.

Note

Copyright (c) 2012 Juti Noppornpitak

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

class imagination.locator.Locator

Entity locator

find_by_tag(tag_label)

Retrieve entities by tag_label.

Parameters:tag_label – tag label

fork(id)

Fork the entity identified by id.

Parameters:id – entity identifier

get(id)

Retrieve an instance of the entity

Parameters:id – entity identifier Returns:an instance of the requested entity

get_wrapper(id)

Retrieve the entity wrapper identified by id.

Parameters:id – entity identifier Returns:the requested entity wrapper

has(id)

Check if the entity with id is already registered.

load_xml(file_path)

Load the entities from a XML configuration file at file_path.

Status:Deprecated in 1.5

set(id, entity)

Set the given entity by id.