LinelistSpecs

Factory helpers

Self #

self

Interface-cast self reference

Signature:

Public Property Get Self() As ILinelistSpecs

Returns the current instance cast as ILinelistSpecs for fluent construction patterns within the factory method.

Returns: ILinelistSpecs. This instance as its interface type.

InternalWorkbook #

internal-workbook

Setter for the backing workbook reference

Signature:

Public Property Set InternalWorkbook(ByVal specsWorkbook As Workbook)

Used during construction to assign the workbook before caches are initialised. Not part of the public interface.

State management

ResetObjectCaches #

reset-object-caches

Clear all collaborator object references

Signature:

Private Sub ResetObjectCaches()

ResetTranslationCache #

reset-translation-cache

Clear the translation scope cache

Signature:

Private Sub ResetTranslationCache()

ResetCategoryCache #

reset-category-cache

Clear the category list cache

Signature:

Private Sub ResetCategoryCache()

Guard helpers

EnsureWorkbook #

ensure-workbook

Verify that the backing workbook is assigned

Signature:

Private Sub EnsureWorkbook()

Lazy-initialisation guards for the workbook and category arrays.

Throws:

• ProjectError.ObjectNotInitialized When the workbook is Nothing.

EnsureCategoryArrays #

ensure-category-arrays

Create the parallel category arrays if they do not exist

Signature:

Private Sub EnsureCategoryArrays()

Worksheet resolution

ResolveSheet #

resolve-sheet

Resolve a worksheet by name with optional error surfacing

Signature:

Private Function ResolveSheet(ByVal sheetName As String, _
                              Optional ByVal allowMissing As Boolean = False) As Worksheet

Direct worksheet lookups by name within the specifications workbook. Looks up a worksheet in the specifications workbook by name. When the sheet is not found and allowMissing is False, raises a descriptive error.

Parameters:

• sheetName: String. The worksheet name to find.
• allowMissing: Boolean. When True, returns Nothing instead of raising.

Returns: Worksheet. The resolved worksheet, or Nothing if allowMissing.

Throws:

• ProjectError.InvalidArgument When sheetName is empty and not allowMissing.
• ProjectError.ElementNotFound When the sheet is missing and not allowMissing.

External workbook helpers

EnterBusyState #

enter-busy-state

Transition the application into a busy state

Signature:

Private Sub EnterBusyState(ByRef busyScope As IApplicationState)

Utilities for opening, closing, and validating external workbooks during the Prepare workflow. Creates or refreshes an ApplicationState snapshot and applies the busy state (suppressing screen updates and calculation) if not already busy.

Parameters:

• busyScope: IApplicationState (ByRef). The state object to manage.

ImportGeobase #

import-geobase

Import geobase data from the user-specified path

Signature:

Private Sub ImportGeobase(ByVal geoObj As ILLGeo)

Reads the geobase file path from the Main worksheet. If the path is not empty, opens the geobase workbook, sets the dictionary language on the exported geo worksheet via RNG_MetaLang, calls geoObj.Import to populate the output geo sheet, then closes the geobase workbook. Silently skips if the path is empty or the file cannot be opened.

Parameters:

• geoObj: ILLGeo. The geo instance on the output workbook.
• dictLang: String. The dictionary language code for RNG_MetaLang.

ExitBusyState #

exit-busy-state

Restore the application from a busy state

Signature:

Private Sub ExitBusyState(ByRef busyScope As IApplicationState)

Parameters:

• busyScope: IApplicationState (ByRef). The state object to restore and release.

BuildPreservedSheetNames #

build-preserved-sheet-names

Build the list of sheet names to preserve during dictionary preparation

Signature:

Private Function BuildPreservedSheetNames(ByVal messageTranslations As ITranslationObject) As BetterArray

Collects all specification sheet names and temporary sheet names into a BetterArray, then appends translated linelist sheet names (Admin, Analysis, Spatial, etc.) when message translations are available.

Parameters:

• messageTranslations: ITranslationObject. The message translations for resolving linelist sheet names, or Nothing to skip translated names.

Returns: BetterArray. The list of preserved sheet names.

SafeTranslatedValue #

safe-translated-value

Look up a translation key, falling back to the key itself on failure

Signature:

Private Function SafeTranslatedValue(ByVal translations As ITranslationObject, ByVal key As String) As String

Parameters:

• translations: ITranslationObject. The translation object to query.
• key: String. The translation key.

Returns: String. The translated value, or the key if translation fails.

ResetPostImportCaches #

reset-post-import-caches

Clear caches that become stale after importing new data

Signature:

Private Sub ResetPostImportCaches()

Resets the variables object, category cache, and translation cache so they are rebuilt from the freshly imported data.

Workbook validation

ValidateWorkbookReference #

validate-workbook-reference

Validate a workbook reference and its structure

Signature:

Private Sub ValidateWorkbookReference(ByVal specsWorkbook As Workbook)

