Package amplee :: Package indexer :: Class CategoryIndex
[hide private]
[frames] | no frames]

Class CategoryIndex

source code

object --+    
         |    
 BaseIndex --+
             |
            CategoryIndex

Instance Methods [hide private]
 
__init__(self, name, container=None, index_term=True, index_scheme=False)
Simple atom category indexing.
source code
 
update(self, member)
Updates the index based on the category elements of the provided member.
source code
 
prune(self, member)
Prunes the member from the index based on the category elements.
source code
set
lookup(self, term=None, scheme=None)
Returns a set of member identifiers matching the term and scheme provided.
source code

Inherited from BaseIndex: clear, iiterindex, iload, iterindex, keys, load, store

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, container=None, index_term=True, index_scheme=False)
(Constructor)

source code 

Simple atom category indexing.

Parameters:
  • name (string) - an internal identifier used to reference the indexer.
  • container (object) - instance of a class implementing the dictionnary interface.
  • index_term (bool)
  • index_scheme (bool)
Overrides: object.__init__

update(self, member)

source code 

Updates the index based on the category elements of the provided member.

Parameters:
Overrides: BaseIndex.update

prune(self, member)

source code 

Prunes the member from the index based on the category elements.

Parameters:
Overrides: BaseIndex.prune

lookup(self, term=None, scheme=None)

source code 

Returns a set of member identifiers matching the term and scheme provided.

Parameters:
  • term (string) - value to be matched against indexed term attributes
  • scheme (string) - value to be matched against indexed scheme attributes
Returns: set
joint result set of the query