Cheshire3 Object Model: Class ArrayIndex

Module index :: Class ArrayIndex

Class ArrayIndex
source code

Object Tree:
           object --+            
                    |            
configParser.C3Object --+        
                        |        
        baseObjects.Index --+    
                            |    
                  SimpleIndex --+
                                |
                               ArrayIndex
Known Subclasses:
ProximityArrayIndex

Instance Methods

__init__(self, session, node, parent)
The constructor for all Cheshire3 objects take the same arguments: session: A Session object topNode: The <config> or <subConfig> domNode for the configuration parent: The object that provides the scope for this object.
search(self, session, clause, db)
Search this particular index given a CQL clause, return a resultSet object
serialise_terms(self, termid, terms, recs=0, occs=0)
Callback from IndexStore to serialise list of terms and document references to be stored
deserialise_terms(self, data, prox=1)
Callback from IndexStore to take serialised data and produce list of terms and document references.
merge_terms(self, structTerms, newTerms, op="replace", recs=0, occs=0)
Callback from IndexStore to take two sets of terms and merge them together.
construct_resultSet(self, session, terms, queryHash={})
Take a list of terms and produce an appropriate ResultSet object.

Inherited from SimpleIndex: begin_indexing, commit_indexing, construct_item, delete_record, extract_data, index_record, scan, store_terms

Inherited from baseObjects.Index: sort

Inherited from configParser.C3Object: auth_function, get_config, get_default, get_object, get_path, get_setting, log_function, unauth_function, unlog_function

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


Class Variables

Inherited from SimpleIndex: currentFullPath, currentPath, debug, indexingData, indexingTerm, sources, storeOrig, xPathAllAbsolute, xPathAttributesRequired, xPathsNormalized

Inherited from baseObjects.Index: indexStore

Inherited from configParser.C3Object: configStore, defaults, functionLogger, id, name, objectType, objects, parent, paths, permissionHandlers, settings, subConfigs, unresolvedObjects

Inherited from object: __class__


Method Details

__init__(self, session, node, parent)
(Constructor)

source code 
The constructor for all Cheshire3 objects take the same arguments: session: A Session object topNode: The <config> or <subConfig> domNode for the configuration parent: The object that provides the scope for this object.
Overrides: SimpleIndex.__init__

search(self, session, clause, db)

source code 
Search this particular index given a CQL clause, return a resultSet object
Overrides: SimpleIndex.search

serialise_terms(self, termid, terms, recs=0, occs=0)

source code 
Callback from IndexStore to serialise list of terms and document references to be stored
Overrides: SimpleIndex.serialise_terms

deserialise_terms(self, data, prox=1)

source code 
Callback from IndexStore to take serialised data and produce list of terms and document references.
Overrides: SimpleIndex.deserialise_terms

merge_terms(self, structTerms, newTerms, op="replace", recs=0, occs=0)

source code 
Callback from IndexStore to take two sets of terms and merge them together.
Overrides: SimpleIndex.merge_terms

construct_resultSet(self, session, terms, queryHash={})

source code 
Take a list of terms and produce an appropriate ResultSet object.
Overrides: SimpleIndex.construct_resultSet