stepxmlclient 1.0.0__py3-none-any.whl

stepxmlclient/model/relations.py

@@ -0,0 +1,105 @@
+"""Cross-reference models for STEP XML Client.
+
+Defines relationship/cross-reference classes for linking STEP entities together.
+These are used to create various types of associations between products, assets,
+classifications, and entities in the MDM system.
+"""
+
+from typing import List, Optional
+from . import BaseObject
+
+class AssetCrossReference(BaseObject):
+    """Link between a product and an asset.
+    
+    Represents a relationship from a product (or asset) to an asset file.
+    Includes optional type and qualifier information for classification of the link.
+    
+    Attributes:
+        AssetID: ID of the asset being linked
+        Type: Optional link type (e.g., 'Image', 'Document')
+        QualifierID: Optional qualifier for context/language specificity
+        KeyValue: Optional key value reference
+        MetaData: Optional metadata for the relationship
+    """
+    _GROUP_NAME: Optional[str] = None  # Used as child element only
+    _TAG_NAME: str = 'AssetCrossReference'
+    _ATTRIBUTE_NAMES: List[str] = ["AssetID", "Type", "QualifierID", "Changed"]
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = ["KeyValue", "MetaData"]
+
+
+class ProductCrossReference(BaseObject):
+    """Link between two products.
+    
+    Represents a relationship from one product to another (parent, related, component, etc.).
+    Includes optional type, qualifier, and mount location information.
+    
+    Attributes:
+        ProductID: ID of the linked product
+        Type: Optional link type (e.g., 'Parent', 'Related', 'Component')
+        QualifierID: Optional qualifier for context/language specificity
+        MountLocation: Optional location where product is mounted/used
+        KeyValue: Optional key value reference
+        MetaData: Optional metadata for the relationship
+    """
+    _GROUP_NAME: Optional[str] = None  # Used as child element only
+    _TAG_NAME: str = 'ProductCrossReference'
+    _ATTRIBUTE_NAMES: List[str] = ["ProductID", "Type", "QualifierID", "MountLocation", "Changed"]
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = ["KeyValue", "MetaData"]
+
+
+class ClassificationCrossReference(BaseObject):
+    """Link between a product/classification and another classification.
+    
+    Represents a relationship from a product or classification to a classification.
+    Used to associate products or classifications with categories in the taxonomy.
+    
+    Attributes:
+        ClassificationID: ID of the classification being linked
+        Type: Optional link type for classification relationships
+        QualifierID: Optional qualifier for context/language specificity
+        MountLocation: Optional location/context for the classification
+        KeyValue: Optional key value reference
+        MetaData: Optional metadata for the relationship
+    """
+    _GROUP_NAME: Optional[str] = None  # Used as child element only
+    _TAG_NAME: str = 'ClassificationCrossReference'
+    _ATTRIBUTE_NAMES: List[str] = ["ClassificationID", "Type", "QualifierID", "Changed"]
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = ["KeyValue", "MetaData"]
+
+
+class ClassificationReference(BaseObject):
+    """Reference from an asset/product to a classification.
+
+    This relation uses the ``ClassificationReference`` tag (not
+    ``ClassificationCrossReference``) and is required for asset-to-classification
+    links according to STEP.xsd ``AssetType``.
+    """
+    _GROUP_NAME: Optional[str] = None  # Used as child element only
+    _TAG_NAME: str = 'ClassificationReference'
+    _ATTRIBUTE_NAMES: List[str] = ["ClassificationID", "Type", "QualifierID", "Changed"]
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = ["KeyValue", "MetaData"]
+
+
+class EntityCrossReference(BaseObject):
+    """Link between a product/entity and another entity.
+    
+    Represents a relationship from a product or entity to an entity.
+    Entities can have various types of links to other entities for flexible data modeling.
+    
+    Attributes:
+        EntityID: ID of the entity being linked
+        Type: Optional link type for entity relationships
+        QualifierID: Optional qualifier for context/language specificity
+        MountLocation: Optional location/context for the entity link
+        KeyValue: Optional key value reference
+        MetaData: Optional metadata for the relationship
+    """
+    _GROUP_NAME: Optional[str] = None  # Used as child element only
+    _TAG_NAME: str = 'EntityCrossReference'
+    _ATTRIBUTE_NAMES: List[str] = ["EntityID", "Type", "QualifierID", "Changed"]
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = ["KeyValue", "MetaData"]