Structural validation of specifications workbooks.

Throws:

• ProjectError.ObjectNotInitialized When specsWorkbook is Nothing.
• ProjectError.ElementNotFound When required sheets are missing.

ValidateWorkbookStructure #

validate-workbook-structure

Check that a workbook contains all required worksheets and named ranges

Signature:

Private Sub ValidateWorkbookStructure(ByVal specsWorkbook As Workbook)

Iterates the list of required sheet names and collects any that are missing. If the format sheet exists, also validates that the DESIGNTYPE named range is present.

Parameters:

• specsWorkbook: Workbook. The workbook to validate.

Throws:

• ProjectError.ElementNotFound When required sheets or ranges are missing.

RequiredSheetNames #

required-sheet-names

Return the array of required designer worksheet names

Signature:

Private Function RequiredSheetNames() As Variant

Only includes sheets that LinelistSpecs reads directly from the designer workbook. Pass-through sheets (Dictionary, Choices, Analysis, Export) are excluded because the build service imports them from the setup file directly into the linelist.

Returns: Variant. Array of sheet name strings.

WorksheetExistsInternal #

worksheet-exists-internal

Test whether a worksheet exists in a workbook

Signature:

Private Function WorksheetExistsInternal(ByVal specsWorkbook As Workbook, _
                                         ByVal sheetName As String) As Boolean

Parameters:

• specsWorkbook: Workbook. The workbook to search.
• sheetName: String. The worksheet name to look for.

Returns: Boolean. True when the worksheet exists.

RangeExistsInternal #

range-exists-internal

Test whether a named range exists on a worksheet

Signature:

Private Function RangeExistsInternal(ByVal hostSheet As Worksheet, _
                                     ByVal rangeName As String) As Boolean

Parameters:

• hostSheet: Worksheet. The worksheet to search.
• rangeName: String. The named range to look for.

Returns: Boolean. True when the named range exists.

JoinNames #

join-names

Join a BetterArray of names into a comma-separated, quoted string

Signature:

Private Function JoinNames(ByVal values As BetterArray) As String

Parameters:

• values: BetterArray. The names to join.

Returns: String. Formatted string like "'Sheet1', 'Sheet2'".

SafeWorkbookName #

safe-workbook-name

Safely retrieve a workbook's name, returning "" on error

Signature:

Private Function SafeWorkbookName(ByVal specsWorkbook As Workbook) As String

Parameters:

• specsWorkbook: Workbook. The workbook whose name to retrieve.

Returns: String. The workbook name or "".

Collaborator ensures

EnsureExports #

ensure-exports

Lazy-load the export collaborator

Signature:

Private Sub EnsureExports()

Lazy-initialisation guards for each collaborator object. Each EnsureXxx method creates the collaborator from its backing worksheet on first access, then caches it for subsequent calls.

EnsureDictionary #

ensure-dictionary

Lazy-load the dictionary collaborator

Signature:

Private Sub EnsureDictionary()

Requires the export collaborator to be available first (for the number of exports parameter), then creates the dictionary from the Dictionary worksheet.

EnsureChoices #

ensure-choices

Lazy-load the choices collaborator

Signature:

Private Sub EnsureChoices()

EnsureTranslations #

ensure-translations

Lazy-load the translations collaborator

Signature:

Private Sub EnsureTranslations()

Creates the LLTranslation instance from the linelist translation worksheet.

EnsureDesignerTranslations #

ensure-designer-translations

Lazy-load the designer translations collaborator

Signature:

Private Sub EnsureDesignerTranslations()

EnsureGeo #

ensure-geo

Lazy-load the geo collaborator

Signature:

Private Sub EnsureGeo()

EnsureAnalysis #

ensure-analysis

Lazy-load the analysis collaborator

Signature:

Private Sub EnsureAnalysis()

EnsurePasswords #

ensure-passwords

Lazy-load the passwords collaborator

Signature:

Private Sub EnsurePasswords()

EnsureFormulaData #

ensure-formula-data

Lazy-load the formula data collaborator

Signature:

Private Sub EnsureFormulaData()

EnsureVariables #

ensure-variables

Lazy-load the variables collaborator

Signature:

Private Sub EnsureVariables()

Requires the dictionary to be available first, then creates the LLVariables instance from it.

EnsureFormat #

ensure-format

Lazy-load the format collaborator

Signature:

Private Sub EnsureFormat()

Resolves the design name from the DESIGNTYPE named range on the format sheet, then creates the LLFormat instance.

ResolveDesignName #

resolve-design-name

Extract the design name from the format worksheet's DESIGNTYPE range

Signature:

Private Function ResolveDesignName(ByVal formatSheet As Worksheet) As String

Parameters:

• formatSheet: Worksheet. The format worksheet.

Returns: String. The trimmed design type name.

Throws:

• ProjectError.ElementNotFound When the DESIGNTYPE range is missing.

