PyAMS thesaurus manager¶
+ +Subpackages¶
+ +Submodules¶
+pyams_thesaurus.include module¶
+-
+
-
+
pyams_thesaurus.include.
include_package
(config)¶
+ Pyramid include
+
pyams_thesaurus.index module¶
+-
+
-
+class
pyams_thesaurus.index.
ThesaurusTermFieldIndex
(interface, discriminator, family=None, include_parents=False, include_synonyms=False)¶
+ Bases:
+pyams_catalog.index.KeywordIndexWithInterface
Thesaurus term field index
+-
+
-
+
discriminate
(obj, default)¶
+
-
+
-
+
include_parents
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
include_synonyms
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
-
+class
pyams_thesaurus.index.
ThesaurusTermsListFieldIndex
(interface, discriminator, family=None, include_parents=False, include_synonyms=False)¶
+ Bases:
+pyams_catalog.index.KeywordIndexWithInterface
Thesaurus terms list field index
+-
+
-
+
discriminate
(obj, default)¶
+
-
+
-
+
include_parents
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
include_synonyms
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
-
+
pyams_thesaurus.index.
get_terms
(index, term)¶
+
pyams_thesaurus.schema module¶
+-
+
-
+class
pyams_thesaurus.schema.
ThesaurusTermField
(schema=None, thesaurus_name='', extract_name='', **kw)¶
+ Bases:
+zope.schema._field.Object
Thesaurus term schema field
+
-
+
-
+class
pyams_thesaurus.schema.
ThesaurusTermsListField
(value_type=None, unique=False, thesaurus_name='', extract_name='', **kw)¶
+ Bases:
+zope.schema._field.List
Thesaurus terms list schema field
+
-
+
-
+class
pyams_thesaurus.schema.
ValidatedChoice
(values=None, vocabulary=None, source=None, **kw)¶
+ Bases:
+zope.schema._field.Choice
An always validated choice field
+
-
+
-
+class
pyams_thesaurus.schema.
ValidatedSet
(**kw)¶
+ Bases:
+zope.schema._field.Set
A set field validated when not bound to a context
+
pyams_thesaurus.term module¶
+-
+
-
+class
pyams_thesaurus.term.
ThesaurusTerm
(label, alt=None, definition=None, note=None, generic=None, specifics=None, associations=None, usage=None, used_for=None, created=None, modified=None)¶
+ Bases:
+persistent.Persistent
,zope.container.contained.Contained
Thesaurus term
+-
+
-
+
add_extract
(extract, check=True)¶
+
-
+
-
+
alt
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
associations
¶
+
-
+
-
+
base_label
¶
+
-
+
-
+
created
¶
+
-
+
-
+
definition
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
extensions
¶
+
-
+
-
+
extracts
¶
+
-
+
-
+
generic
¶
+
-
+
-
+
get_all_childs
(terms=None, with_synonyms=False)¶
+
-
+
-
+
get_parent_childs
()¶
+
-
+
-
+
get_parents
()¶
+
-
+
-
+
label
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
level
¶
+
-
+
-
+
merge
(term, configuration)¶
+
-
+
-
+
micro_thesaurus
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
modified
¶
+
-
+
-
+
note
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
parent
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
query_extensions
()¶
+
-
+
-
+
remove_extract
(extract, check=True)¶
+
-
+
-
+
specifics
¶
+
-
+
-
+
status
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
title
¶
+
-
+
-
+
usage
¶
+
-
+
-
+
used_for
¶
+
-
+
-
+
-
+class
pyams_thesaurus.term.
ThesaurusTermTreeAdapter
(context)¶
+ Bases:
+pyams_utils.adapter.ContextAdapter
Thesaurus term tree node adapter
+-
+
-
+
css_class
¶
+
-
+
-
+
get_children
(filter_value=None)¶
+
-
+
-
+
get_level
()¶
+
-
+
-
+
has_children
(filter_value=None)¶
+
-
+
-
+
label
¶
+
-
+
-
+
-
+class
pyams_thesaurus.term.
ThesaurusTermsNamespace
(context)¶
+ Bases:
+pyams_utils.adapter.ContextAdapter
Thesaurus ++terms++ namespace
+-
+
-
+
traverse
(name, furtherpath=None)¶
+
-
+
-
+
-
+
pyams_thesaurus.term.
handle_modified_term
(event)¶
+ Update index term into inner catalog
+
-
+
-
+
pyams_thesaurus.term.
handle_new_term
(event)¶
+ Index term into inner catalog
+
-
+
-
+
pyams_thesaurus.term.
handle_removed_term
(event)¶
+ Unindex term into inner catalog
+
pyams_thesaurus.thesaurus module¶
+-
+
-
+class
pyams_thesaurus.thesaurus.
Thesaurus
(name=None, description=None, terms=None)¶
+ Bases:
+pyams_security.security.ProtectedObject
,persistent.Persistent
,zope.container.contained.Contained
Thesaurus persistent class
+-
+
-
+
administrators
¶
+ Custom field property used to handle role principals
+
-
+
-
+
catalog
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
clear
()¶
+
-
+
-
+
created
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
creator
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
delete
()¶
+
-
+
-
+
description
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
find_terms
(query=None, extract=None, glob='end', limit=None, exact=False, exact_only=False, stemmed=False)¶
+
-
+
-
+
get_top_terms
(extract=None)¶
+
-
+
-
+
init_catalog
()¶
+
-
+
-
+
language
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
load
(configuration)¶
+
-
+
-
+
managers
¶
+ Custom field property used to handle role principals
+
-
+
-
+
merge
(configuration, thesaurus=None)¶
+
-
+
-
+
name
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
publisher
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
reset_terms_parent
()¶
+
-
+
-
+
reset_top_terms
()¶
+
-
+
-
+
roles_interface
= <InterfaceClass pyams_thesaurus.interfaces.thesaurus.IThesaurusRoles>¶
+
-
+
-
+
subject
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
sublocations
()¶
+
-
+
-
+
terms
= None¶
+
-
+
-
+
title
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
top_terms
¶
+
-
+
-
+
-
+class
pyams_thesaurus.thesaurus.
ThesaurusExtract
¶
+ Bases:
+persistent.Persistent
,zope.container.contained.Contained
Thesaurus extract
+-
+
-
+
abbreviation
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
add_term
(term)¶
+
-
+
-
+
color
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
description
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
managers
¶
+ Custom field property used to handle role principals
+
-
+
-
+
name
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
remove_term
(term)¶
+
-
+
-
+
roles_interface
= <InterfaceClass pyams_thesaurus.interfaces.thesaurus.IThesaurusExtractRoles>¶
+
-
+
-
+
-
+class
pyams_thesaurus.thesaurus.
ThesaurusExtractsContainer
¶
+ Bases:
+zope.container.btree.BTreeContainer
Thesaurus extracts container
+
-
+
-
+
pyams_thesaurus.thesaurus.
ThesaurusExtractsFactory
(context)¶
+ Thesaurus extracts factory
+
-
+
-
+class
pyams_thesaurus.thesaurus.
ThesaurusExtractsNamespace
(context)¶
+ Bases:
+pyams_utils.adapter.ContextAdapter
Thesaurus ++extracts++ namespace
+-
+
-
+
traverse
(name, furtherpath=None)¶
+
-
+
-
+
-
+class
pyams_thesaurus.thesaurus.
ThesaurusExtractsVocabulary
(context=None)¶
+ Bases:
+zope.schema.vocabulary.SimpleVocabulary
Thesaurus extracts vocabulary
+
-
+
-
+class
pyams_thesaurus.thesaurus.
ThesaurusNamesVocabulary
(context, **kw)¶
+ Bases:
+zope.componentvocabulary.vocabulary.UtilityVocabulary
Thesaurus names utilities vocabulary
+-
+
-
+
interface
= <InterfaceClass pyams_thesaurus.interfaces.thesaurus.IThesaurus>¶
+
-
+
-
+
nameOnly
= True¶
+
-
+
-
+
-
+class
pyams_thesaurus.thesaurus.
ThesaurusTermExtensionsVocabulary
(context=None)¶
+ Bases:
+zope.schema.vocabulary.SimpleVocabulary
Thesaurus term extensions vocabulary
+-
+
-
+
interface
= <InterfaceClass pyams_thesaurus.interfaces.extension.IThesaurusTermExtension>¶
+
-
+
-
+
-
+class
pyams_thesaurus.thesaurus.
ThesaurusTermsContainer
¶
+ Bases:
+zope.container.btree.BTreeContainer
Thesaurus terms container
+-
+
-
+
clear
()¶
+
-
+
-
+
-
+class
pyams_thesaurus.thesaurus.
ThesaurusTreeAdapter
(context)¶
+ Bases:
+pyams_utils.adapter.ContextAdapter
Thesaurus tree adapter
+-
+
-
+
get_root_nodes
()¶
+
-
+
-
+
-
+class
pyams_thesaurus.thesaurus.
ThesaurusVocabulary
(context, **kw)¶
+ Bases:
+zope.componentvocabulary.vocabulary.UtilityVocabulary
Thesaurus utilities vocabulary
+-
+
-
+
interface
= <InterfaceClass pyams_thesaurus.interfaces.thesaurus.IThesaurus>¶
+
-
+
-
+
nameOnly
= False¶
+
-
+
-
+
-
+
pyams_thesaurus.thesaurus.
handle_added_thesaurus
(event)¶
+ Handle added thesaurus to init inner catalog
+
-
+
-
+
pyams_thesaurus.thesaurus.
handle_removed_extract
(event)¶
+ Handle removed extract
+
-
+
-
+
pyams_thesaurus.thesaurus.
handle_removed_thesaurus
(event)¶
+ Handle removed thesaurus
+