datacatalog.linkedstores.annotations.text package¶
Submodules¶
datacatalog.linkedstores.annotations.text.document module¶
-
class
datacatalog.linkedstores.annotations.text.document.
TextAnnotation
(*args, **kwargs)[source]¶ Bases:
attrdict.dictionary.AttrDict
-
DELETE_FIELD
= '_visible'¶
-
-
class
datacatalog.linkedstores.annotations.text.document.
TextAnnotationDocument
(schema=None, **kwargs)[source]¶ Bases:
datacatalog.extensible.ExtensibleAttrDict
Instantiates an instance of Text Annotation
-
DELETE_FIELD
= '_visible'¶
-
PARAMS
= [('body', True, 'body', None), ('subject', False, 'subject', ''), ('owner', True, 'owner', None), ('_visible', False, '_visible', True)]¶
-
-
class
datacatalog.linkedstores.annotations.text.document.
TextAnnotationSchema
(inheritance=True, **kwargs)[source]¶ Bases:
datacatalog.linkedstores.basestore.heritableschema.HeritableDocumentSchema
Defines the Text Annotation schema
-
DELETE_FIELD
= '_visible'¶
-
datacatalog.linkedstores.annotations.text.schemas module¶
-
datacatalog.linkedstores.annotations.text.schemas.
get_schemas
()[source]¶ Get JSON schemas for TextAnnotationDocument
Returns: Object and document JSON schema that define the store Return type: JSONSchemaCollection
datacatalog.linkedstores.annotations.text.store module¶
-
class
datacatalog.linkedstores.annotations.text.store.
StoreInterface
(mongodb, config={}, session=None, **kwargs)[source]¶ Bases:
datacatalog.linkedstores.annotations.text.store.TextAnnotationStore
-
class
datacatalog.linkedstores.annotations.text.store.
TextAnnotationStore
(mongodb, config={}, session=None, **kwargs)[source]¶ Bases:
datacatalog.linkedstores.basestore.softdelete.SoftDelete
,datacatalog.linkedstores.basestore.store.LinkedStore
Manage storage and retrieval of TagAnnotation documents
-
LINK_FIELDS
= ['child_of']¶
-
new_reply
(parent_text_uuid, body, subject=None, owner=None, token=None)[source]¶ Creates a new TextAnnotation record linked to its parent via child_of
Parameters: Returns: Representation of the newly-created reply
Return type:
-