kodexa 7.4.414781565138__py3-none-any.whl → 8.0.14958192442__py3-none-any.whl

kodexa/model/model.py

@@ -1,3259 +0,0 @@
-"""
-The core model provides definitions for all the base objects in the Kodexa Content Model
-"""
-import dataclasses
-import inspect
-import json
-import os
-import re
-import uuid
-from enum import Enum
-from typing import Any, List, Optional
-from addict import Dict
-import deepdiff
-import msgpack
-from pydantic import BaseModel, ConfigDict, Field
-
-from kodexa.model.objects import ContentObject, FeatureSet, DocumentTaxonValidation
-
-
-class Ref:
-    """
-    A class to represent a reference.
-
-    Attributes
-    ----------
-    ref : str
-        a string reference
-    version : str, optional
-        a version of the reference, default is None
-    resource : str, optional
-        a resource of the reference, default is None
-    slug : str
-        a slug of the reference, default is an empty string
-    org_slug : str
-        an organization slug of the reference, default is an empty string
-    object_ref : str
-        a formatted string of the reference
-
-    Methods
-    -------
-    __init__(self, ref: str)
-        Constructs all the necessary attributes for the Ref object.
-    """
-
-    def __init__(self, ref: str):
-        self.ref: str = ref
-        first_part = ref
-        self.version: Optional[str] = None
-        self.resource: Optional[str] = None
-        self.slug: str = ""
-        self.org_slug: str = ""
-
-        if ":" in ref:
-            (first_part, self.version) = ref.split(":")
-
-            if "/" in self.version:
-                (self.version, self.resource) = self.version.split("/")
-
-        (self.org_slug, self.slug) = first_part.split("/")
-
-        self.object_ref = (
-            f"{self.org_slug}/{self.slug}:{self.version}"
-            if self.version
-            else f"{self.org_slug}/{self.slug}"
-        )
-
-
-import addict
-
-
-class DocumentMetadata(addict.Dict):
-    """A flexible dict based approach to capturing metadata for the document.
-
-    This class extends from Dict to provide a flexible way to store and
-    manage metadata associated with a document.
-
-    Args:
-        *args: Variable length argument list.
-        **kwargs: Arbitrary keyword arguments.
-    """
-
-    """A flexible dict based approach to capturing metadata for the document"""
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
-
-class ContentException(dict):
-    """A content exception represents an issue identified during labeling or validation at the document level.
-
-    Attributes:
-        tag (Optional[str]): Tag associated with the exception.
-        message (str): Message describing the exception.
-        exception_details (Optional[str]): Detailed information about the exception.
-        group_uuid (Optional[str]): UUID of the group associated with the exception.
-        tag_uuid (Optional[str]): UUID of the tag associated with the exception.
-        exception_type (str): Type of the exception.
-        node_uuid (Optional[str]): UUID of the node associated with the exception.
-        severity (str): Severity level of the exception, default is 'ERROR'.
-        value (Optional[str]): Value associated with the exception.
-        exception_type_id (Optional[str]): ID of the exception type.
-    """
-
-    """A content exception represents an issue identified during labeling or validation at the document level"""
-
-    def __init__(
-            self,
-            exception_type: str,
-            message: str,
-            severity: str = "ERROR",
-            tag: Optional[str] = None,
-            group_uuid: Optional[str] = None,
-            tag_uuid: Optional[str] = None,
-            exception_type_id: Optional[str] = None,
-            exception_details: Optional[str] = None,
-            node_uuid: Optional[str] = None,
-            value: Optional[str] = None,
-            boolean_value: Optional[bool] = None,
-            *args,
-            **kwargs,
-    ):
-        super().__init__(*args, **kwargs)
-        self.tag = tag
-        self.message = message
-        self.exception_details = exception_details
-        self.group_uuid = group_uuid
-        self.tag_uuid = tag_uuid
-        self.exception_type = exception_type
-        self.node_uuid = node_uuid
-        self.severity = severity
-        self.value = value
-        self.exception_type_id = exception_type_id
-        self.boolean_value = boolean_value
-
-
-class Tag(Dict):
-    """A class to represent the metadata for a label that is applied as a feature on a content node.
-
-    Attributes:
-        start (Optional[int]): The start position (zero indexed) of the content within the node. If None, label is applied to the whole node.
-        end (Optional[int]): The end position (zero indexed) of the content within the node. If None, label is applied to the whole node.
-        value (Optional[str]): A string representing the value that was labelled in the node.
-        data (Optional[Any]): Any data object (JSON serializable) that you wish to associate with the label.
-        uuid (Optional[str]): The UUID for this tag instance. This allows tags that are on different content nodes to be related through the same UUID.
-        confidence (Optional[float]): The confidence of the tag in a range of 0-1.
-        index (Optional[int]): The tag index. This is used to allow us to order tags, and understand the ordering of parent child tag relationships.
-        bbox (Optional[List[int]]): The optional bounding box that can be used if the label is spatial (based on the node as the container).
-        group_uuid (Optional[str]): The UUID of the group that this tag belongs to. This is used to allow us to group tags together.
-        parent_group_uuid (Optional[str]): The UUID of the parent group that this tag belongs to. This is used to allow us to group tags together.
-        cell_index (Optional[int]): The cell index of the cell that this tag belongs to. This is used to allow us to group tags together.
-        note (Optional[str]): A note that can be associated with the tag.
-        status (Optional[str]): The status of the tag. This can be passed to an attribute status during extraction.
-        owner_uri (Optional[str]): The URI of the owner (ie. model://kodexa/narrative:1.0.0 or user://pdodds).
-    """
-
-    """A tag represents the metadata for a label that is applies as a feature on a content node"""
-
-    def __init__(
-            self,
-            start: Optional[int] = None,
-            end: Optional[int] = None,
-            value: Optional[str] = None,
-            uuid: Optional[str] = None,
-            data: Any = None,
-            *args,
-            confidence: Optional[float] = None,
-            group_uuid: Optional[str] = None,
-            parent_group_uuid: Optional[str] = None,
-            cell_index: Optional[int] = None,
-            index: Optional[int] = None,
-            bbox: Optional[List[int]] = None,
-            note: Optional[str] = None,
-            status: Optional[str] = None,
-            owner_uri: Optional[str] = None,
-            is_dirty: Optional[bool] = None,
-            **kwargs,
-    ):
-        super().__init__(*args, **kwargs)
-
-        import uuid as uuid_gen
-        self.start: Optional[int] = start
-        """The start position (zero indexed) of the content within the node, if None then label is applied to the whole node"""
-        self.end: Optional[int] = end
-        """The end position (zero indexed) of the content within the node, if None then label is applied to the whole node"""
-        self.value: Optional[str] = value
-        """A string representing the value that was labelled in the node"""
-        self.data: Optional[Any] = data
-        """Any data object (JSON serializable) that you wish to associate with the label"""
-        self.uuid: Optional[str] = uuid or str(uuid_gen.uuid4())
-        """The UUID for this tag instance, this allows tags that are on different content nodes to be related through the same UUID"""
-        self.confidence: Optional[float] = confidence
-        """The confidence of the tag in a range of 0-1"""
-        self.index: Optional[int] = index
-        """The tag index, this is used to allow us to order tags, and understand the ordering of parent child tag relationships"""
-        self.bbox: Optional[List[int]] = bbox
-        """The optional bounding box that can be used if the label is spatial (based on the node as the container)"""
-        self.group_uuid: Optional[str] = group_uuid
-        """The UUID of the group that this tag belongs to, this is used to allow us to group tags together"""
-        self.parent_group_uuid: Optional[str] = parent_group_uuid
-        """The UUID of the parent group that this tag belongs to, this is used to allow us to group tags together"""
-        self.cell_index: Optional[int] = cell_index
-        """The cell index of the cell that this tag belongs to, this is used to allow us to group tags together"""
-        self.note: Optional[str] = note
-        """A note that can be associated with the tag"""
-        self.status: Optional[str] = status
-        """The status of the tag, this can be passed to an attribute status during extraction"""
-        self.owner_uri: Optional[str] = owner_uri
-        """The URI of the owner (ie. model://kodexa/narrative:1.0.0 or user://pdodds)"""
-        self.is_dirty: Optional[bool] = is_dirty
-        """Whether or not the """
-        # Pull the cell index from the data to the tag if we have it in the data
-        if self.cell_index is None:
-            if data and "cell_index" in data:
-                self.cell_index = data["cell_index"]
-
-
-class FindDirection(Enum):
-    """
-    Enum class for defining the direction of search in a tree structure.
-
-    Attributes:
-        CHILDREN (int): Represents the direction towards children nodes.
-        PARENT (int): Represents the direction towards parent node.
-    """
-
-    """ """
-    CHILDREN = 1
-    PARENT = 2
-
-
-class Traverse(Enum):
-    """
-    An enumeration class that represents different types of traversals.
-
-    Attributes:
-        SIBLING (int): Represents traversal to a sibling.
-        CHILDREN (int): Represents traversal to children.
-        PARENT (int): Represents traversal to a parent.
-        ALL (int): Represents traversal to all types of nodes.
-    """
-
-    """ """
-    SIBLING = 1
-    CHILDREN = 2
-    PARENT = 3
-    ALL = 4
-
-
-class ContentNode(object):
-    """A Content Node identifies a section of the document containing logical
-    grouping of information.
-
-    The node will have content and can include any number of features.
-
-    You should always create a node using the Document's create_node method to
-    ensure that the correct mixins are applied.
-
-    >>> new_page = document.create_node(node_type='page')
-    <kodexa.model.model.ContentNode object at 0x7f80605e53c8>
-    >>> current_content_node.add_child(new_page)
-
-    >>> new_page = document.create_node(node_type='page', content='This is page 1')
-    <kodexa.model.model.ContentNode object at 0x7f80605e53c8>
-    >>> current_content_node.add_child(new_page)
-
-    """
-
-    def __init__(
-            self,
-            document,
-            node_type: str,
-            content: Optional[str] = None,
-            content_parts: Optional[List[Any]] = None,
-            parent=None,
-            index: Optional[int] = None,
-            virtual: bool = False,
-    ):
-        self.node_type: str = node_type
-        """The node type (ie. line, page, cell etc)"""
-        self.document: Document = document
-        """The document that the node belongs to"""
-        self._content_parts: Optional[List[Any]] = content_parts
-        """The children of the content node"""
-        self.index: Optional[int] = index
-        """The index of the content node"""
-        self.uuid: Optional[int] = None
-        """The ID of the content node"""
-        self.virtual: bool = virtual
-        """Is the node virtual (ie. it doesn't actually exist in the document)"""
-
-        self._parent_uuid = parent.uuid if parent else None
-
-        if content is not None and len(self.get_content_parts()) == 0:
-            self.set_content_parts([content])
-
-    def get_content_parts(self):
-        return self.document.get_persistence().get_content_parts(self)
-
-    def set_content_parts(self, content_parts):
-        self.document.get_persistence().update_content_parts(self, content_parts)
-
-    def update(self):
-        """
-        Update this node in the document persistence
-
-        :return:
-        """
-        self.document.get_persistence().update_node(self)
-
-    @property
-    def content(self):
-        if len(self.get_content_parts()) == 0:
-            return None
-
-        s = ""
-        for part in self.get_content_parts():
-            if isinstance(part, str):
-                if s != "":
-                    s += " "
-                s += part
-
-        return s
-
-    @content.setter
-    def content(self, new_content):
-        if len(self.get_content_parts()) == 0:
-            self.set_content_parts([new_content])
-        else:
-            # We need to remove all the strings and add this one
-            # back at the front
-            parts = self.get_content_parts()
-            filtered_parts = list(filter(lambda part: isinstance(part, int), parts))
-            if new_content is not None and new_content != "":
-                filtered_parts.insert(0, new_content)
-            self.set_content_parts(filtered_parts)
-
-    def __eq__(self, other):
-        return (
-                other is not None
-                and self.uuid == other.uuid
-                and (self.uuid is not None and other.uuid is not None)
-        )
-
-    def __hash__(self):
-        return hash(self.uuid)
-
-    def get_parent(self):
-        return self.document.get_persistence().get_parent(self)
-
-    def __str__(self):
-        return (
-                f"ContentNode {self.uuid} [node_type:{self.node_type}] ({len(self.get_features())} features, {len(self.get_children())} children) ["
-                + str(self.content)
-                + "]"
-        )
-
-    def to_json(self):
-        """Create a JSON string representation of this ContentNode.
-
-        Args:
-
-        Returns:
-          str: The JSON formatted string representation of this ContentNode.
-
-        >>> node.to_json()
-        """
-        return json.dumps(self.to_dict())
-
-    def to_dict(self):
-        """Create a dictionary representing this ContentNode's structure and content.
-
-        Args:
-
-        Returns:
-          dict: The properties of this ContentNode and all of its children structured as a dictionary.
-
-        >>> node.to_dict()
-        """
-        new_dict = {
-            "node_type": self.node_type,
-            "content": self.content,
-            "content_parts": self.get_content_parts(),
-            "features": [],
-            "index": self.index,
-            "children": [],
-            "uuid": self.uuid,
-        }
-        for feature in self.get_features():
-            new_dict["features"].append(feature.to_dict())
-
-        for child in self.get_children():
-            new_dict["children"].append(child.to_dict())
-        return new_dict
-
-    @staticmethod
-    def from_dict(document, content_node_dict: dict, parent=None):
-        """Build a new ContentNode from a dictionary represention.
-
-        Args:
-          document (Document): The Kodexa document from which the new ContentNode will be created (not added).
-          content_node_dict (Dict): The dictionary-structured representation of a ContentNode.  This value will be unpacked into a ContentNode.
-          parent (Optional[ContentNode]): Optionally the parent content node
-        Returns:
-          ContentNode: A ContentNode containing the unpacked values from the content_node_dict parameter.
-
-        >>> ContentNode.from_dict(document, content_node_dict)
-        """
-
-        node_type = (
-            content_node_dict["type"]
-            if document.version == Document.PREVIOUS_VERSION
-            else content_node_dict["node_type"]
-        )
-
-        new_content_node = document.create_node(
-            node_type=node_type,
-            content=content_node_dict["content"]
-            if "content" in content_node_dict
-            else None,
-            index=content_node_dict["index"],
-            parent=parent,
-        )
-
-        if (
-                "content_parts" in content_node_dict
-                and len(content_node_dict["content_parts"]) > 0
-        ):
-            new_content_node.set_content_parts(content_node_dict["content_parts"])
-
-        for dict_feature in content_node_dict["features"]:
-            feature_type = dict_feature["name"].split(":")[0]
-            if feature_type == "tag":
-                new_content_node.add_feature(
-                    feature_type,
-                    dict_feature["name"].split(":")[1],
-                    dict_feature["value"],
-                    dict_feature["single"],
-                    True,
-                )
-            else:
-                new_content_node.add_feature(
-                    feature_type,
-                    dict_feature["name"].split(":")[1],
-                    dict_feature["value"],
-                    dict_feature["single"],
-                    True,
-                )
-
-        for dict_child in content_node_dict["children"]:
-            ContentNode.from_dict(document, dict_child, new_content_node)
-
-        return new_content_node
-
-    def add_child_content(
-            self, node_type: str, content: str, index: Optional[int] = None
-    ) -> "ContentNode":
-        """Convenience method to allow you to quick add a child node with a type and content
-
-        Args:
-          node_type: the node type
-          content: the content
-          index: the index (optional) (Default value = None)
-
-        Returns:
-          the new ContentNode
-
-        """
-        new_node = self.document.create_node(
-            node_type=node_type, parent=self, content=content
-        )
-        self.add_child(new_node, index)
-        return new_node
-
-    def add_child(self, child, index: Optional[int] = None):
-        """Add a ContentNode as a child of this ContentNode
-
-        Args:
-          child (ContentNode): The node that will be added as a child of this node
-          index (Optional[int]): The index at which this child node should be added; defaults to None.  If None, index is set as the count of child node elements.
-
-        Returns:
-
-        >>> new_page = document.create_node(node_type='page')
-            <kodexa.model.model.ContentNode object at 0x7f80605e53c8>
-            >>> current_content_node.add_child(new_page)
-        """
-        if index is None:
-            if len(self.get_children()) > 0:
-                child.index = self.get_children()[-1].index + 1
-            else:
-                child.index = 0
-        else:
-            child.index = index
-
-        self.document.get_persistence().add_content_node(child, self)
-
-    def remove_child(self, content_node):
-        self.document.get_persistence().remove_content_node(content_node)
-
-    def get_children(self):
-        """Returns a list of the children of this node.
-
-        Returns:
-          list[ContentNode]: The list of child nodes for this ContentNode.
-
-        >>> node.get_children()
-        """
-        return self.document.get_persistence().get_children(self)
-
-    def set_feature(self, feature_type, name, value):
-        """Sets a feature for this ContentNode, replacing the value if a feature by this type and name already exists.
-
-        Args:
-          feature_type (str): The type of feature to be added to the node.
-          name (str): The name of the feature.
-          value (Any): The value of the feature.
-
-        Returns:
-          ContentFeature: The feature that was added to this ContentNode
-
-        >>> new_page = document.create_node(node_type='page')
-           <kodexa.model.model.ContentNode object at 0x7f80605e53c8>
-           >>> new_page.add_feature('pagination','pageNum',1)
-        """
-        self.remove_feature(feature_type, name)
-        return self.add_feature(feature_type, name, value)
-
-    def update_feature(self, feature: "ContentFeature"):
-        """
-        Update a feature on this node in document persistence
-
-        :param feature:
-        :return:
-        """
-        self.document.get_persistence().remove_feature(
-            self, feature.feature_type, feature.name
-        )
-        self.document.get_persistence().add_feature(self, feature)
-
-    def add_feature(self, feature_type, name, value, single=True, serialized=False):
-        """
-        Add a new feature to this ContentNode.
-
-        Note: if a feature for this feature_type/name already exists, the new value will be added to the existing feature;
-        therefore the feature value might become a list.
-
-        Args:
-          feature_type (str): The type of feature to be added to the node.
-          name (str): The name of the feature.
-          value (Any): The value of the feature.
-          single (boolean): Indicates that the value is singular, rather than a collection (ex: str vs list); defaults to True.
-          serialized (boolean): Indicates that the value is/is not already serialized; defaults to False.
-
-        Returns:
-          ContentFeature: The feature that was added to this ContentNode.
-
-        >>> new_page = document.create_node(node_type='page')
-           <kodexa.model.model.ContentNode object at 0x7f80605e53c8>
-           >>> new_page.add_feature('pagination','pageNum',1)
-        """
-        if self.has_feature(feature_type, name):
-            existing_feature = self.get_feature(feature_type, name)
-            if isinstance(existing_feature.value, list):
-                existing_feature.value.append(value)
-            else:
-                existing_feature.value = [existing_feature.value, value]
-            self.update_feature(existing_feature)
-            return existing_feature
-
-        # Make sure that we treat the value as list all the time
-        new_feature = ContentFeature(
-            feature_type,
-            name,
-            [value] if single and not serialized else value,
-            single=single,
-        )
-        self.document.get_persistence().add_feature(self, new_feature)
-        return new_feature
-
-    def delete_children(
-            self, nodes: Optional[List] = None, exclude_nodes: Optional[List] = None
-    ):
-        """Delete the children of this node, you can either supply a list of the nodes to delete
-           or the nodes to exclude from the delete, if neither are supplied then we delete all the children.
-
-           Note there is precedence in place, if you have provided a list of nodes to delete then the nodes
-           to exclude is ignored.
-
-        Args:
-          nodes: Optional[List[ContentNode]] a list of content nodes that are children to delete
-          exclude_nodes: Optional[List[ContentNode]] a list of content node that are children not to delete
-          nodes: Optional[List]:  (Default value = None)
-          exclude_nodes: Optional[List]:  (Default value = None)
-        """
-        children_to_delete = []
-
-        for child_node in self.get_children():
-            if nodes is not None:
-                for node_to_delete in nodes:
-                    if node_to_delete.uuid == child_node.uuid:
-                        children_to_delete.append(child_node)
-            elif exclude_nodes is not None:
-                if len(exclude_nodes) == 0:
-                    children_to_delete.append(child_node)
-                else:
-                    for nodes_to_exclude in exclude_nodes:
-                        if nodes_to_exclude.uuid != child_node.uuid:
-                            children_to_delete.append(child_node)
-            else:
-                children_to_delete.append(child_node)
-
-        for child_to_delete in children_to_delete:
-            if child_to_delete in self.get_children():
-                self.document.get_persistence().remove_content_node(child_to_delete)
-
-    def get_feature(self, feature_type, name):
-        """Gets the value for the given feature.
-
-        Args:
-          feature_type (str): The type of the feature.
-          name (str): The name of the feature.
-
-        Returns:
-          ContentFeature or None: The feature with the specified type & name.  If no feature is found, None is returned.
-          Note that if there are more than one instance of the feature you will only get the first one
-
-        >>> new_page.get_feature('pagination','pageNum')
-           1
-        """
-        hits = [
-            i
-            for i in self.get_features()
-            if i.feature_type == feature_type and i.name == name
-        ]
-        if len(hits) > 0:
-
-            # We have a situation where the feature isn't a dict since it
-            # was added as a "Tag", lets turn it back into a dict to be
-            # consistent
-            if isinstance(hits[0].value, Tag):
-                hits[0].value = hits[0].value.to_dict()
-
-            return hits[0]
-
-        return None
-
-    def get_features_of_type(self, feature_type):
-        """Get all features of a specific type.
-
-        Args:
-          feature_type (str): The type of the feature.
-
-        Returns:
-          list[ContentFeature]: A list of feature with the specified type.  If no features are found, an empty list is returned.
-
-        >>> new_page.get_features_of_type('my_type')
-           []
-        """
-        return [i for i in self.get_features() if i.feature_type == feature_type]
-
-    def has_feature(self, feature_type: str, name: str):
-        """Determines if a feature with the given feature and name exists on this content node.
-
-        Args:
-          feature_type (str): The type of the feature.
-          name (str): The name of the feature.
-
-        Returns:
-          bool: True if the feature is present; else, False.
-
-        >>> new_page.has_feature('pagination','pageNum')
-           True
-        """
-        return (
-                len(
-                    [
-                        i
-                        for i in self.get_features()
-                        if i.feature_type == feature_type and i.name == name
-                    ]
-                )
-                > 0
-        )
-
-    def get_features(self):
-        """Get all features on this ContentNode.
-
-        Returns:
-          list[ContentFeature]: A list of the features on this ContentNode.
-
-        """
-        return self.document.get_persistence().get_features(self)
-
-    def remove_feature(
-            self, feature_type: str, name: str, include_children: bool = False
-    ):
-        """Removes the feature with the given name and type from this node.
-
-        Args:
-          feature_type (str): The type of the feature.
-          name (str): The name of the feature.
-          include_children (bool): also remove the feature from nodes children
-
-        >>> new_page.remove_feature('pagination','pageNum')
-        """
-        self.document.get_persistence().remove_feature(self, feature_type, name)
-
-        if include_children:
-            for child in self.get_children():
-                child.remove_feature(feature_type, name, include_children)
-
-    def get_feature_value(self, feature_type: str, name: str) -> Optional[Any]:
-        """Get the value for a feature with the given name and type on this ContentNode.
-
-        Args:
-          feature_type (str): The type of the feature.
-          name (str): The name of the feature.
-
-        Returns:
-          Any or None: The value of the feature if it exists on this ContentNode otherwise, None, note this
-          only returns the first value (check single to determine if there are multiple)
-
-        >>> new_page.get_feature_value('pagination','pageNum')
-           1
-        """
-        feature = self.get_feature(feature_type, name)
-
-        # Need to make sure we handle the idea of a single value for a feature
-        return None if feature is None else feature.value[0]
-
-    def get_feature_values(self, feature_type: str, name: str) -> Optional[List[Any]]:
-        """Get the value for a feature with the given name and type on this ContentNode.
-
-        Args:
-          feature_type (str): The type of the feature.
-          name (str): The name of the feature.
-
-        Returns:
-          The list of feature values or None if there is no feature
-
-        >>> new_page.get_feature_value('pagination','pageNum')
-           1
-        """
-        feature = self.get_feature(feature_type, name)
-
-        # Simply return all the feature values
-        return None if feature is None else feature.value
-
-    def get_content(self):
-        """Get the content of this node.
-
-        Args:
-
-        Returns:
-          str: The content of this ContentNode.
-
-        >>> new_page.get_content()
-           "This is page one"
-        """
-        return self.content
-
-    def get_node_type(self):
-        """Get the type of this node.
-
-        Args:
-
-        Returns:
-          str: The type of this ContentNode.
-
-        >>> new_page.get_content()
-           "page"
-        """
-        return self.node_type
-
-    def select_first(self, selector, variables=None) -> Optional["ContentNode"]:
-        """Select and return the first child of this node that match the selector value.
-
-        Args:
-          selector (str): The selector (ie. //*)
-          variables (dict, optional): A dictionary of variable name/value to use in substituion; defaults to None.  Dictionary keys should match a variable specified in the selector.
-
-        Returns:
-          Optional[ContentNode]: The first matching node or none
-
-        >>> document.get_root().select_first('.')
-           ContentNode
-
-        >>> document.get_root().select_first('//*[hasTag($tagName)]', {"tagName": "div"})
-           ContentNode
-        """
-        result = self.select(selector, variables)
-        return result[0] if len(result) > 0 else None
-
-    def select(self, selector, variables=None, first_only=False):
-        """Select and return the child nodes of this node that match the selector value.
-
-        Args:
-          selector (str): The selector (ie. //*)
-          variables (dict, optional): A dictionary of variable name/value to use in substituion; defaults to None.  Dictionary keys should match a variable specified in the selector.
-          first_only (bool, optional): If True, only the first matching node will be returned; defaults to False.
-
-        Returns:
-          list[ContentNode]: A list of the matching content nodes.  If no matches are found, the list will be empty.
-
-        >>> document.get_root().select('.')
-           [ContentNode]
-
-        >>> document.get_root().select('//*[hasTag($tagName)]', {"tagName": "div"})
-           [ContentNode]
-        """
-
-        if variables is None:
-            variables = {}
-        from kodexa.selectors import parse
-        from kodexa.selectors.ast import SelectorContext
-
-        context = SelectorContext(self.document, first_only=first_only)
-        self.document.get_persistence().flush_cache()
-        parsed_selector = parse(selector)
-        return parsed_selector.resolve(self, variables, context)
-
-    def get_all_content(self, separator=" ", strip=True):
-        """Get this node's content, concatenated with all of its children's content.
-
-        Args:
-          separator(str, optional): The separator to use in joining content together; defaults to " ".
-          strip(boolean, optional): Strip the result
-
-        Returns:
-          str: The complete content for this node concatenated with the content of all child nodes.
-
-        >>> document.content_node.get_all_content()
-
-            "This string is made up of multiple nodes"
-        """
-        s = ""
-        children = self.get_content_parts()
-        for part in children:
-            if isinstance(part, str):
-                if s != "":
-                    s += separator
-                s += part
-            if isinstance(part, int):
-                if s != "":
-                    s += separator
-                s += [
-                    child.get_all_content(separator, strip=strip)
-                    for child in self.get_children()
-                    if child.index == part
-                ][0]
-
-        # We need to determine if we have missing children and add them to the end
-        for child in self.get_children():
-            if child.index not in self.get_content_parts():
-                if s != "":
-                    s += separator
-                s += child.get_all_content(separator, strip=strip)
-
-        return s.strip() if strip else s
-
-    def adopt_children(self, nodes_to_adopt, replace=False):
-        """This will take a list of content nodes and adopt them under this node, ensuring they are re-parented.
-
-        Args:
-          nodes_to_adopt (List[ContentNode]): A list of ContentNodes that will be added to the end of this node's children collection
-          replace (bool): If True, will remove all current children and replace them with the new list; defaults to True
-
-        >>> # select all nodes of type 'line', then the root node 'adopts' them
-            >>> # and replaces all it's existing children with these 'line' nodes.
-            >>> document.get_root().adopt_children(document.select('//line'), replace=True)
-        """
-        child_idx_base = 0
-
-        # We need to copy this since we might well mutate
-        # it as we adopt
-        children = nodes_to_adopt.copy()
-        for existing_child in self.get_children():
-            if existing_child not in children:
-                existing_child.index = child_idx_base
-                self.document.get_persistence().update_node(existing_child)
-            else:
-                existing_child.index = children.index(existing_child)
-                existing_child._parent_uuid = self.uuid
-                self.document.get_persistence().update_node(existing_child)
-            child_idx_base += 1
-
-        # Copy to avoid mutation
-        for new_child in children.copy():
-            if new_child not in self.get_children():
-                self.add_child(new_child, children.index(new_child))
-                child_idx_base += 1
-
-        if replace:
-            # Copy to avoid mutation
-            for child in self.get_children().copy():
-                if child not in children:
-                    self.remove_child(child)
-
-    def remove_tag(self, tag_name):
-        """Remove a tag from this content node.
-
-        Args:
-          str: tag_name: The name of the tag that should be removed.
-          tag_name:
-
-        Returns:
-
-        >>> document.get_root().remove_tag('foo')
-        """
-        self.remove_feature("tag", tag_name)
-
-    def set_statistics(self, statistics):
-        """Set the spatial statistics for this node
-
-        Args:
-          statistics: the statistics object
-
-        Returns:
-
-        >>> document.select.('//page')[0].set_statistics(NodeStatistics())
-        """
-        self.add_feature("spatial", "statistics", statistics)
-
-    def get_statistics(self):
-        """Get the spatial statistics for this node
-
-
-        :return: the statistics object (or None if not set)
-
-        Args:
-
-        Returns:
-
-        >>> document.select.('//page')[0].get_statistics()
-            <kodexa.spatial.NodeStatistics object at 0x7f80605e53c8>
-        """
-        return self.get_feature_value("spatial", "statistics")
-
-    def set_bbox(self, bbox):
-        """Set the bounding box for the node, this is structured as:
-
-        [x1,y1,x2,y2]
-
-        Args:
-          bbox: the bounding box array
-
-
-        >>> document.select.('//page')[0].set_bbox([10,20,50,100])
-        """
-        self.set_feature("spatial", "bbox", bbox)
-
-    def get_bbox(self):
-        """Get the bounding box for the node, this is structured as:
-
-        [x1,y1,x2,y2]
-
-
-        :return: the bounding box array
-
-        >>> document.select.('//page')[0].get_bbox()
-            [10,20,50,100]
-        """
-        return self.get_feature_value("spatial", "bbox")
-
-    def set_bbox_from_children(self):
-        """Set the bounding box for this node based on its children"""
-
-        x_min = None
-        x_max = None
-        y_min = None
-        y_max = None
-
-        for child in self.get_children():
-            child_bbox = child.get_bbox()
-            if child_bbox:
-                if not x_min or x_min > child_bbox[0]:
-                    x_min = child_bbox[0]
-                if not x_max or x_max < child_bbox[2]:
-                    x_max = child_bbox[2]
-                if not y_min or y_min > child_bbox[1]:
-                    y_min = child_bbox[1]
-                if not y_max or y_max < child_bbox[3]:
-                    y_max = child_bbox[3]
-
-        if x_min:
-            self.set_bbox([x_min, y_min, x_max, y_max])
-
-    def set_rotate(self, rotate):
-        """Set the rotate of the node
-
-        Args:
-          rotate: the rotation of the node
-
-        Returns:
-
-        >>> document.select.('//page')[0].set_rotate(90)
-        """
-        self.add_feature("spatial", "rotate", rotate)
-
-    def get_rotate(self):
-        """Get the rotate of the node
-
-
-        :return: the rotation of the node
-
-        Args:
-
-        Returns:
-
-        >>> document.select.('//page')[0].get_rotate()
-            90
-        """
-        return self.get_feature_value("spatial", "rotate")
-
-    def get_x(self):
-        """Get the X position of the node
-
-
-        :return: the X position of the node
-
-        Args:
-
-        Returns:
-
-        >>> document.select.('//page')[0].get_x()
-            10
-        """
-        self_bbox = self.get_bbox()
-        if self_bbox:
-            return self_bbox[0]
-
-        return None
-
-    def get_y(self):
-        """Get the Y position of the node
-
-
-        :return: the Y position of the node
-
-        Args:
-
-        Returns:
-
-        >>> document.select.('//page')[0].get_y()
-            90
-        """
-        self_bbox = self.get_bbox()
-        if self_bbox:
-            return self_bbox[1]
-
-        return None
-
-    def get_width(self):
-        """Get the width of the node
-
-
-        :return: the width of the node
-
-        Args:
-
-        Returns:
-
-        >>> document.select.('//page')[0].get_width()
-            70
-        """
-        self_bbox = self.get_bbox()
-        if self_bbox:
-            return self_bbox[2] - self_bbox[0]
-
-        return None
-
-    def get_height(self):
-        """Get the height of the node
-
-
-        :return: the height of the node
-
-        Args:
-
-        Returns:
-
-        >>> document.select.('//page')[0].get_height()
-            40
-        """
-        self_bbox = self.get_bbox()
-        if self_bbox:
-            return self_bbox[3] - self_bbox[1]
-
-        return None
-
-    def copy_tag(self, selector=".", existing_tag_name=None, new_tag_name=None):
-        """Creates a new tag of 'new_tag_name' on the selected content node(s) with the same information as the tag with 'existing_tag_name'.
-        Both existing_tag_name and new_tag_name values are required and must be different from one another.  Otherwise, no action is taken.
-        If a tag with the 'existing_tag_name' does not exist on a selected node, no action is taken for that node.
-
-        Args:
-          selector: The selector to identify the source nodes to work on (default . - the current node)
-          str: existing_tag_name: The name of the existing tag whose values will be copied to the new tag.
-          str: new_tag_name: The name of the new tag.  This must be different from the existing_tag_name.
-          existing_tag_name:  (Default value = None)
-          new_tag_name:  (Default value = None)
-
-        Returns:
-
-        >>> document.get_root().copy_tag('foo', 'bar')
-        """
-        if (
-                existing_tag_name is None
-                or new_tag_name is None
-                or existing_tag_name == new_tag_name
-        ):
-            return  # do nothing, just exit function
-
-        for node in self.select(selector):
-            existing_tag_values = node.get_feature_values("tag", existing_tag_name)
-            if existing_tag_values:
-                for val in existing_tag_values:
-                    tag = Tag(
-                        start=val["start"],
-                        end=val["end"],
-                        value=val["value"],
-                        uuid=val["uuid"],
-                        data=val["data"],
-                    )
-                    node.add_feature("tag", new_tag_name, tag)
-
-    def collect_nodes_to(self, end_node):
-        """Get the the sibling nodes between the current node and the end_node.
-
-        Args:
-          ContentNode: end_node: The node to end at
-          end_node:
-
-        Returns:
-          list[ContentNode]: A list of sibling nodes between this node and the end_node.
-
-        >>> document.content_node.get_children()[0].collect_nodes_to(end_node=document.content_node.get_children()[5])
-        """
-        nodes = []
-        current_node = self
-        while current_node.uuid != end_node.uuid:
-            nodes.append(current_node)
-            if current_node.has_next_node():
-                current_node = current_node.next_node()
-            else:
-                break
-        return nodes
-
-    def tag_nodes_to(self, end_node, tag_to_apply, tag_uuid: str = None):
-        """Tag all the nodes from this node to the end_node with the given tag name
-
-        Args:
-          end_node (ContentNode): The node to end with
-          tag_to_apply (str): The tag name that will be applied to each node
-          tag_uuid (str): The tag uuid used if you want to group them
-
-        >>> document.content_node.get_children()[0].tag_nodes_to(document.content_node.get_children()[5], tag_name='foo')
-        """
-        [
-            node.tag(tag_to_apply, tag_uuid=tag_uuid)
-            for node in self.collect_nodes_to(end_node)
-        ]
-
-    def tag_range(
-            self,
-            start_content_re,
-            end_content_re,
-            tag_to_apply,
-            node_type_re=".*",
-            use_all_content=False,
-    ):
-        """This will tag all the child nodes between the start and end content regular expressions
-
-        Args:
-          start_content_re: The regular expression to match the starting child
-          end_content_re: The regular expression to match the ending child
-          tag_to_apply: The tag name that will be applied to the nodes in range
-          node_type_re: The node type to match (default is all)
-          use_all_content: Use full content (including child nodes, default is False)
-
-        Returns:
-
-        >>> document.content_node.tag_range(start_content_re='.*Cheese.*', end_content_re='.*Fish.*', tag_to_apply='foo')
-        """
-
-        # Could be line, word, or content-area
-        all_nodes = self.select(f"//*[typeRegex('{node_type_re}')]")
-
-        start_index_list = [
-            n_idx
-            for n_idx, node in enumerate(all_nodes)
-            if re.compile(start_content_re).match(
-                node.get_all_content() if use_all_content else node.content
-            )
-        ]
-        end_index_list = [
-            n_idx
-            for n_idx, node in enumerate(all_nodes)
-            if re.compile(end_content_re).match(
-                node.get_all_content() if use_all_content else node.content
-            )
-        ]
-
-        start_index = (
-            0
-            if start_content_re == ""
-            else start_index_list[0]
-            if len(start_index_list) > 0
-            else None
-        )
-        if start_index is not None:
-            end_index_list = [i for i in end_index_list if i >= start_index]
-
-        end_index = (
-            len(all_nodes)
-            if end_content_re == ""
-            else end_index_list[0]
-            if len(end_index_list) > 0
-            else len(all_nodes)
-        )
-
-        if start_index is not None:
-            [node.tag(tag_to_apply) for node in all_nodes[start_index:end_index]]
-
-    def tag(
-            self,
-            tag_to_apply,
-            selector=".",
-            content_re=None,
-            use_all_content=False,
-            node_only=None,
-            fixed_position=None,
-            data=None,
-            separator=" ",
-            tag_uuid: str = None,
-            confidence=None,
-            value=None,
-            use_match=True,
-            index=None,
-            cell_index=None,
-            group_uuid=None,
-            parent_group_uuid=None,
-            note=None,
-            status=None,
-            owner_uri=None,
-            is_dirty=None,
-            sort_by_bbox: bool=False,
-    ):
-        """
-        This will tag (see Feature Tagging) the expression groups identified by the regular expression.
-
-        Note that if you use the flag use_all_content then node_only will default to True if not set, else it
-        will default to False
-
-        Args:
-          tag_to_apply: The name of tag that will be applied to the node
-          selector: The selector to identify the source nodes to work on (default . - the current node)
-          content_re: The regular expression that you wish to use to tag, note that we will create a tag for each matching group (Default value = None)
-          use_all_content: Apply the regular expression to the all_content (include content from child nodes) (Default value = False)
-          separator: Separator to use for use_all_content (Default value = " ")
-          node_only: Ignore the matching groups and tag the whole node (Default value = None)
-          fixed_position: Use a fixed position, supplied as a tuple i.e. - (4,10) tag from position 4 to 10 (default None)
-          data: A dictionary of data for the given tag (Default value = None)
-          tag_uuid: A UUID used to tie tags in order to demonstrate they're related and form a single concept.
-            For example, if tagging the two words "Wells" and "Fargo" as an ORGANIZATION, the tag on both words should have the
-            same tag_uuid in order to indicate they are both needed to form the single ORGANIZATION.  If a tag_uuid is provided, it is used
-            on all tags created in this method.  This may result in multiple nodes or multiple feature values having the same tag_uuid.
-            For example, if the selector provided results in more than one node being selected, each node would be tagged with the same tag_uuid.
-            The same holds true if a content_re value is provided, node_only is set to False, and multiple matches are found for the content_re
-            pattern.  In that case, each feature value would share the same UUID.
-            If no tag_uuid is provided, a new uuid is generated for each tag instance.
-              tag_uuid: str:  (Default value = None)
-          confidence: The confidence in the tag (0-1)
-          value: The value you wish to store with the tag, this allows you to provide text that isn't part of the content but represents the data you wish tagged
-          use_match: If True (default) we will use match for regex matching, if False we will use search
-          index: The index for the tag
-          cell_index: The cell index for the tag
-          group_uuid: The group uuid for the tag
-          parent_group_uuid: The parent group uuid for the tag
-          note: a text note for the tag
-          status: a status for the tag, this can be transistioned to an attribute status during extraction
-          owner_uri: the uri of the entity that created the tag (model vs user; example: model://cdad-healthcare/cdad-excel-model:1.0.0 or user://pdodds)
-          is_dirty: when the model is run, is_dirty = false for all tags. New tags and editted tags, is_dirty = true.
-
-        >>> document.content_node.tag('is_cheese')
-        """
-
-        if use_all_content and node_only is None:
-            node_only = True
-        elif node_only is None:
-            node_only = False
-
-        def get_tag_uuid(tag_uuid):
-            """
-            This function returns the provided tag_uuid if it exists, otherwise it generates a new UUID.
-
-            Args:
-                tag_uuid (str): The UUID of the tag.
-
-            Returns:
-                str: The provided tag_uuid if it exists, otherwise a newly generated UUID.
-            """
-            if tag_uuid:
-                return tag_uuid
-
-            return str(uuid.uuid4())
-
-        def tag_node_position(
-                node_to_check, start, end, node_data, tag_uuid, offset=0, value=None, sort_by_bbox: bool=False
-        ):
-            """
-            This function tags a node position in a given data structure. It iterates over the content parts of the node to check,
-            and based on the type of the part (string or integer), it performs different operations. If the part is a string, it
-            adjusts the start and end positions and adds a feature to the node. If the part is an integer, it finds the corresponding
-            child node and recursively calls the function on the child node. After processing all parts, it checks for any missing
-            children and processes them as well. Finally, it checks if the length of all content matches the calculated content length.
-
-            Args:
-                node_to_check (Node): The node to check and tag.
-                start (int): The start position of the tag.
-                end (int): The end position of the tag.
-                node_data (dict): The data associated with the node.
-                tag_uuid (str): The UUID of the tag.
-                offset (int, optional): The offset to apply. Defaults to 0.
-                value (str, optional): The value to use for the tag. If None, the part of the content at the start and end positions is used. Defaults to None.
-
-            Raises:
-                Exception: If an invalid part is encountered in the content parts of the node to check.
-                Exception: If there is a mismatch between the length of all content and the calculated content length.
-
-            Returns:
-                int: The calculated content length.
-            """
-            content_length = 0
-            original_start = start
-            original_end = end
-            for part_idx, part in enumerate(node_to_check.get_content_parts()):
-                if isinstance(part, str):
-                    if len(part) > 0:
-                        # It is just content
-                        part_length = len(part)
-                        if part_idx > 0:
-                            end = end - len(separator)
-                            content_length = content_length + len(separator)
-                            offset = offset + len(separator)
-                            start = (
-                                0
-                                if start - len(separator) < 0
-                                else start - len(separator)
-                            )
-
-                        if start < part_length and end < part_length:
-                            node_to_check.add_feature(
-                                "tag",
-                                tag_to_apply,
-                                Tag(
-                                    original_start,
-                                    original_end,
-                                    part[start:end] if value is None else value,
-                                    data=node_data,
-                                    uuid=tag_uuid,
-                                    confidence=confidence,
-                                    index=index,
-                                    parent_group_uuid=parent_group_uuid,
-                                    group_uuid=group_uuid,
-                                    cell_index=cell_index,
-                                    note=note,
-                                    status=status,
-                                    owner_uri=owner_uri,
-                                    is_dirty=is_dirty,
-                                ),
-                            )
-                            return -1
-                        if start < part_length <= end:
-                            node_to_check.add_feature(
-                                "tag",
-                                tag_to_apply,
-                                Tag(
-                                    original_start,
-                                    content_length + part_length,
-                                    value=part[start:] if value is None else value,
-                                    data=node_data,
-                                    uuid=tag_uuid,
-                                    confidence=confidence,
-                                    index=index,
-                                    parent_group_uuid=parent_group_uuid,
-                                    group_uuid=group_uuid,
-                                    cell_index=cell_index,
-                                    note=note,
-                                    status=status,
-                                    owner_uri=owner_uri,
-                                    is_dirty=is_dirty,
-                                ),
-                            )
-
-                        end = end - part_length
-                        content_length = content_length + part_length
-                        offset = offset + part_length
-                        start = 0 if start - part_length < 0 else start - part_length
-
-                elif isinstance(part, int):
-                    child_node = [
-                        child
-                        for child in node_to_check.get_children()
-                        if child.index == part
-                    ][0]
-
-                    if part_idx > 0:
-                        end = end - len(separator)
-                        content_length = content_length + len(separator)
-                        offset = offset + len(separator)
-                        start = (
-                            0 if start - len(separator) < 0 else start - len(separator)
-                        )
-
-                    result = tag_node_position(
-                        child_node,
-                        start,
-                        end,
-                        node_data,
-                        tag_uuid,
-                        offset=offset,
-                        value=value,
-                        sort_by_bbox=sort_by_bbox,
-                    )
-
-                    if result < 0 or (end - result) <= 0:
-                        return -1
-
-                    offset = offset + result
-                    end = end - result
-                    start = 0 if start - result < 0 else start - result
-
-                    content_length = content_length + result
-                else:
-                    raise Exception("Invalid part?")
-
-            # We need to determine if we have missing children and add them to the end
-            node_children = node_to_check.get_children()
-            if node_children and sort_by_bbox:
-                # Sort nodes by x-coordinate if they have bboxes, otherwise use index
-                try:
-                    node_children.sort(key=lambda x: x.get_bbox()[0] if hasattr(x, 'get_bbox') else x.index if hasattr(x, 'index') else 0)
-                except (AttributeError, TypeError, IndexError):
-                    # If sorting fails, keep original order
-                    pass
-            
-            for child_idx, child_node in enumerate(node_children):
-                if child_node.index not in node_to_check.get_content_parts():
-                    if content_length > 0:
-                        end = end - len(separator)
-                        content_length = content_length + len(separator)
-                        offset = offset + len(separator)
-                        start = (
-                            0 if start - len(separator) < 0 else start - len(separator)
-                        )
-
-                    result = tag_node_position(
-                        child_node,
-                        start,
-                        end,
-                        node_data,
-                        tag_uuid,
-                        offset=offset,
-                        value=value,
-                        sort_by_bbox=sort_by_bbox,
-                    )
-
-                    if result < 0 or (end - result) <= 0:
-                        return -1
-
-                    offset = offset + result
-                    end = end - result
-                    start = 0 if start - result < 0 else start - result
-
-                    content_length = content_length + result
-
-            if len(node_to_check.get_all_content(strip=False)) != content_length:
-                raise Exception(
-                    f"There is a problem in the structure? (2) Length mismatch ({len(node_to_check.get_all_content(strip=False))} != {content_length})"
-                )
-
-            return content_length
-
-        if content_re:
-            pattern = re.compile(
-                content_re.replace(" ", r"\s+")
-                if use_all_content and not node_only
-                else content_re
-            )
-
-        for node in self.select(selector):
-            if fixed_position:
-                tag_node_position(
-                    node,
-                    fixed_position[0],
-                    fixed_position[1],
-                    data,
-                    get_tag_uuid(tag_uuid),
-                    0,
-                    value=value,
-                    sort_by_bbox=sort_by_bbox,
-                )
-
-            else:
-                if not content_re:
-                    node.add_feature(
-                        "tag",
-                        tag_to_apply,
-                        Tag(
-                            data=data,
-                            uuid=get_tag_uuid(tag_uuid),
-                            confidence=confidence,
-                            value=value,
-                            index=index,
-                            parent_group_uuid=parent_group_uuid,
-                            group_uuid=group_uuid,
-                            cell_index=cell_index,
-                            note=note,
-                            status=status,
-                            owner_uri=owner_uri,
-                            is_dirty=is_dirty,
-                        ),
-                    )
-                else:
-                    if not use_all_content:
-                        if node.content:
-                            content = node.content
-                        else:
-                            content = None
-                    else:
-                        content = (
-                            node.get_all_content(separator=separator, strip=False)
-                            if not node_only
-                            else node.get_all_content(separator=separator)
-                        )
-
-                    if content is not None:
-                        if use_match:
-                            matches = pattern.finditer(content)
-
-                            if node_only:
-                                if any(True for _ in matches):
-                                    node.add_feature(
-                                        "tag",
-                                        tag_to_apply,
-                                        Tag(
-                                            data=data,
-                                            uuid=get_tag_uuid(tag_uuid),
-                                            confidence=confidence,
-                                            value=value,
-                                            index=index,
-                                            parent_group_uuid=parent_group_uuid,
-                                            group_uuid=group_uuid,
-                                            cell_index=cell_index,
-                                            note=note,
-                                            status=status,
-                                            owner_uri=owner_uri,
-                                            is_dirty=is_dirty,
-                                        ),
-                                    )
-                            else:
-                                if matches:
-                                    for match in matches:
-                                        start_offset = match.span()[0]
-                                        end_offset = match.span()[1]
-                                        tag_node_position(
-                                            node,
-                                            start_offset,
-                                            end_offset,
-                                            data,
-                                            get_tag_uuid(tag_uuid),
-                                            value=value,
-                                            sort_by_bbox=sort_by_bbox,
-                                        )
-
-                        else:
-                            search_match = pattern.search(content)
-                            if search_match is not None:
-                                start_offset = search_match.span()[0]
-                                end_offset = search_match.span()[1]
-                                tag_node_position(
-                                    node,
-                                    start_offset,
-                                    end_offset,
-                                    data,
-                                    get_tag_uuid(tag_uuid),
-                                    value=value,
-                                    sort_by_bbox=sort_by_bbox,
-                                )
-
-    def get_tags(self):
-        """Returns a list of the names of the tags on the given node
-
-
-        :return: A list of the tag name
-
-        Args:
-
-        Returns:
-
-        >>> document.content_node.select('*').get_tags()
-            ['is_cheese']
-        """
-        return [i.name for i in self.get_features_of_type("tag")]
-
-    def get_tag_features(self):
-        """Returns a list of the features that are tags on the given node
-
-
-        :return: A list of the tag name
-
-        Args:
-
-        Returns:
-
-        >>> document.content_node.select('*').get_tag_features()
-            [ContentFeature()]
-        """
-        return [i for i in self.get_features_of_type("tag")]
-
-    def get_tag_values(self, tag_name, include_children=False):
-        """Get the values for a specific tag name
-
-        Args:
-          tag_name: tag name
-          include_children: include the children of this node (Default value = False)
-
-        Returns:
-          a list of the tag values
-
-        """
-        values = []
-        for tag in self.get_tag(tag_name):
-            values.append(tag["value"])
-
-        if include_children:
-            for child in self.get_children():
-                values.extend(child.get_tag_values(tag_name, include_children))
-
-        return values
-
-    def get_related_tag_values(
-            self,
-            tag_name: str,
-            include_children: bool = False,
-            value_separator: str = " ",
-            tag_uuid=None,
-    ):
-        """Get the values for a specific tag name, grouped by uuid
-
-        Args:
-          tag_name (str): tag name
-          include_children (bool): include the children of this node
-          value_separator (str): the string to be used to join related tag values
-
-        Returns:
-          a list of the tag values
-
-        """
-
-        def group_tag_values(group_dict, feature_val, tag_uuid, tag_node):
-            """
-            This function groups tag values if they share the same uuid. It checks if the uuid of the feature value matches the tag uuid.
-            If they match, it sets the final value to the feature value if it exists, otherwise it sets it to the tag node content.
-            Then, it checks if the uuid is in the value groups keys. If it is, it appends the final value to the group.
-            If it's the first occurrence, it sets the group to the final value.
-
-            Args:
-                group_dict (dict): The dictionary to group the values in.
-                feature_val (dict): The feature value to check.
-                tag_uuid (str): The uuid of the tag.
-                tag_node (Node): The node of the tag.
-
-            Returns:
-                None
-            """
-            # we know the names of all these tags are the same, but we want to group them if they share the same uuid
-
-            if feature_val["uuid"] != tag_uuid:
-                return
-
-            final_value = feature_val["value"] if "value" in feature_val else None
-            if final_value is None:
-                final_value = tag_node.content
-
-            if feature_val["uuid"] in value_groups.keys():
-                # we've seen this UUID - add it's value to the group
-                group_dict[feature_val["uuid"]].append(final_value)
-            else:
-                # first occurrence
-                group_dict[feature_val["uuid"]] = [final_value]
-
-        if include_children:
-            tagged_nodes = self.document.get_tagged_nodes(tag_name, tag_uuid=tag_uuid)
-        else:
-            tagged_nodes = self.select(".")
-
-        value_groups: Dict[str, Any] = {}
-        for tag_node in tagged_nodes:
-            tag_feature_vals = tag_node.get_feature_value("tag", tag_name)
-            if tag_feature_vals:
-                if not isinstance(tag_feature_vals, list):
-                    tag_feature_vals = [tag_feature_vals]
-
-                for v in tag_feature_vals:
-                    group_tag_values(value_groups, v, tag_uuid, tag_node)
-
-        value_strings = []
-        for k in value_groups.keys():
-            if (
-                    value_groups[k]
-                    and len(value_groups[k]) > 0
-                    and value_groups[k][0] is not None
-            ):
-                value_strings.append(value_separator.join(value_groups[k]))
-
-        return value_strings
-
-    def get_related_tag_nodes(
-            self, tag_name: str, everywhere: bool = False, tag_uuid=None
-    ):
-        """Get the nodes for a specific tag name, grouped by uuid
-
-        Args:
-          tag_name (str): tag name
-          everywhere (bool): include the children of this node
-          tag_uuid (optional(str)): if set we will only get nodes related to this tag UUID
-
-        Returns:
-          a dictionary that groups nodes by tag UUID
-
-        """
-        if everywhere:
-            tagged_nodes = self.document.get_tagged_nodes(tag_name, tag_uuid)
-        else:
-            tagged_nodes = [self]
-
-        # We need to group these nodes together based on the TAG UUID
-
-        node_groups = {}
-
-        for tagged_node in tagged_nodes:
-            tag_instances = tagged_node.get_tag(tag_name)
-
-            for tag_instance in tag_instances:
-                if "uuid" in tag_instance:
-                    if tag_instance["uuid"] not in node_groups:
-                        node_groups[tag_instance["uuid"]] = [tagged_node]
-                    else:
-                        node_groups[tag_instance["uuid"]].append(tagged_node)
-
-        return node_groups
-
-    def get_tag(self, tag_name, tag_uuid=None):
-        """Returns the value of a tag (a dictionary), this can be either a single value in a list [[start,end,value]] or if multiple parts of the
-        content of this node match you can end up with a list of lists i.e. [[start1,end1,value1],[start2,end2,value2]]
-
-        Args:
-          tag_name: The name of the tag
-          tag_uuid (Optional): Optionally you can also provide the tag UUID
-
-        Returns:
-          A list tagged location and values for this label in this node
-
-        >>> document.content_node.select_first('//*[contentRegex(".*Cheese.*")]').get_tag('is_cheese')
-            [0,10,'The Cheese Moved']
-        """
-        tag_details = self.get_feature_value("tag", tag_name)
-
-        if tag_details is None:
-            return []
-
-        if not isinstance(tag_details, list):
-            tag_details = [tag_details]
-
-        final_result = []
-        for tag_detail in tag_details:
-            if "uuid" in tag_detail and tag_uuid:
-                if tag_detail["uuid"] == tag_uuid:
-                    final_result.append(tag_detail)
-            else:
-                final_result.append(tag_detail)
-        return final_result
-
-    def get_all_tags(self):
-        """Get the names of all tags that have been applied to this node or to its children.
-
-        Args:
-
-        Returns:
-          list[str]: A list of the tag names belonging to this node and/or its children.
-
-        >>> document.content_node.select_first('//*[contentRegex(".*Cheese.*")]').get_all_tags()
-            ['is_cheese']
-        """
-        tags = []
-        tags.extend(self.get_tags())
-        for child in self.get_children():
-            tags.extend(child.get_all_tags())
-        return list(set(tags))
-
-    def has_tags(self):
-        """Determines if this node has any tags at all.
-
-        Args:
-
-        Returns:
-          bool: True if node has any tags; else, False;
-
-        >>> document.content_node.select_first('//*[contentRegex(".*Cheese.*")]').has_tags()
-            True
-        """
-        return len([i.value for i in self.get_features_of_type("tag")]) > 0
-
-    def has_tag(self, tag, include_children=False):
-        """Determine if this node has a tag with the specified name.
-
-        Args:
-          tag(str): The name of the tag.
-          include_children(bool): should we include child nodes
-
-        Returns:
-          bool: True if node has a tag by the specified name; else, False;
-
-        >>> document.content_node.select_first('//*[contentRegex(".*Cheese.*")]').has_tag('is_cheese')
-            True
-            >>> document.content_node.select_first('//*[contentRegex(".*Cheese.*")]').has_tag('is_fish')
-            False
-        """
-        for feature in self.get_features():
-            if feature.feature_type == "tag" and feature.name == tag:
-                return True
-        result = False
-        if include_children:
-            for child in self.get_children():
-                if child.has_tag(tag, True):
-                    result = True
-        return result
-
-    def is_first_child(self):
-        """Determines if this node is the first child of its parent or has no parent.
-
-        Args:
-
-        Returns:
-          bool: True if this node is the first child of its parent or if this node has no parent; else, False;
-
-        """
-        if not self.parent:
-            return True
-
-        return self.index == 0
-
-    def is_last_child(self):
-        """Determines if this node is the last child of its parent or has no parent.
-
-        Returns:
-          bool: True if this node is the last child of its parent or if this node has no parent; else, False;
-
-        """
-
-        if not self.get_parent():
-            return True
-
-        return self.index == self.get_parent().get_last_child_index()
-
-    def get_last_child_index(self):
-        """Returns the max index value for the children of this node. If the node has no children, returns None.
-
-        Returns:
-          int or None: The max index of the children of this node, or None if there are no children.
-
-        """
-
-        if not self.get_children():
-            return None
-
-        max_index = 0
-        for child in self.get_children():
-            if child.index > max_index:
-                max_index = child.index
-
-        return max_index
-
-    def get_node_at_index(self, index):
-        """Returns the child node at the specified index. If the specified index is outside the first (0), or
-        last child's index, None is returned.
-
-        Note:  documents allow for sparse representation and child nodes may not have consecutive index numbers.
-        If there isn't a child node at the specfied index, a 'virtual' node will be returned.  This 'virtual' node
-        will have the node type of its nearest sibling and will have an index value, but will have no features or content.
-
-        Args:
-          index (int): The index (zero-based) for the child node.
-
-        Returns:
-          ContentNode or None: Node at index, or None if the index is outside the boundaries of child nodes.
-
-        """
-        if self.get_children():
-            if index < self.get_children()[0].index:
-                virtual_node = self.document.create_node(
-                    node_type=self.get_children()[0].node_type,
-                    virtual=True,
-                    parent=self,
-                    index=index,
-                )
-                return virtual_node
-
-            last_child = None
-            for child in self.get_children():
-                if child.index < index:
-                    last_child = child
-                elif child.index == index:
-                    return child
-                else:
-                    break
-
-            if last_child:
-                if last_child.index != index and index < self.get_children()[-1].index:
-                    virtual_node = self.document.create_node(
-                        node_type=last_child.node_type,
-                        virtual=True,
-                        parent=self,
-                        index=index,
-                    )
-                    return virtual_node
-            else:
-                return None
-        else:
-            return None
-
-    def has_next_node(self, node_type_re=".*", skip_virtual=False):
-        """Determine if this node has a next sibling that matches the type specified by the node_type_re regex.
-
-        Args:
-          node_type_re(str, optional, optional): The regular expression to match against the next sibling node's type; default is '.*'.
-          skip_virtual(bool, optional, optional): Skip virtual nodes and return the next real node; default is False.
-
-        Returns:
-          bool: True if there is a next sibling node matching the specified type regex; else, False.
-
-        """
-        return self.next_node(node_type_re, skip_virtual=skip_virtual) is not None
-
-    def has_previous_node(self, node_type_re=".*", skip_virtual=False):
-        """Determine if this node has a previous sibling that matches the type specified by the node_type_re regex.
-
-        Args:
-          node_type_re(str, optional, optional): The regular expression to match against the previous sibling node's type; default is '.*'.
-          skip_virtual(bool, optional, optional): Skip virtual nodes and return the next real node; default is False.
-
-        Returns:
-          bool: True if there is a previous sibling node matching the specified type regex; else, False.
-
-        """
-        return (
-                self.previous_node(node_type_re=node_type_re, skip_virtual=skip_virtual)
-                is not None
-        )
-
-    def next_node(
-            self,
-            node_type_re=".*",
-            skip_virtual=False,
-            has_no_content=True,
-            traverse=Traverse.SIBLING,
-    ):
-        """Returns the next sibling content node.
-
-        Note:  This logic relies on node indexes.  Documents allow for sparse representation and child nodes may not have consecutive index numbers.
-        Therefore, the next node might actually be a virtual node that is created to fill a gap in the document.  You can skip virtual nodes by setting the
-        skip_virtual parameter to False.
-
-        Args:
-          node_type_re(str, optional, optional): The regular expression to match against the next sibling node's type; default is '.*'.
-          skip_virtual(bool, optional, optional): Skip virtual nodes and return the next real node; default is False.
-          has_no_content(bool, optional, optional): Allow a node that has no content to be returned; default is True.
-
-        Returns:
-          ContentNode or None: The next node or None, if no node exists
-
-        """
-        search_index = self.index + 1
-        compiled_node_type_re = re.compile(node_type_re)
-
-        while True:
-            node = (
-                self.get_parent().get_node_at_index(search_index)
-                if self.get_parent()
-                else None
-            )
-
-            if not node:
-                if (
-                        traverse == traverse.ALL or traverse == traverse.PARENT
-                ) and self.get_parent().get_parent():
-                    # noinspection PyBroadException
-                    try:
-                        potential_next_node = (
-                            self.get_parent()
-                            .get_parent()
-                            .get_children()[self.get_parent().index + 1]
-                            .get_children()[0]
-                        )
-                        if potential_next_node:
-                            return potential_next_node
-                    except Exception:
-
-                        # traverse additional layer
-                        potential_next_node = (
-                            self.get_parent()
-                            .get_parent()
-                            .get_parent()
-                            .get_children()[self.get_parent().get_parent().index + 1]
-                            .get_children()[0]
-                            .get_children()[0]
-                        )
-                        if potential_next_node:
-                            return potential_next_node
-                return node
-
-            if compiled_node_type_re.match(node.node_type) and (
-                    not skip_virtual or not node.virtual
-            ):
-                if (not has_no_content and node.content) or has_no_content:
-                    return node
-
-            search_index += 1
-
-    def previous_node(
-            self,
-            node_type_re=".*",
-            skip_virtual=False,
-            has_no_content=False,
-            traverse=Traverse.SIBLING,
-    ):
-        """Returns the previous sibling content node.
-
-        Note:  This logic relies on node indexes.  Documents allow for sparse representation and child nodes may not have consecutive index numbers.
-        Therefore, the previous node might actually be a virtual node that is created to fill a gap in the document.  You can skip virtual nodes by setting the
-        skip_virtual parameter to False.
-
-        Args:
-          node_type_re(str, optional, optional): The regular expression to match against the previous node's type; default is '.*'.
-          skip_virtual(bool, optional, optional): Skip virtual nodes and return the next real node; default is False.
-          has_no_content(bool, optional, optional): Allow a node that has no content to be returned; default is False.
-          traverse(Traverse(enum), optional, optional): The transition you'd like to traverse (SIBLING, CHILDREN, PARENT, or ALL); default is Traverse.SIBLING.
-
-        Returns:
-          ContentNode or None: The previous node or None, if no node exists
-
-        """
-
-        # TODO: implement/differentiate traverse logic for CHILDREN and SIBLING
-        if self.index == 0:
-            if (
-                    traverse == traverse.ALL
-                    or traverse == traverse.PARENT
-                    and self.get_parent()
-            ):
-                # Lets look for a previous node on the parent
-                return self.get_parent().previous_node(
-                    node_type_re, skip_virtual, has_no_content, traverse
-                )
-
-            return None
-
-        search_index = self.index - 1
-        compiled_node_type_re = re.compile(node_type_re)
-
-        while True:
-            node = self.get_parent().get_node_at_index(search_index)
-
-            if not node:
-                return node
-
-            if compiled_node_type_re.match(node.node_type) and (
-                    not skip_virtual or not node.virtual
-            ):
-                if (not has_no_content) or (has_no_content and not node.content):
-                    return node
-
-            search_index -= 1
-
-
-class ContentFeature(object):
-    """
-    A feature allows you to capture almost any additional data or metadata and associate it with a ContentNode.
-    """
-
-    """A feature allows you to capture almost any additional data or metadata and associate it with a ContentNode"""
-
-    def __init__(self, feature_type: str, name: str, value: Any, single: bool = True):
-        self.feature_type: str = feature_type
-        """The type of feature, a logical name to group feature types together (ie. spatial)"""
-        self.name: str = name
-        """The name of the feature (ie. bbox)"""
-        self.value: Any = value
-        """Description of the feature (Optional)"""
-        self.single: bool = single
-        """Determines whether the data for this feature is a single instance or an array, if you have added the same feature to the same node you will end up with multiple data elements in the content feature and the single flag will be false"""
-
-    def __str__(self):
-        return f"Feature [type='{self.feature_type}' name='{self.name}' value='{self.value}' single='{self.single}']"
-
-    def to_dict(self):
-        """
-        Create a dictionary representing this ContentFeature's structure and content.
-
-        Returns:
-            dict: The properties of this ContentFeature structured as a dictionary.
-        """
-        return {
-            "name": self.feature_type + ":" + self.name,
-            "value": self.value,
-            "single": self.single,
-        }
-
-    def get_value(self):
-        """
-        Get the value from the feature. This method will handle the single flag.
-
-        Returns:
-            Any: The value of the feature.
-        """
-        if self.single:
-            return self.value[0]
-
-        return self.value
-
-
-class ModelInsight(BaseModel):
-    model_config = ConfigDict(populate_by_name=True, use_enum_values=True, arbitrary_types_allowed=True,
-                              protected_namespaces=("model_config",))
-    """
-    A class used to represent the insights of a model.
-
-    Attributes:
-        model_ref (str): The reference to the model.
-        insight_type (str): The type of the insight.
-        description (Optional[str]): The description of the insight, default is None.
-        details (Optional[str]): The details of the insight, default is None.
-        properties (Optional[Dict]): The properties of the insight, default is None.
-    """
-
-    model_ref: str
-    insight_type: str
-    description: Optional[str] = None
-    details: Optional[str] = None
-    properties: Optional[Dict] = None
-
-
-@dataclasses.dataclass()
-class SourceMetadata:
-    """Class for keeping track of an original source information for a document.
-
-    Attributes:
-        original_filename (Optional[str]): The original filename of the document.
-        original_path (Optional[str]): The original path of the document.
-        checksum (Optional[str]): The checksum of the document.
-        cid (Optional[str]): The ID used for internal caching.
-        last_modified (Optional[str]): The last modified date of the document.
-        created (Optional[str]): The creation date of the document.
-        connector (Optional[str]): The connector used for the document.
-        mime_type (Optional[str]): The MIME type of the document.
-        headers (Optional[Dict]): The headers of the document.
-        lineage_document_uuid (Optional[str]): The UUID of the document that this document was derived from.
-        source_document_uuid (Optional[str]): The UUID of the original first document.
-        pdf_document_uuid (Optional[str]): The UUID of the document in a PDF form (used for archiving and preview).
-    """
-
-    """Class for keeping track of the original source information for a
-    document
-
-    Args:
-
-    Returns:
-
-    """
-    original_filename: Optional[str] = None
-    original_path: Optional[str] = None
-    checksum: Optional[str] = None
-
-    # The ID used for internal caching
-    cid: Optional[str] = None
-    last_modified: Optional[str] = None
-    created: Optional[str] = None
-    connector: Optional[str] = None
-    mime_type: Optional[str] = None
-    headers: Optional[Dict] = None
-
-    # The UUID of the document that this document was derived from
-    # noting that multiple documents coming from an original source
-    lineage_document_uuid: Optional[str] = None
-
-    # The UUID of the original first document
-    source_document_uuid: Optional[str] = None
-
-    # The UUID of the document in a PDF form (used for archiving and preview)
-    pdf_document_uuid: Optional[str] = None
-
-    @classmethod
-    def from_dict(cls, env):
-        """Creates an instance of the class from a dictionary.
-
-        Args:
-            env (dict): A dictionary containing the attributes of the class.
-
-        Returns:
-            SourceMetadata: An instance of the class.
-        """
-        return cls(
-            **{k: v for k, v in env.items() if k in inspect.signature(cls).parameters}
-        )
-
-
-class FeatureSetDiff:
-    """
-    A utility class that can be used to diff two feature sets.
-    """
-
-    """
-    A utility class that can be used to diff two feature sets
-    """
-
-    def __init__(self, first_feature_set: FeatureSet, second_feature_set: FeatureSet):
-        self.first_feature_map = self.parse_feature_set(first_feature_set)
-        self.second_feature_map = self.parse_feature_set(second_feature_set)
-        self._differences = deepdiff.DeepDiff(
-            self.first_feature_map,
-            self.second_feature_map,
-            exclude_obj_callback=self.exclude_callback,
-        ).to_dict()
-
-    def get_differences(self):
-        """
-        Gets the differences between the two feature sets.
-
-        Returns:
-            dict: A dictionary containing the differences between the two feature sets.
-        """
-        if "type_changes" in self._differences:
-            self._differences.pop("type_changes")
-
-        return self._differences
-
-    def get_exclude_paths(self):
-        """
-        Gets the paths to exclude.
-
-        Returns:
-            list: A list of paths to exclude.
-        """
-        return ["shape", "group_uuid", "uuid", "parent_group_uuid", "single"]
-
-    def exclude_callback(self, path, key):
-        """
-        Checks if the key is to be excluded from the diff.
-
-        Args:
-            path (str): The path that contains the values of the key.
-            key (str): The key of the data dictionary to compare.
-
-        Returns:
-            bool: True if the key is to be excluded, False otherwise.
-        """
-        if any(re.search(exclude_key, key) for exclude_key in self.get_exclude_paths()):
-            return True
-        else:
-            return False
-
-    def parse_feature_set(self, feature_set: FeatureSet):
-        """
-        Parses the feature set.
-
-        Args:
-            feature_set (FeatureSet): The feature set to be parsed.
-
-        Returns:
-            dict: A dictionary of features with the key as the nodeUuid.
-        """
-        return {
-            feature.get("nodeUuid"): feature for feature in feature_set.node_features
-        }
-
-    def parsed_values_changed(self):
-        """
-        Checks if the old value is still in the second feature map. If it is, remove the key.
-        """
-        for key, value in self._differences.get("values_changed").items():
-            # Check if the old_value is stil in the second_feature_map. If it is remove the key
-            if key in self.second_feature_map.node_features:
-                self._differences.get("values_changed").remove(key)
-
-    def is_equal(self) -> bool:
-        """
-        Checks if the two feature sets are equal to each other.
-
-        Returns:
-            bool: True if the feature sets are equal, False otherwise.
-        """
-        return self._differences == {}
-
-    def get_changed_nodes(self):
-        """
-        Gets the nodes that were changed.
-
-        Returns:
-            dict: A dictionary containing the nodes that were changed.
-        """
-        if self.is_equal():
-            return []
-
-        # Check for new nodes added in the second_feature_map
-        new_added_nodes = []
-
-        # Checked for removed nodes in the first_feature_map
-        removed_nodes = []
-
-        # Checked for modified nodes
-        modified_nodes = []
-        for key, value in self._differences.get("values_changed").items():
-            modified_nodes.append(self.parsed_node_uuid(key))
-
-        # Merge unique nodeUuid of first_feature_map and second_feature_map
-        merged_node_uuids = set(self.first_feature_map.keys()).union(
-            set(self.second_feature_map.keys())
-        )
-        for node_uuid in merged_node_uuids:
-            if node_uuid not in self.first_feature_map:
-                new_added_nodes.append(node_uuid)
-            elif node_uuid not in self.second_feature_map:
-                removed_nodes.append(node_uuid)
-
-        return {
-            "new_added_nodes": new_added_nodes,
-            "removed_nodes": removed_nodes,
-            "existing_modified_nodes": modified_nodes,
-        }
-
-    def get_difference_count(self):
-        """
-        Gets the total number of differences between the feature sets.
-
-        Returns:
-            int: The total number of differences between the feature sets.
-        """
-        return len(self._differences().keys())
-
-    def parsed_item_added(self):
-        """
-        Parses the items that were added.
-
-        Returns:
-            dict: A dictionary containing the items that were added.
-        """
-        item_added: Dict = self._differences.get("iterable_item_added")
-        if item_added:
-            return {}
-
-        for key, value in item_added.items():
-            node = self.parsed_node_uuid(key)
-            if node in self._changed_nodes["new_added_nodes"]:
-                self._differences["iterable_item_added"][key][
-                    "details"
-                ] = f"Node: {node} was added"
-                continue
-
-            # if node in
-        return self.get_difference_count()
-
-    def parsed_node_uuid(self, key):
-        """
-        Parses the node uuid from the key.
-
-        Args:
-            key (str): The key of the data dictionary.
-
-        Returns:
-            str: The node uuid from the key.
-        """
-        node = key.split("['")[1].split("']")[0]
-        return node
-
-
-class ProcessingStep(BaseModel):
-    id: str = Field(default_factory=lambda: str(uuid.uuid4()))
-    name: str
-    metadata: dict = Field(default_factory=lambda: {})
-    presentation_metadata: dict = Field(default_factory=lambda: {}, alias='presentationMetadata')
-    children: List['ProcessingStep'] = Field(default_factory=list)
-    parents: List['ProcessingStep'] = Field(default_factory=list)
-
-    def add_child(self, child_step: 'ProcessingStep'):
-        self.children.append(child_step)
-        child_step.parents.append(self)
-
-    @staticmethod
-    def merge_with(*other_steps: 'ProcessingStep') -> 'ProcessingStep':
-        merged_step = ProcessingStep(name=f"Merged({', '.join(step.name for step in other_steps)})")
-        for step in other_steps:
-            step.children.append(merged_step)
-            merged_step.parents.append(step)
-        return merged_step
-
-    class Config:
-        arbitrary_types_allowed = True
-        json_encoders = {
-            'ProcessingStep': lambda step: step.to_dict()
-        }
-
-    def to_dict(self, seen=None):
-        if seen is None:
-            seen = set()
-
-        # Avoid circular references by skipping already seen objects
-        if self.id in seen:
-            return {'id': self.id, 'name': self.name}
-
-        seen.add(self.id)
-
-        return {
-            'id': self.id,
-            'name': self.name,
-            'metadata': self.metadata,
-            'presentationMetadata': self.presentation_metadata,
-            'children': [child.to_dict(seen) for child in self.children],
-            'parents': [{'id': parent.id, 'name': parent.name} for parent in self.parents],  # or parent.to_dict(seen) if full structure is needed
-        }
-
-    def to_json(self):
-        return json.dumps(self.to_dict())
-
-    def __repr__(self):
-        return f"Step(id={self.id}, name={self.name})"
-
-
-class Document(object):
-    """A Document is a collection of metadata and a set of content nodes."""
-
-    PREVIOUS_VERSION: str = "1.0.0"
-    CURRENT_VERSION: str = "6.0.0"
-
-    def __str__(self):
-        return f"kodexa://{self.uuid}"
-
-    def get_validations(self) -> list[DocumentTaxonValidation]:
-        return self.get_persistence().get_validations()
-
-    def set_validations(self, validations: list[DocumentTaxonValidation]):
-        self.get_persistence().set_validations(validations)
-
-    def add_exception(self, exception: ContentException):
-        self._persistence_layer.add_exception(exception)
-
-    def get_exceptions(self) -> List[ContentException]:
-        return self._persistence_layer.get_exceptions()
-
-    def get_external_data(self, key="default") -> dict:
-        return self._persistence_layer.get_external_data(key)
-
-    def get_external_data_keys(self) -> list[str]:
-        return self._persistence_layer.get_external_data_keys()
-
-    def set_external_data(self, external_data:dict, key="default"):
-        return self._persistence_layer.set_external_data(external_data, key)
-
-    def get_steps(self) -> list[ProcessingStep]:
-        return self._persistence_layer.get_steps()
-
-    def set_steps(self, steps: list[ProcessingStep]):
-        self._persistence_layer.set_steps(steps)
-
-    def replace_exceptions(self, exceptions: List[ContentException]):
-        self._persistence_layer.replace_exceptions(exceptions)
-
-    def __init__(
-            self,
-            metadata=None,
-            content_node: ContentNode = None,
-            source=None,
-            ref: str = None,
-            kddb_path: str = None,
-            delete_on_close=False,
-            inmemory=False,
-    ):
-        if metadata is None:
-            metadata = DocumentMetadata()
-        if source is None:
-            source = SourceMetadata()
-
-        # Mix-ins are going away - so we will allow people to turn them off as needed
-        self.disable_mixin_methods = True
-
-        self.delete_on_close = delete_on_close
-
-        # The ref is not stored and is used when we have
-        # initialized a document from a remote store and want
-        # to keep track of that
-        self.ref = ref
-
-        self.metadata: DocumentMetadata = metadata
-        """Metadata relating to the document"""
-        self._content_node: Optional[ContentNode] = content_node
-        """The root content node"""
-        self.virtual: bool = False
-        """Is the document virtual (deprecated)"""
-        self._mixins: List[str] = []
-        """A list of the mixins for this document"""
-        self.uuid: str = str(uuid.uuid4())
-        """A log for this document (deprecated)"""
-        self.version = Document.CURRENT_VERSION
-        """The version of the document"""
-        self.source: SourceMetadata = source
-        """Source metadata for this document"""
-        self.labels: List[str] = []
-        """A list of the document level labels for the document"""
-        self.tag_instances: List[TagInstance] = []
-        """A list of tag instances that contains a set of tag that has a set of nodes"""
-
-        # Start persistence layer
-        from kodexa.model import PersistenceManager
-
-        self._persistence_layer: Optional[PersistenceManager] = PersistenceManager(
-            document=self, filename=kddb_path, delete_on_close=delete_on_close, inmemory=inmemory
-        )
-        self._persistence_layer.initialize()
-
-    def remove_tags_by_owner(self, owner_uri: str):
-
-        for tag in self.get_all_tags():
-            for tag_instance in self.get_tag_instances(tag):
-                tag_meta: dict = tag_instance.get_data()
-                if 'owner_uri' in tag_meta and tag_meta['owner_uri'] == owner_uri:
-                    for node in tag_instance.nodes:
-                        node.remove_tag(tag)
-
-    def get_nodes_by_type(self, node_type: str) -> List[ContentNode]:
-        """
-        Get all the nodes of a specific type
-
-        Args:
-          node_type: the type of the node
-
-        Returns:
-          a list of nodes
-
-        """
-        return self._persistence_layer.get_nodes_by_type(node_type)
-
-    def get_node_by_uuid(self, uuid: int) -> ContentNode:
-        """
-        Get a node by its uuid
-
-        Args:
-          uuid: the uuid of the node
-
-        Returns:
-          the node
-
-        """
-        return self._persistence_layer.get_node_by_uuid(uuid)
-
-    def add_tag_instance(self, tag_to_apply: str, node_list: List[ContentNode]):
-        """
-            This will create a group of a tag with indexes
-        :param tag_to_apply: name of the tag
-        :param node_list: contains the list of index of a node
-        :return:
-        """
-        # For each node in the list create/update a feature
-        tag = Tag()
-        for node in node_list:
-            node.add_feature("tag", tag_to_apply, Tag)
-        # Tag Object
-        tag_instance = TagInstance(tag, node_list)
-        self.tag_instances.append(tag_instance)
-
-    def update_tag_instance(self, tag_uuid):
-        for tag_instance in self.tag_instances:
-            if tag_instance.tag.uuid == tag_uuid:
-                # Update attributes of a Tag
-                for node in tag_instance.nodes:
-                    node.get_tag(tag_instance.tag.value, tag_uuid=tag_instance.tag.uuid)
-
-    def get_tag_instance(self, tag):
-        """
-            Get the tag instance based on the tag itself
-        :param tag: name of the tag
-        :return: a list of tag instance
-        """
-        return [
-            tag_instance
-            for tag_instance in self.tag_instances
-            if tag_instance.tag == tag
-        ]
-
-    def get_persistence(self):
-        return self._persistence_layer
-
-    def get_all_tags(self):
-        return self._persistence_layer.get_all_tags()
-
-    def add_model_insight(self, model_insight: ModelInsight):
-        self._persistence_layer.add_model_insight(model_insight)
-
-    def clear_model_insights(self):
-        self._persistence_layer.clear_model_insights()
-
-    def get_model_insights(self) -> List[ModelInsight]:
-        return self._persistence_layer.get_model_insights()
-
-    def get_tagged_nodes(self, tag_name, tag_uuid=None):
-        return self._persistence_layer.get_tagged_nodes(tag_name, tag_uuid)
-
-    @property
-    def content_node(self):
-        """The root content Node"""
-        return self._content_node
-
-    @content_node.setter
-    def content_node(self, value):
-        value.index = 0
-        if value != self._content_node and self._content_node is not None:
-            self.get_persistence().remove_content_node(self._content_node)
-
-        self._content_node = value
-        if value is not None:
-            self.get_persistence().add_content_node(self._content_node, None)
-
-    def get_tag_instances(self, tag):
-        groups = self.content_node.get_related_tag_nodes(tag, everywhere=True)
-        tag_instances = []
-
-        class TagInstance:
-            """
-            A class to represent a TagInstance.
-
-            ...
-
-            Attributes
-            ----------
-            tag_uuid : str
-                a string that represents the unique identifier of the tag
-            nodes : list
-                a list of nodes associated with the tag
-
-            Methods
-            -------
-            get_value():
-                Returns the combined content of all nodes.
-            get_data():
-                Returns the data of the tag feature with the same uuid as the tag.
-            """
-
-            def __init__(self, tag_uuid, nodes):
-                self.tag_uuid = tag_uuid
-                self.nodes = nodes
-
-            def get_value(self):
-                """
-                Combines and returns the content of all nodes.
-
-                Returns
-                -------
-                str
-                    a string that represents the combined content of all nodes
-                """
-                content_parts = []
-                for node in self.nodes:
-                    content_parts.append(node.get_all_content())
-                return " ".join(content_parts)
-
-            def get_data(self):
-                """
-                Returns the data of the tag feature with the same uuid as the tag.
-
-                Returns
-                -------
-                dict
-                    a dictionary that represents the data of the tag feature with the same uuid as the tag
-                """
-                for node in self.nodes:
-                    for tag_feature in node.get_tag_features():
-                        data = tag_feature.value[0]
-                        if "uuid" in data and data["uuid"] == self.tag_uuid:
-                            return data
-                return {}
-
-        for key in groups.keys():
-            tag_instances.append(TagInstance(key, groups[key]))
-        return tag_instances
-
-    def add_label(self, label: str):
-        """Add a label to the document
-
-        Args:
-          label: str Label to add
-          label: str:
-
-        Returns:
-          the document
-
-        """
-        if label not in self.labels:
-            self.labels.append(label)
-
-        return self
-
-    def remove_label(self, label: str):
-        """Remove a label from the document
-
-        Args:
-          label: str Label to remove
-          label: str:
-
-        Returns:
-          the document
-
-        """
-        self.labels.remove(label)
-        return self
-
-    @classmethod
-    def from_text(cls, text, separator=None, inmemory=False):
-        """Creates a new Document from the text provided.
-
-        Args:
-          text: str  Text to be used as content on the Document's ContentNode(s)
-          separator: str   If provided, this string will be used to split the text and the resulting text will be placed on children of the root ContentNode. (Default value = None)
-
-        Returns:
-          the document
-
-        """
-        new_document = Document(inmemory=inmemory)
-        new_document.source.original_filename = f"text-{uuid.uuid4()}"
-        new_document.content_node = new_document.create_node(node_type="text", index=0)
-        if text:
-            if separator:
-                for s in text.split(separator):
-                    new_document.content_node.add_child(
-                        new_document.create_node(node_type="text", content=s)
-                    )
-            else:
-                new_document.content_node.content = text
-
-        new_document.add_mixin("text")
-        return new_document
-
-    def get_root(self):
-        """Get the root content node for the document (same as content_node)"""
-        return self.content_node
-
-    def to_kdxa(self, file_path: str):
-        """Write the document to the kdxa format (msgpack) which can be
-        used with the Kodexa platform
-
-        Args:
-          file_path: the path to the mdoc you wish to create
-          file_path: str:
-
-        Returns:
-
-        >>> document.to_mdoc('my-document.kdxa')
-        """
-        with open(file_path, "wb") as outfile:
-            msgpack.pack(self.to_dict(), outfile, use_bin_type=True)
-
-    @staticmethod
-    def open_kddb(file_path):
-        """
-        Opens a Kodexa Document Database.
-
-        This is the Kodexa V4 default way to store documents, it provides high-performance
-        and also the ability to handle very large document objects
-
-        :param file_path: The file path
-        :return: The Document instance
-        """
-        return Document(kddb_path=file_path)
-
-    def close(self):
-        """
-        Close the document and clean up the resources
-        """
-        self.get_persistence().close()
-
-    def to_kddb(self, path=None):
-        """
-        Either write this document to a KDDB file or convert this document object structure into a KDDB and return a bytes-like object
-
-        This is dependent on whether you provide a path to write to
-        """
-
-        if path is None:
-            return self.get_persistence().get_bytes()
-
-        with open(path, "wb") as output_file:
-            output_file.write(self.get_persistence().get_bytes())
-
-    @staticmethod
-    def from_kdxa(file_path):
-        """Read an .kdxa file from the given file_path and
-
-        Args:
-          file_path: the path to the mdoc file
-
-        Returns:
-
-        >>> document = Document.from_kdxa('my-document.kdxa')
-        """
-        with open(file_path, "rb") as data_file:
-            data_loaded = msgpack.unpack(data_file, raw=False)
-        return Document.from_dict(data_loaded)
-
-    def to_msgpack(self):
-        """Convert this document object structure into a message pack"""
-        return msgpack.packb(self.to_dict(), use_bin_type=True)
-
-    def to_json(self):
-        """Create a JSON string representation of this Document.
-
-        Args:
-
-        Returns:
-          str: The JSON formatted string representation of this Document.
-
-        >>> document.to_json()
-        """
-        return json.dumps(self.to_dict(), ensure_ascii=False)
-
-    def to_dict(self):
-        """Create a dictionary representing this Document's structure and content.
-
-        Args:
-
-        Returns:
-          dict: A dictionary representation of this Document.
-
-        >>> document.to_dict()
-        """
-
-        # We don't want to store the none values
-        def clean_none_values(d):
-            """
-            This function recursively cleans a dictionary by removing keys with None values.
-
-            Args:
-                d (dict): The dictionary to clean.
-
-            Returns:
-                dict: A new dictionary with the same structure as the input, but without keys that had None values.
-            """
-            clean = {}
-            for k, v in d.items():
-                if isinstance(v, dict):
-                    nested = clean_none_values(v)
-                    if len(nested.keys()) > 0:
-                        clean[k] = nested
-                elif v is not None:
-                    clean[k] = v
-            return clean
-
-        return {
-            "version": Document.CURRENT_VERSION,
-            "metadata": self.metadata,
-            "content_node": self.content_node.to_dict() if self.content_node else None,
-            "source": clean_none_values(dataclasses.asdict(self.source)),
-            "mixins": self._mixins,
-            "labels": self.labels,
-            "uuid": self.uuid,
-        }
-
-    @staticmethod
-    def from_dict(doc_dict):
-        """Build a new Document from a dictionary.
-
-        Args:
-          dict: doc_dict: A dictionary representation of a Kodexa Document.
-          doc_dict:
-
-        Returns:
-          Document: A complete Kodexa Document
-
-        >>> Document.from_dict(doc_dict)
-        """
-        new_document = Document(DocumentMetadata(doc_dict["metadata"]))
-        new_document.version = (
-            doc_dict["version"]
-            if "version" in doc_dict and doc_dict["version"]
-            else Document.PREVIOUS_VERSION
-        )  # some older docs don't have a version or it's None
-        new_document.uuid = (
-            doc_dict["uuid"]
-            if "uuid" in doc_dict
-            else str(uuid.uuid5(uuid.NAMESPACE_DNS, "kodexa.com"))
-        )
-
-        if "content_node" in doc_dict and doc_dict["content_node"]:
-            new_document.content_node = ContentNode.from_dict(
-                new_document, doc_dict["content_node"]
-            )
-
-        if "source" in doc_dict and doc_dict["source"]:
-            new_document.source = SourceMetadata.from_dict(doc_dict["source"])
-        if "labels" in doc_dict and doc_dict["labels"]:
-            new_document.labels = doc_dict["labels"]
-
-        new_document.get_persistence().update_metadata()
-        return new_document
-
-    @staticmethod
-    def from_json(json_string):
-        """Create an instance of a Document from a JSON string.
-
-        Args:
-          str: json_string: A JSON string representation of a Kodexa Document
-          json_string:
-
-        Returns:
-          Document: A complete Kodexa Document
-
-        >>> Document.from_json(json_string)
-        """
-        return Document.from_dict(json.loads(json_string))
-
-    @staticmethod
-    def from_msgpack(msgpack_bytes):
-        """Create an instance of a Document from a message pack byte array.
-
-        Args:
-          msgpack_bytes: bytes: A message pack byte array.
-
-        Returns:
-          Document: A complete Kodexa Document
-
-        >>> Document.from_msgpack(open(os.path.join('news-doc.kdxa'), 'rb').read())
-        """
-        return Document.from_dict(msgpack.unpackb(msgpack_bytes, raw=False))
-
-    def get_mixins(self):
-        """
-        Get the list of mixins that have been enabled on this document
-
-        Returns:
-            mixins: list[str] a list of the mixin names
-        """
-        return self._mixins
-
-    def add_mixin(self, mixin):
-        """
-        Add the given mixin to this document,  this will apply the mixin to all the content nodes,
-        and also register it with the document so that future invocations of create_node will ensure
-        the node has the mixin appled.
-
-        Args:
-          mixin:str the name of the mixin to add
-
-        Returns:
-        >>> import * from kodexa
-        >>> document = Document()
-        >>> document.add_mixin('spatial')
-        """
-        self._mixins.append(mixin)
-        self.get_persistence().update_metadata()
-
-    def create_node(
-            self,
-            node_type: str,
-            content: Optional[str] = None,
-            virtual: bool = False,
-            parent: ContentNode = None,
-            index: Optional[int] = None,
-    ):
-        """
-        Creates a new node for the document.  The new node is not added to the document, but any mixins that have been
-        applied to the document will also be available on the new node.
-
-        Args:
-          node_type (str): The type of node.
-          content (str): The content for the node; defaults to None.
-          virtual (bool): Indicates if this is a 'real' or 'virtual' node; default is False.  'Real' nodes contain
-                          document content. 'Virtual' nodes are synthesized as necessary to fill gaps in between
-                          non-consecutively indexed siblings.  Such indexing arises when document content is sparse.
-          parent (ContentNode): The parent for this newly created node; default is None;
-          index (Optional[int)): The index property to be set on this node; default is 0;
-
-        Returns:
-          ContentNode: This newly created node.
-
-        >>> document.create_node(node_type='page')
-            <kodexa.model.model.ContentNode object at 0x7f80605e53c8>
-        """
-        content_node = ContentNode(
-            document=self,
-            node_type=node_type,
-            content=content,
-            parent=parent,
-            index=index,
-            virtual=virtual,
-        )
-        if parent is not None:
-            parent.add_child(content_node, index)
-        else:
-            self.get_persistence().add_content_node(content_node, None)
-
-        if content is not None and len(content_node.get_content_parts()) == 0:
-            content_node.set_content_parts([content])
-
-        return content_node
-
-    @classmethod
-    def from_kddb(cls, source, detached: bool = True, inmemory: bool = False):
-        """
-        Loads a document from a Kodexa Document Database (KDDB) file
-
-        Args:
-
-            input: if a string we will load the file at that path, if bytes we will create a temp file and
-                    load the KDDB to it
-            detached (bool): if reading from a file we will create a copy so we don't update in place
-            inmemory (bool): if true we will load the KDDB into memory
-
-        :return: the document
-        """
-        if isinstance(source, str):
-            if isinstance(source, str):
-                # If we are using the detached flag we will create a copy of the KDDB file
-                if detached:
-                    import tempfile
-                    from kodexa import KodexaPlatform
-
-                    fp = tempfile.NamedTemporaryFile(
-                        suffix=".kddb", delete=False, dir=KodexaPlatform.get_tempdir()
-                    )
-                    fp.write(open(source, "rb").read())
-                    fp.close()
-                    return Document(kddb_path=fp.name, delete_on_close=True, inmemory=inmemory)
-
-                return Document(kddb_path=source, inmemory=inmemory)
-
-        # We will assume the input is of byte type
-        import tempfile
-        from kodexa import KodexaPlatform
-
-        fp = tempfile.NamedTemporaryFile(
-            suffix=".kddb", delete=False, dir=KodexaPlatform.get_tempdir()
-        )
-        fp.write(source)
-        fp.close()
-        return Document(kddb_path=fp.name, delete_on_close=True, inmemory=inmemory)
-
-    @classmethod
-    def from_file(cls, file, unpack: bool = False):
-        """Creates a Document that has a 'file-handle' connector to the specified file.
-
-        Args:
-          file: file: The file to which the new Document is connected.
-          unpack: bool:  (Default value = False)
-
-        Returns:
-          Document: A Document connected to the specified file.
-
-        """
-        if unpack:
-            Document.from_kdxa(file)
-        else:
-            file_document = Document()
-            file_document.metadata["connector"] = "file-handle"
-            file_document.metadata["connector_options"] = {};
-            file_document.metadata["connector_options"]["file"] = file
-            file_document.source
-            file_document.source.connector = "file-handle"
-            file_document.source.original_filename = os.path.basename(file)
-            file_document.source.original_path = file
-            return file_document
-
-    @classmethod
-    def from_url(cls, url, headers=None):
-        """Creates a Document that has a 'url' connector for the specified url.
-
-        Args:
-          str: url: The URL to which the new Document is connected.
-          dict: headers: Headers that should be used when reading from the URL
-          url:
-          headers:  (Default value = None)
-
-        Returns:
-          Document: A Document connected to the specified URL with the specified headers (if any).
-
-        """
-        if headers is None:
-            headers = {}
-        url_document = Document()
-        url_document.metadata.connector = "url"
-        url_document.metadata.connector_options.base_url = url
-        url_document.metadata.connector_options.headers = headers
-        url_document.source.connector = "url"
-        url_document.source.original_filename = url
-        url_document.source.original_path = url
-        url_document.source.headers = headers
-        return url_document
-
-    def select_first(self, selector, variables=None) -> Optional[ContentNode]:
-        """Select and return the first child of this node that match the selector value.
-
-        Args:
-          selector (str): The selector (ie. //*)
-          variables (dict, optional): A dictionary of variable name/value to use in substituion; defaults to None.
-          Dictionary keys should match a variable specified in the selector.
-
-        Returns:
-          Optional[ContentNode]: The first matching node or none
-
-        >>> document.get_root().select_first('.')
-           ContentNode
-
-        >>> document.get_root().select_first('//*[hasTag($tagName)]', {"tagName": "div"})
-           ContentNode
-        """
-        result = self.select(selector, variables, first_only=True)
-        return result[0] if len(result) > 0 else None
-
-    def select(
-            self, selector: str, variables: Optional[dict] = None, first_only=False
-    ) -> List[ContentNode]:
-        """Execute a selector on the root node and then return a list of the matching nodes.
-
-        Args:
-          selector (str): The selector (ie. //*)
-          variables (Optional[dict): A dictionary of variable name/value to use in substituion; defaults to an empty
-          first_only (bool): If True, only the first matching node is returned; defaults to False.
-          dictionary.  Dictionary keys should match a variable specified in the selector.
-
-        Returns:
-          list[ContentNodes]: A list of the matching ContentNodes.  If no matches found, list is empty.
-
-        >>> document.select('.')
-           [ContentNode]
-        """
-        if variables is None:
-            variables = {}
-        if self.content_node:
-            result = self.content_node.select(selector, variables, first_only)
-            if isinstance(result, list):
-                return result
-
-            return [self.content_node] if bool(result) else []
-        return []
-
-    def get_labels(self) -> List[str]:
-        """
-
-        Args:
-
-        Returns:
-          List[str]: list of associated labels
-
-        """
-        return self.labels
-
-    def get_feature_set(self, owner_uri: Optional[str] = None) -> FeatureSet:
-        """ """
-        feature_set = FeatureSet()
-        feature_set.node_features = []
-        for tagged_node in self.get_all_tagged_nodes():
-            node_feature = {"nodeUuid": str(tagged_node.uuid), "features": []}
-
-            feature_set.node_features.append(node_feature)
-
-            # TODO this needs to be cleaned up, also should it only really
-            # be the tag features?
-            for feature in tagged_node.get_features():
-                if feature.feature_type == "tag":
-                    if owner_uri is not None:
-                        if (
-                                "owner_uri" in feature.value[0]
-                                and feature.value[0]["owner_uri"] != owner_uri
-                        ):
-                            continue
-
-                    feature_dict = feature.to_dict()
-                    feature_dict["featureType"] = feature.feature_type
-                    feature_dict["name"] = feature.name
-
-                    if isinstance(feature_dict['value'][0], Tag):
-                        feature_dict['value'] = [feature_dict['value'][0].to_dict()]
-
-                    node_feature["features"].append(feature_dict)
-
-        return feature_set
-
-    def get_all_tagged_nodes(self) -> List[ContentNode]:
-        """
-        Get all the tagged nodes in the document
-
-        :return:
-        """
-        return self._persistence_layer.get_all_tagged_nodes()
-
-
-class TagInstance:
-    """
-    A class to represent a TagInstance.
-
-    Attributes
-    ----------
-    tag : Tag
-        an instance of Tag class
-    nodes : list
-        a list of nodes
-
-    Methods
-    -------
-    add_node(nodes: List[ContentNode])
-        Extend the list of nodes with new nodes.
-    """
-
-    def __init__(self, tag: Tag, nodes):
-        self.tag = tag
-        self.nodes = nodes
-
-    def add_node(self, nodes: List[ContentNode]):
-        """
-        Extend the list of nodes with new nodes.
-
-        Parameters
-        ----------
-            nodes : List[ContentNode]
-                a list of new nodes to be added
-        """
-        self.nodes.extend(nodes)
-
-
-class ContentObjectReference:
-    """A reference to a content object within a document.
-
-    This class provides a way to reference a specific content object within a document,
-    and includes information about the document's family and the store where the document is located.
-
-    Attributes:
-        content_object (ContentObject): The content object being referenced.
-        store: The store where the document is located.
-        document (Document): The document in which the content object is located.
-        document_family: The family to which the document belongs.
-    """
-
-    """ """
-
-    def __init__(
-            self, content_object: ContentObject, store, document: Document, document_family
-    ):
-        self.content_object = content_object
-        self.store = store
-        self.document = document
-        self.document_family = document_family