EnsureCategoryLookup #

ensure-category-lookup

Ensure choices, variables, and category arrays are ready

Signature:

Private Sub EnsureCategoryLookup()

NumberOfExports #

number-of-exports

Return the number of exports defined in the export specifications

Signature:

Private Function NumberOfExports() As Long

Returns: Long. The export count.

List auto helpers

AddListAuto #

add-list-auto

Populate the "list auto" dictionary column for list_auto variables

Signature:

Private Sub AddListAuto()

Automatic list column generation for formula-based variables. Adds a "list auto" column to the dictionary, then finds all variables with control type "list_auto" and marks their control details with "list_auto_origin". For formula-type variables (formula, case_when, choice_formula), recursively traces referenced variables and marks them as well.

RecursiveListAuto #

recursive-list-auto

Recursively mark referenced variables in formula chains as list_auto

Signature:

Private Sub RecursiveListAuto(ByVal varName As String)

Parses the control details of a formula-type variable using the Formulas engine, extracts the list of referenced variables, marks each with "list_auto_origin", and recurses into any that are themselves formulas or case_when types.

Parameters:

• varName: String. The formula variable whose references to trace.

Category helpers

FindCategoryIndex #

find-category-index

Search the category keys array for a matching key

Signature:

Private Function FindCategoryIndex(ByVal cacheKey As String) As Long

Parameters:

• cacheKey: String. The key to search for.

Returns: Long. The 1-based index if found, or 0 if not found.

ResolveCategoryList #

resolve-category-list

Build a category list from the choices sheet for a given variable

Signature:

Private Function ResolveCategoryList(ByVal varName As String, _
                                     ByVal useShortlabels As Boolean) As BetterArray

Determines the category name from the variable's control type and control details, then queries the choices collaborator.

Parameters:

• varName: String. The variable name.
• useShortlabels: Boolean. Whether to use short labels.

Returns: BetterArray. The resolved category list.

Throws:

• ProjectError.InvalidArgument When varName is empty.
• ProjectError.ElementNotFound When the variable or category is not found.

NormaliseControlType #

normalise-control-type

Strip parenthesised suffixes from a control type string

Signature:

Private Function NormaliseControlType(ByVal controlValue As String) As String

Parameters:

• controlValue: String. The raw control type value.

Returns: String. The normalised, lower-cased control type.

ExtractChoiceFormula #

extract-choice-formula

Extract the choice name from a CHOICE_FORMULA(...) control details string

Signature:

Private Function ExtractChoiceFormula(ByVal controlDetails As String) As String

Parameters:

• controlDetails: String. The raw control details value.

Returns: String. The extracted choice name.

Core accessors

ResolveTranslationScope #

resolve-translation-scope

Query the translations collaborator for a given scope

Signature:

Private Function ResolveTranslationScope(ByVal translationScope As Byte) As ITranslationObject

Parameters:

• translationScope: Byte. The translation scope to resolve.

Returns: ITranslationObject. The resolved translation object.

Throws:

• ProjectError.ElementNotFound When the scope returns Nothing.

Error handling

ThrowError #

throw-error

Raise a project error with the class name as source

Signature:

Private Sub ThrowError(ByVal errNumber As Long, ByVal messageText As String)

Internal error-raising utility.

Parameters:

• errNumber: Long. The ProjectError constant.
• messageText: String. The error description.

Test support

TestAssignDesignerTranslations #

test-assign-designer-translations

Inject a mock IDesignerTranslation instance for testing

Signature:

Public Sub TestAssignDesignerTranslations(ByVal designerTrads As IDesignerTranslation)

Backdoor setters for injecting mock collaborators during testing.

Parameters:

• designerTrads: IDesignerTranslation. The mock designer translations object.

TestAssignTranslations #

test-assign-translations

Inject a mock ILLTranslation instance for testing

Signature:

Public Sub TestAssignTranslations(ByVal translations As ILLTranslation)

Also resets the translation cache to ensure the mock object is used for subsequent TransObject lookups.

Parameters:

• translations: ILLTranslation. The mock translations object.

Interface implementation

ILinelistSpecs_ResetCaches #

Signature:

Private Sub ILinelistSpecs_ResetCaches()

ILinelistSpecs delegation stubs. Each member forwards to its corresponding public member on the concrete class. No @label tags are needed on delegation stubs.

• AnalysisOutput.cls
• CrossTable.cls
• GraphSpecs.cls
• ILinelist.cls
• ILinelistSpecs.cls
• Linelist.cls
• LinelistSpecs.cls
• ListBuilder.cls
• SectionBuilder.cls
• VarWriter.cls
• DesignerMain.bas
• EventsDesignerAdvanced.bas
• GenerationReport.bas
• LinelistSpecsWorkbookStub.cls
• LinelistStub.cls
• LLVarContextSpecsStub.cls
• TableSpecsLinelistStub.cls
• TestLinelistSpecs.bas