🔍 Code Extractor

A class representing a controlled document in a document management system, providing access to document metadata stored in a Neo4j database.

Purpose

ControlledDocument serves as a data access object (DAO) for controlled documents in a document management system. It can be instantiated either with a UID to load document data from a Neo4j database, or with pre-existing data. The class provides convenient property accessors for document attributes like UID and current version UID, handling case variations in the underlying data structure. This class is part of a larger document control system (CDocs) that manages versioned documents with audit trails.

Source Code

class ControlledDocument:
    def __init__(self, uid=None, data=None):
        # Initialize from either uid or data
        self._data = data or {}
        
        if uid and not data:
            # Load from database by UID
            self._data = get_node_by_uid(uid) or {}
    
    @property
    def uid(self):
        """Get the UID of the document, handling both case variations"""
        return self._data.get('UID') or self._data.get('uid')
        
    @property
    def current_version_uid(self):
        """Get the current version UID, handling both case variations"""
        return self._data.get('currentVersionUID') or self._data.get('currentversionuid')

Parameters

Parameter Details

uid: Optional string identifier for the document. When provided without data parameter, triggers a database lookup using get_node_by_uid() to load the document's data from Neo4j. Should be a valid document UID that exists in the database.

data: Optional dictionary containing pre-loaded document data. When provided, bypasses database lookup and directly initializes the instance with this data. Expected to contain keys like 'UID'/'uid' and 'currentVersionUID'/'currentversionuid'. If both uid and data are provided, data takes precedence.

Return Value

Instantiation returns a ControlledDocument object. The uid property returns a string representing the document's unique identifier (or None if not present). The current_version_uid property returns a string representing the UID of the current version of the document (or None if not present).

Class Interface

Methods

Attributes

Dependencies

• neo4j
• logging
• uuid
• typing
• datetime
• traceback

Required Imports

from CDocs.db import get_node_by_uid
from CDocs.db import get_driver
from CDocs.db.schema_manager import NodeLabels
from CDocs.db.schema_manager import RelTypes
from CDocs.db.schema_manager import migrate_audit_events
from neo4j import Driver
from neo4j import Session
from neo4j import Transaction
from neo4j import Record
from neo4j.exceptions import ServiceUnavailable
from neo4j.exceptions import ClientError
import logging
import uuid
from typing import Dict, List, Any, Optional, Union, Tuple
from datetime import datetime
import traceback

Usage Example

# Example 1: Load document from database by UID
doc = ControlledDocument(uid='doc-12345')
if doc.uid:
    print(f'Document UID: {doc.uid}')
    print(f'Current Version: {doc.current_version_uid}')

# Example 2: Create document with pre-loaded data
data = {
    'UID': 'doc-67890',
    'currentVersionUID': 'ver-001',
    'title': 'My Document'
}
doc = ControlledDocument(data=data)
print(f'Document UID: {doc.uid}')
print(f'Current Version: {doc.current_version_uid}')

# Example 3: Create empty document
empty_doc = ControlledDocument()
print(f'UID exists: {empty_doc.uid is not None}')  # False

Best Practices

• Always check if uid or current_version_uid properties return None before using them, as documents may not have these fields populated
• When instantiating with uid parameter, ensure the database connection is available and the UID exists to avoid getting an empty document
• The class handles case variations ('UID' vs 'uid', 'currentVersionUID' vs 'currentversionuid') automatically, so either format in the data dictionary will work
• If both uid and data parameters are provided, data takes precedence and no database lookup occurs
• This class is read-only for the properties shown; modifications to _data should be done carefully as there are no validation or persistence methods visible
• The _data attribute is internal and should not be accessed directly; use the provided properties instead
• Consider the database query cost when instantiating multiple documents by UID; batch loading with data parameter may be more efficient

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function create_document_version 77.8% similar

  Creates a new controlled document in a document management system with versioning, audit trails, and relationship management in a Neo4j graph database.

  From: /tf/active/vicechatdev/CDocs copy/controllers/document_controller.py

• class ControlledDocument_v1 76.9% similar

  Model representing a controlled document.

  From: /tf/active/vicechatdev/CDocs/models/document.py

• function create_document 76.7% similar

  Creates a new controlled document in a document management system with versioning, audit trails, and optional initial content.

  From: /tf/active/vicechatdev/document_controller_backup.py

• class ControlledDocument_v1 74.6% similar

  Model representing a controlled document.

  From: /tf/active/vicechatdev/CDocs single class/models/document.py

• function create_document_legacy 74.3% similar

  Creates a new controlled document in a document management system with versioning, audit trails, and notifications. Generates document nodes in a graph database with relationships to users and versions.

  From: /tf/active/vicechatdev/CDocs/controllers/document_controller.py