stepxmlclient/model/replacement.py

@@ -0,0 +1,417 @@
+"""Phase 7: Replacement Rules for bulk update operations.
+
+Handles ReplaceValues, ReplaceCrossReferences, ReplaceAttributeLinks,
+ReplaceClassificationReferences and their container classes for Products,
+Classifications, Entities, and Assets.
+"""
+
+from typing import List, Optional, TYPE_CHECKING
+from . import BaseObject
+
+if TYPE_CHECKING:
+    pass
+
+
+class ReplaceValues(BaseObject):
+    """Replacement instruction for attribute values.
+    
+    Child-only element used within ReplaceProducts, ReplaceClassifications,
+    ReplaceAssets, ReplaceEntities containers.
+    
+    Attributes:
+        AttributeID: Reference to attribute being replaced
+        AttributeGroupID: Optional reference to attribute group
+        ContextID: Optional context for the replacement
+    """
+    _GROUP_NAME: Optional[str] = None
+    _TAG_NAME: str = 'ReplaceValues'
+    _ATTRIBUTE_NAMES: List[str] = ["AttributeID", "AttributeGroupID", "ContextID"]
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = []
+
+    def __init__(self, attribute_id: Optional[str] = None,
+                 attribute_group_id: Optional[str] = None,
+                 context_id: Optional[str] = None):
+        data = {}
+        if attribute_id is not None:
+            data["AttributeID"] = attribute_id
+        if attribute_group_id is not None:
+            data["AttributeGroupID"] = attribute_group_id
+        if context_id is not None:
+            data["ContextID"] = context_id
+        super().__init__(data)
+
+
+class ReplaceCrossReferences(BaseObject):
+    """Replacement instruction for cross-references.
+    
+    Child-only element used within ReplaceProducts, ReplaceClassifications,
+    ReplaceAssets, ReplaceEntities containers.
+    
+    Attributes:
+        CrossReferenceID: Reference to the cross-reference being replaced
+        ContextID: Optional context for the replacement
+        MountLocation: Optional mount point location
+    """
+    _GROUP_NAME: Optional[str] = None
+    _TAG_NAME: str = 'ReplaceCrossReferences'
+    _ATTRIBUTE_NAMES: List[str] = ["CrossReferenceID", "ContextID", "MountLocation"]
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = []
+
+    def __init__(self, cross_reference_id: Optional[str] = None,
+                 context_id: Optional[str] = None,
+                 mount_location: Optional[str] = None):
+        data = {}
+        if cross_reference_id is not None:
+            data["CrossReferenceID"] = cross_reference_id
+        if context_id is not None:
+            data["ContextID"] = context_id
+        if mount_location is not None:
+            data["MountLocation"] = mount_location
+        super().__init__(data)
+
+
+class ReplaceAttributeLinks(BaseObject):
+    """Replacement instruction for attribute links.
+    
+    Child-only element used within ReplaceProducts, ReplaceClassifications
+    containers.
+    
+    Attributes:
+        AttributeID: Reference to the attribute link being replaced
+    """
+    _GROUP_NAME: Optional[str] = None
+    _TAG_NAME: str = 'ReplaceAttributeLinks'
+    _ATTRIBUTE_NAMES: List[str] = ["AttributeID"]
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = []
+
+    def __init__(self, attribute_id: Optional[str] = None):
+        data = {}
+        if attribute_id is not None:
+            data["AttributeID"] = attribute_id
+        super().__init__(data)
+
+
+class ReplaceClassificationReferences(BaseObject):
+    """Replacement instruction for classification references.
+    
+    Child-only element used within ReplaceProducts, ReplaceClassifications
+    containers.
+    """
+    _GROUP_NAME: Optional[str] = None
+    _TAG_NAME: str = 'ReplaceClassificationReferences'
+    _ATTRIBUTE_NAMES: List[str] = []
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = []
+
+    def __init__(self):
+        super().__init__({})
+
+
+class ReplaceProducts(BaseObject):
+    """Container for replacement rules for a product.
+    
+    Used within ReplacementRules section. Supports four types of
+    replacements: ReplaceValues, ReplaceCrossReferences, ReplaceAttributeLinks,
+    ReplaceClassificationReferences.
+    
+    Convenience Methods:
+        add_replace_values(attribute_id, attribute_group_id, context_id)
+        add_replace_cross_references(cross_reference_id, context_id, mount_location)
+        add_replace_attribute_links(attribute_id)
+        add_replace_classification_references()
+    """
+    _GROUP_NAME: Optional[str] = None  # Child-only within ReplacementRules
+    _TAG_NAME: str = 'Products'
+    _ATTRIBUTE_NAMES: List[str] = []
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = ["ReplaceValues", "ReplaceCrossReferences",
+                                   "ReplaceAttributeLinks", "ReplaceClassificationReferences"]
+
+    def __init__(self):
+        super().__init__({})
+        self.ReplaceValues: List[BaseObject] = []
+        self.ReplaceCrossReferences: List[BaseObject] = []
+        self.ReplaceAttributeLinks: List[BaseObject] = []
+        self.ReplaceClassificationReferences: List[BaseObject] = []
+
+    def add_replace_values(self, attribute_id: Optional[str] = None,
+                          attribute_group_id: Optional[str] = None,
+                          context_id: Optional[str] = None) -> ReplaceValues:
+        """Add ReplaceValues instruction using parameters.
+        
+        Args:
+            attribute_id: Reference to attribute being replaced
+            attribute_group_id: Optional reference to attribute group
+            context_id: Optional context for the replacement
+            
+        Returns:
+            ReplaceValues: Created instruction object
+        """
+        rv = ReplaceValues(attribute_id, attribute_group_id, context_id)
+        self.ReplaceValues.append(rv)
+        return rv
+
+    def add_replace_values_obj(self, replace_values: ReplaceValues) -> ReplaceValues:
+        """Add ReplaceValues instruction using object.
+        
+        Args:
+            replace_values: ReplaceValues object to add
+            
+        Returns:
+            ReplaceValues: Added instruction object
+        """
+        self.ReplaceValues.append(replace_values)
+        return replace_values
+
+    def add_replace_cross_references(self, cross_reference_id: Optional[str] = None,
+                                    context_id: Optional[str] = None,
+                                    mount_location: Optional[str] = None) -> ReplaceCrossReferences:
+        """Add ReplaceCrossReferences instruction using parameters.
+        
+        Args:
+            cross_reference_id: Reference to the cross-reference being replaced
+            context_id: Optional context for the replacement
+            mount_location: Optional mount point location
+            
+        Returns:
+            ReplaceCrossReferences: Created instruction object
+        """
+        rcr = ReplaceCrossReferences(cross_reference_id, context_id, mount_location)
+        self.ReplaceCrossReferences.append(rcr)
+        return rcr
+
+    def add_replace_cross_references_obj(self, replace_cross_ref: ReplaceCrossReferences) -> ReplaceCrossReferences:
+        """Add ReplaceCrossReferences instruction using object.
+        
+        Args:
+            replace_cross_ref: ReplaceCrossReferences object to add
+            
+        Returns:
+            ReplaceCrossReferences: Added instruction object
+        """
+        self.ReplaceCrossReferences.append(replace_cross_ref)
+        return replace_cross_ref
+
+    def add_replace_attribute_links(self, attribute_id: Optional[str] = None) -> ReplaceAttributeLinks:
+        """Add ReplaceAttributeLinks instruction using parameters.
+        
+        Args:
+            attribute_id: Reference to the attribute link being replaced
+            
+        Returns:
+            ReplaceAttributeLinks: Created instruction object
+        """
+        ral = ReplaceAttributeLinks(attribute_id)
+        self.ReplaceAttributeLinks.append(ral)
+        return ral
+
+    def add_replace_attribute_links_obj(self, replace_attr_links: ReplaceAttributeLinks) -> ReplaceAttributeLinks:
+        """Add ReplaceAttributeLinks instruction using object.
+        
+        Args:
+            replace_attr_links: ReplaceAttributeLinks object to add
+            
+        Returns:
+            ReplaceAttributeLinks: Added instruction object
+        """
+        self.ReplaceAttributeLinks.append(replace_attr_links)
+        return replace_attr_links
+
+    def add_replace_classification_references(self) -> ReplaceClassificationReferences:
+        """Add ReplaceClassificationReferences instruction.
+        
+        Returns:
+            ReplaceClassificationReferences: Created instruction object
+        """
+        rcr = ReplaceClassificationReferences()
+        self.ReplaceClassificationReferences.append(rcr)
+        return rcr
+
+    def add_replace_classification_references_obj(self, replace_class_refs: ReplaceClassificationReferences) -> ReplaceClassificationReferences:
+        """Add ReplaceClassificationReferences instruction using object.
+        
+        Args:
+            replace_class_refs: ReplaceClassificationReferences object to add
+            
+        Returns:
+            ReplaceClassificationReferences: Added instruction object
+        """
+        self.ReplaceClassificationReferences.append(replace_class_refs)
+        return replace_class_refs
+
+
+class ReplaceClassifications(BaseObject):
+    """Container for replacement rules for classifications.
+    
+    Supports ReplaceValues, ReplaceCrossReferences, and ReplaceAttributeLinks.
+    Similar to ReplaceProducts but without ReplaceClassificationReferences.
+    
+    Convenience Methods:
+        add_replace_values(attribute_id, attribute_group_id, context_id)
+        add_replace_cross_references(cross_reference_id, context_id, mount_location)
+        add_replace_attribute_links(attribute_id)
+    """
+    _GROUP_NAME: Optional[str] = None  # Child-only within ReplacementRules
+    _TAG_NAME: str = 'Classifications'
+    _ATTRIBUTE_NAMES: List[str] = []
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = ["ReplaceValues", "ReplaceCrossReferences",
+                                   "ReplaceAttributeLinks"]
+
+    def __init__(self):
+        super().__init__({})
+        self.ReplaceValues: List[BaseObject] = []
+        self.ReplaceCrossReferences: List[BaseObject] = []
+        self.ReplaceAttributeLinks: List[BaseObject] = []
+
+    def add_replace_values(self, attribute_id: Optional[str] = None,
+                          attribute_group_id: Optional[str] = None,
+                          context_id: Optional[str] = None) -> ReplaceValues:
+        """Add ReplaceValues instruction using parameters."""
+        rv = ReplaceValues(attribute_id, attribute_group_id, context_id)
+        self.ReplaceValues.append(rv)
+        return rv
+
+    def add_replace_values_obj(self, replace_values: ReplaceValues) -> ReplaceValues:
+        """Add ReplaceValues instruction using object."""
+        self.ReplaceValues.append(replace_values)
+        return replace_values
+
+    def add_replace_cross_references(self, cross_reference_id: Optional[str] = None,
+                                    context_id: Optional[str] = None,
+                                    mount_location: Optional[str] = None) -> ReplaceCrossReferences:
+        """Add ReplaceCrossReferences instruction using parameters."""
+        rcr = ReplaceCrossReferences(cross_reference_id, context_id, mount_location)
+        self.ReplaceCrossReferences.append(rcr)
+        return rcr
+
+    def add_replace_cross_references_obj(self, replace_cross_ref: ReplaceCrossReferences) -> ReplaceCrossReferences:
+        """Add ReplaceCrossReferences instruction using object."""
+        self.ReplaceCrossReferences.append(replace_cross_ref)
+        return replace_cross_ref
+
+    def add_replace_attribute_links(self, attribute_id: Optional[str] = None) -> ReplaceAttributeLinks:
+        """Add ReplaceAttributeLinks instruction using parameters."""
+        ral = ReplaceAttributeLinks(attribute_id)
+        self.ReplaceAttributeLinks.append(ral)
+        return ral
+
+    def add_replace_attribute_links_obj(self, replace_attr_links: ReplaceAttributeLinks) -> ReplaceAttributeLinks:
+        """Add ReplaceAttributeLinks instruction using object."""
+        self.ReplaceAttributeLinks.append(replace_attr_links)
+        return replace_attr_links
+
+
+class ReplaceEntities(BaseObject):
+    """Container for replacement rules for entities.
+    
+    Supports ReplaceValues and ReplaceCrossReferences (no attribute links or
+    classification references for entities).
+    
+    Convenience Methods:
+        add_replace_values(attribute_id, attribute_group_id, context_id)
+        add_replace_cross_references(cross_reference_id, context_id, mount_location)
+    """
+    _GROUP_NAME: Optional[str] = None  # Child-only within ReplacementRules
+    _TAG_NAME: str = 'Entities'
+    _ATTRIBUTE_NAMES: List[str] = []
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = ["ReplaceValues", "ReplaceCrossReferences"]
+
+    def __init__(self):
+        super().__init__({})
+        self.ReplaceValues: List[BaseObject] = []
+        self.ReplaceCrossReferences: List[BaseObject] = []
+
+    def add_replace_values(self, attribute_id: Optional[str] = None,
+                          attribute_group_id: Optional[str] = None,
+                          context_id: Optional[str] = None) -> ReplaceValues:
+        """Add ReplaceValues instruction using parameters."""
+        rv = ReplaceValues(attribute_id, attribute_group_id, context_id)
+        self.ReplaceValues.append(rv)
+        return rv
+
+    def add_replace_values_obj(self, replace_values: ReplaceValues) -> ReplaceValues:
+        """Add ReplaceValues instruction using object."""
+        self.ReplaceValues.append(replace_values)
+        return replace_values
+
+    def add_replace_cross_references(self, cross_reference_id: Optional[str] = None,
+                                    context_id: Optional[str] = None,
+                                    mount_location: Optional[str] = None) -> ReplaceCrossReferences:
+        """Add ReplaceCrossReferences instruction using parameters."""
+        rcr = ReplaceCrossReferences(cross_reference_id, context_id, mount_location)
+        self.ReplaceCrossReferences.append(rcr)
+        return rcr
+
+    def add_replace_cross_references_obj(self, replace_cross_ref: ReplaceCrossReferences) -> ReplaceCrossReferences:
+        """Add ReplaceCrossReferences instruction using object."""
+        self.ReplaceCrossReferences.append(replace_cross_ref)
+        return replace_cross_ref
+
+
+class ReplaceAssets(BaseObject):
+    """Container for replacement rules for assets.
+    
+    Supports ReplaceValues and ReplaceCrossReferences (no attribute links or
+    classification references for assets).
+    
+    Convenience Methods:
+        add_replace_values(attribute_id, attribute_group_id, context_id)
+        add_replace_cross_references(cross_reference_id, context_id, mount_location)
+    """
+    _GROUP_NAME: Optional[str] = None  # Child-only within ReplacementRules
+    _TAG_NAME: str = 'Assets'
+    _ATTRIBUTE_NAMES: List[str] = []
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = ["ReplaceValues", "ReplaceCrossReferences"]
+
+    def __init__(self):
+        super().__init__({})
+        self.ReplaceValues: List[BaseObject] = []
+        self.ReplaceCrossReferences: List[BaseObject] = []
+
+    def add_replace_values(self, attribute_id: Optional[str] = None,
+                          attribute_group_id: Optional[str] = None,
+                          context_id: Optional[str] = None) -> ReplaceValues:
+        """Add ReplaceValues instruction using parameters."""
+        rv = ReplaceValues(attribute_id, attribute_group_id, context_id)
+        self.ReplaceValues.append(rv)
+        return rv
+
+    def add_replace_values_obj(self, replace_values: ReplaceValues) -> ReplaceValues:
+        """Add ReplaceValues instruction using object."""
+        self.ReplaceValues.append(replace_values)
+        return replace_values
+
+    def add_replace_cross_references(self, cross_reference_id: Optional[str] = None,
+                                    context_id: Optional[str] = None,
+                                    mount_location: Optional[str] = None) -> ReplaceCrossReferences:
+        """Add ReplaceCrossReferences instruction using parameters."""
+        rcr = ReplaceCrossReferences(cross_reference_id, context_id, mount_location)
+        self.ReplaceCrossReferences.append(rcr)
+        return rcr
+
+    def add_replace_cross_references_obj(self, replace_cross_ref: ReplaceCrossReferences) -> ReplaceCrossReferences:
+        """Add ReplaceCrossReferences instruction using object."""
+        self.ReplaceCrossReferences.append(replace_cross_ref)
+        return replace_cross_ref
+
+
+class ReplaceAttributes(BaseObject):
+    """Container for replacement rules for attributes (empty container).
+    
+    Currently a simple container with no child elements defined in the schema.
+    Provides expansion point for future attribute-specific replacements.
+    """
+    _GROUP_NAME: Optional[str] = None  # Child-only within ReplacementRules
+    _TAG_NAME: str = 'Attributes'
+    _ATTRIBUTE_NAMES: List[str] = []
+    _TEXT_NAMES: List[str] = []
+    _CHILDREN_NAMES: List[str] = []
+
+    def __init__(self):
+        super().__init__({})