ステンシルの混沌を統治せよ:マスターシェイプの並び替えにおけるアーキテクチャ設計
業務自動化の現場において、多くのエンジニアが「動けばいい」という思考の罠に陥る。特にVisioのステンシル(.vssx)操作において、その傾向は顕著だ。
「ステンシル内のマスターシェイプの名前順に並び替えたい」
この一見シンプルに見える要求に対し、単にループを回して名前を取得し、並び替える……といった実装を考えているとしたら、君の設計は未熟だと言わざるを得ない。なぜなら、Visioのステンシルにおける「並び順」は、オブジェクトのプロパティ一つで変更できるような軽量な属性ではなく、ファイル構造そのものに紐付いた物理的なインデックスであるからだ。
本記事では、既存のステンシルを破壊することなく、堅牢かつスケーラブルにマスターシェイプを再構築するための、プロフェッショナルな設計思想と実装コードを伝授する。
1. 凡庸なエンジニアが犯す「致命的な設計ミス」
まず、避けるべき「悪い設計」を定義しておく。
インプレース(上書き)更新の罠
既存のステンシルを開き、中のマスターを一つずつ削除して、名前順に作り直そうとする設計だ。これは極めて危険である。
- データの整合性: 削除の途中でエラーが発生した場合、元のステンシルは「半分壊れた状態」で残る。
- メタデータの喪失: マスターシェイプに付与されたカスタムプロパティや、複雑なビヘイビア(Behavior)が、単純なコピーでは欠落するリスクがある。
- パフォーマンス: 大規模なステンシルにおいて、要素の削除と挿入を繰り返すのは、メモリ管理の観点から見て極めて非効率だ。
理想的なアーキテクチャ: 「Extract & Reconstruct(抽出と再構築)」
我々が採用すべきは、「既存のステンシルから情報を抽出し、ソート済みの新しいステンシルを生成して、そこにマスターを流し込む」という、不変性(Immutability)を意識した設計である。
2. 実装における3つの鉄則
プロダクションコードを書く際、以下の3点を設計要件に組み込め。
1. Atomicity(原子性): 全ての工程が成功するか、あるいは全く何も行われなかった状態(元のファイルがそのまま残る状態)を保証すること。
2. Object Lifecycle Management: StencilオブジェクトやDocumentオブジェクトは、明示的に解放し、メモリリークを防ぐこと。
3. Error Isolation: ファイルの書き込み権限エラーや、読み取り専用属性によるエラーを、ロジックの核心部分から切り離してハンドリングすること。
3. プロダクションレベルのコード実装
以下に、実務でそのまま利用可能な、堅牢なソート・再構築ロジックを示す。このコードは、単なる並び替えではなく、新しいステンシルを生成する「クリーンな再構築」プロセスを実装している。
Option Explicit
''' <summary>
''' ステンシル内のマスターシェイプを名前順にソートし、新しいステンシルとして保存する。
''' </summary>
''' <param name="sourceStencilPath">元となるステンシルのフルパス</param>
''' <param name="destinationPath">保存先のフルパス</param>
Public Sub RebuildStencilAlphabetically(ByVal sourceStencilPath As String, ByVal destinationPath As String)
Dim srcDoc As Visio.Document
Dim destDoc As Visio.Document
Dim masterList As Collection
Dim i As Long, j As Long
Dim tempMaster As MasterInfo
' 1. エラーハンドリングの初期化
On Error GoTo ErrorHandler
' 2. ソースステンシルのオープン
Set srcDoc = Application.Documents.OpenEx(sourceStencilPath, visOpenDocked)
' 3. マスター情報の収集
' 単なる名前だけでなく、オブジェクト自体を構造体(Type)で保持するのがプロの流儀だ
Set masterList = New Collection
For Each master In srcDoc.Masters
Dim info As MasterInfo
info.Name = master.Name
Set info.MasterObj = master
masterList.Add info
Next master
' 4. ソートアルゴリズム(バブルソート:要素数が数百程度なら十分高速)
' 大規模(数千件〜)ならクイックソートへの換装を検討せよ
Dim arr() As MasterInfo
ReDim arr(1 To masterList.Count)
For i = 1 To masterList.Count
Set arr(i) = masterList(i)
Next i
For i = 1 To UBound(arr) - 1
For j = i + 1 To UBound(arr)
If StrComp(arr(i).Name, arr(j).Name, vbTextCompare) > 0 Then
tempMaster = arr(i)
arr(i) = arr(j)
arr(j) = tempMaster
End If
Next j
Next i
' 5. 新しいステンシルの生成とマスターの注入
' 新規ステンシルを作成することで、既存ファイルを汚染しない
Set destDoc = Application.Documents.Add(visStencil)
For i = 1 To UBound(arr)
' マスターのコピー。名前順に作成することで、物理的なインデックスを整理する
' Note: Copy/PasteはVisioのクリップボードを経由するため、
' 大量処理時はパフォーマンスに注意が必要だが、マスターの完全性を保つにはこれが最も堅牢だ
arr(i).MasterObj.Copy
destDoc.Masters.Paste
' ペーストされたマスターの名前を元の名前に合わせる(Paste直後のマスターが名前を変える場合があるため)
' 実際には、Paste後の最新のマスターを参照する必要がある
Dim newMaster As Visio.Master
Set newMaster = destDoc.Masters(destDoc.Masters.Count)
newMaster.Name = arr(i).Name
Next i
' 6. 保存とクリーンアップ
destDoc.SaveAs destinationPath
Debug.Print "Success: Stencil rebuilt at " & destinationPath
CleanUp:
On Error Resume Next
If Not srcDoc Is Nothing Then srcDoc.Close
If Not destDoc Is Nothing Then destDoc.Close
Set masterList = Nothing
Exit Sub
ErrorHandler:
MsgBox "Critical Error: " & Err.Description, vbCritical, "Architect's Alert"
Resume CleanUp
End Sub
''' <summary>
''' マスターの情報を保持するためのカスタム型
''' </summary>
Private Type MasterInfo
Name As String
MasterObj As Visio.Master
End Type
4. 運用における高度なアドバイス
このツールを実際の業務プロセスに組み込む際、以下の観点を忘れてはならない。
ファイル・データベース連携の注意点
もし、このツールを「マスター情報の管理データベース(SQL Server等)」と連携させる場合、ステンシルの並び順を「正」とするのではなく、データベースのIDやソート順を「正」とし、ステンシルはその表現手段(View)に過ぎないと定義すべきだ。
ステンシルを直接書き換えるのではなく、DBのマスターリストに基づき、ツールが「その都度、最新の正しいステンシルを生成する」という設計にすれば、データの一貫性は完璧に保たれる。
パフォーマンスの最適化
上記のコードでは `Copy/Paste` を使用している。これは、マスターシェイプが持つ複雑なシェイプシート(ShapeSheet)や、ビヘイビア、接続ポイント、さらにはカスタムプロパティをすべて確実に引き継ぐための「最も安全な選択」だ。
もし、速度が問題になるほど巨大なステンシルを扱うのであれば、`Master.Duplicate` メソッドの検討や、特定のプロパティのみを転記する低レイヤーな実装が必要になるが、それは「仕様が固定された後の最適化」であって、最初に行うべきことではない。
結論
優れた自動化エンジニアは、コードを書く前に「データのライフサイクル」と「失敗した時の状態」を考える。
単に「並び替える」のではなく、「正しい順序で再構築する」。この設計思想の差が、保守性の高い、真にプロフェッショナルなツールを生むのだ。
次に君がコードを書くとき、その設計は「動くだけ」のものか、それとも「信頼に足る」ものか。自らに問いかけてみてほしい。
