builder

func (ArrayToken) GetName ¶

func (ap ArrayToken) GetName() string

GetName returns the array name without the index.

func (*EmbeddedDataSpecificationsBuilder) Build ¶

func (edsb *EmbeddedDataSpecificationsBuilder) Build() []types.IEmbeddedDataSpecification

Build finalizes the construction of all embedded data specifications and returns them as a slice. This method should be called after all data specifications and their contents have been processed through BuildReferences() and BuildContentsIec61360().

The method extracts all embedded data specifications from the internal map and returns them as a slice. Each specification contains complete reference hierarchies and IEC 61360 content where applicable.

Returns:

• []types.IEmbeddedDataSpecification: A slice containing all constructed embedded data specifications with their complete reference hierarchies and content

Example:

builder := NewEmbeddedDataSpecificationsBuilder()
builder.BuildReferences(refData, referredRefData)
builder.BuildContentsIec61360(iecData)
specs := builder.Build()

func (*EmbeddedDataSpecificationsBuilder) BuildContentsIec61360 ¶

func (edsb *EmbeddedDataSpecificationsBuilder) BuildContentsIec61360(iecRows json.RawMessage) error

BuildContentsIec61360 processes IEC 61360 data specification content and populates the DataSpecificationContent field of each EmbeddedDataSpecification.

This method handles the complex IEC 61360 data specification format, which includes:

• Multi-language preferred names, short names, and definitions
• Unit references with hierarchical structures
• Data types, value formats, and values
• Optional value lists with reference pairs
• Optional level types for hierarchical concepts

Parameters:

• iecRows: JSON-encoded array of EdsContentIec61360Row objects containing IEC 61360 content data including language strings, references, value lists, and level types

Returns:

• error: An error if unmarshalling fails, data type conversion fails, language string parsing fails, reference building fails, or validation checks fail. Returns nil on success.

The method performs comprehensive processing:

1. Unmarshals IEC 61360 content rows
2. Creates placeholder entries for each specification
3. For each IEC 61360 content: - Converts data type from string to enum - Parses multi-language strings (preferred name, short name, definition) - Builds unit ID references with hierarchy - Processes optional value lists with their references - Parses optional level type information
4. Constructs DataSpecificationIec61360 objects
5. Attaches optional value lists and level types using setter methods

Validation ensures:

• Exactly one unit ID reference per specification
• Exactly one reference per value list entry

Example:

builder := NewEmbeddedDataSpecificationsBuilder()
builder.BuildReferences(refJSON, referredRefJSON)
err := builder.BuildContentsIec61360(iecJSON)
if err != nil {
    log.Printf("Failed to build IEC 61360 content: %v", err)
}

func (*EmbeddedDataSpecificationsBuilder) BuildReferences ¶

func (edsb *EmbeddedDataSpecificationsBuilder) BuildReferences(edsReferenceRows json.RawMessage, edsReferredReferenceRows json.RawMessage) error

BuildReferences processes reference data for embedded data specifications and constructs complete Reference objects with their hierarchical ReferredSemanticID structures.

This method handles the DataSpecification field of EmbeddedDataSpecification objects, which points to the semantic definition of the data specification. It processes both direct references and referred references (nested references), building the complete reference hierarchy.

Parameters:

• edsReferenceRows: JSON-encoded array of EdsReferenceRow objects containing reference and key data from the database
• edsReferredReferenceRows: JSON-encoded array of ReferredReferenceRow objects containing hierarchical referred reference data

Returns:

• error: An error if unmarshalling fails, reference parsing fails, or if an embedded data specification doesn't have exactly one reference. Returns nil on success.

The method performs the following steps:

1. Unmarshals the reference row data
2. Creates placeholder EmbeddedDataSpecification entries for each unique EDS ID
3. Converts EdsReferenceRow objects to ReferenceRow format for processing
4. Parses references using ReferenceBuilder for each specification
5. Processes referred references to build hierarchical structures
6. Finalizes the nested reference structures

Example:

builder := NewEmbeddedDataSpecificationsBuilder()
err := builder.BuildReferences(refJSON, referredRefJSON)
if err != nil {
    log.Printf("Failed to build references: %v", err)
}

func (*ExtensionsBuilder) AddExtension ¶

func (b *ExtensionsBuilder) AddExtension(extensionDbID int64, name string, valueType string, value string, position int) (*ExtensionsBuilder, error)

AddExtension creates a new Extension with the specified properties and adds it to the builder. Extensions provide additional information or custom data that extends the standard AAS metamodel. Duplicate extensions (based on database ID) are automatically skipped with a warning message.

Parameters:

• extensionDbID: The database ID of the extension for tracking and duplicate detection
• name: The name of the extension that identifies its purpose or type
• valueType: The data type of the extension value (e.g., "xs:string", "xs:boolean", "xs:int")
• value: The actual value of the extension as a string

Returns:

• *ExtensionsBuilder: Returns the builder instance for method chaining
• error: Returns an error if the value type cannot be parsed, nil otherwise

The method validates that the valueType is valid according to the XSD data type definitions before creating the extension. If parsing fails, detailed error information is printed to the console.

Example:

builder := NewExtensionsBuilder()
builder.AddExtension(1, "CustomProperty", "xs:string", "customValue")
builder.AddExtension(2, "IsActive", "xs:boolean", "true")

func (*ExtensionsBuilder) AddRefersTo ¶

func (b *ExtensionsBuilder) AddRefersTo(extensionDbID int64, refersToRows json.RawMessage, refersToReferredRows json.RawMessage) (*ExtensionsBuilder, error)

AddRefersTo adds RefersTo references to an extension. RefersTo references specify other elements that this extension relates to or references, establishing relationships between the extension and other AAS elements.

Parameters:

• extensionDbID: The database ID of the extension to add the RefersTo references to
• refersToRows: JSON-encoded array of ReferenceRow objects representing the RefersTo references
• refersToReferredRows: JSON-encoded array of ReferredReferenceRow objects representing nested ReferredSemanticIds within the RefersTo references

Returns:

• *ExtensionsBuilder: Returns the builder instance for method chaining
• error: Returns an error if the extension doesn't exist or if parsing fails, nil otherwise

This method accepts multiple references (zero or more) as an extension can refer to multiple other elements.

Example:

builder.AddRefersTo(1, refersToJSON, referredReferencesJSON)

func (*ExtensionsBuilder) AddSemanticID ¶

func (b *ExtensionsBuilder) AddSemanticID(extensionDbID int64, semanticIDRows json.RawMessage, semanticIDReferredSemanticIDRows json.RawMessage) (*ExtensionsBuilder, error)

AddSemanticID adds a SemanticID reference to an extension. The SemanticID provides semantic meaning to the extension, linking it to a concept definition. This method expects exactly one reference and will return an error if zero or multiple references are provided.

Parameters:

• extensionDbID: The database ID of the extension to add the SemanticID to
• semanticIdRows: JSON-encoded array of ReferenceRow objects representing the SemanticId
• semanticIdReferredSemanticIdRows: JSON-encoded array of ReferredReferenceRow objects representing nested ReferredSemanticIds within the SemanticId

Returns:

• *ExtensionsBuilder: Returns the builder instance for method chaining
• error: Returns an error if the extension doesn't exist, if parsing fails, or if the number of references is not exactly one

Example:

builder.AddSemanticID(1, semanticIdJSON, referredSemanticIdJSON)

func (*ExtensionsBuilder) AddSupplementalSemanticIDs ¶

func (b *ExtensionsBuilder) AddSupplementalSemanticIDs(extensionDbID int64, supplementalSemanticIDsRows json.RawMessage, supplementalSemanticIDsReferredSemanticIDRows json.RawMessage) (*ExtensionsBuilder, error)

AddSupplementalSemanticIDs adds supplemental semantic IDs to an extension. Supplemental semantic IDs provide additional semantic context beyond the primary SemanticID, allowing multiple semantic interpretations or classifications to be associated with an extension.

Parameters:

• extensionDbID: The database ID of the extension to add the supplemental semantic IDs to
• supplementalSemanticIdsRows: JSON-encoded array of ReferenceRow objects representing the supplemental semantic ID references
• supplementalSemanticIdsReferredSemanticIdRows: JSON-encoded array of ReferredReferenceRow objects representing nested ReferredSemanticIds within the supplemental semantic IDs

Returns:

• *ExtensionsBuilder: Returns the builder instance for method chaining
• error: Returns an error if the extension doesn't exist or if parsing fails, nil otherwise

Unlike AddSemanticID, this method accepts multiple references (zero or more) as supplemental semantic IDs are inherently a collection.

Example:

builder.AddSupplementalSemanticIDs(1, supplementalSemanticIdsJSON, referredSemanticIdsJSON)

func (*ExtensionsBuilder) Build ¶

func (b *ExtensionsBuilder) Build() []types.IExtension

Build finalizes the construction of all extensions and their associated references. This method must be called after all extensions and their references have been added through the Add* methods.

The method performs the following operations:

1. Calls BuildNestedStructure() on all ReferenceBuilders to construct the hierarchical ReferredSemanticID trees within each reference
2. Collects all extensions from the internal map into a slice for return

Returns:

• []types.IExtension: A slice containing all constructed extensions with their complete reference hierarchies

Example:

builder := NewExtensionsBuilder()
builder.AddExtension(1, "CustomProperty", "xs:string", "value")
builder.AddSemanticID(1, semanticIdJSON, referredJSON)
extensions := builder.Build()

func (*QualifiersBuilder) AddQualifier ¶

func (b *QualifiersBuilder) AddQualifier(qualifierDbID int64, qType string, valueType int64, value string, position int, kind *int64) (*QualifiersBuilder, error)

AddQualifier creates a new Qualifier with the specified properties and adds it to the builder. Qualifiers provide additional information about other AAS elements and can restrict their values or semantics. Duplicate qualifiers (based on database ID) are automatically skipped with a warning message.

Parameters:

• qualifierDbID: The database ID of the qualifier for tracking and duplicate detection
• kind: The kind of qualifier (e.g., "ConceptQualifier", "ValueQualifier", "TemplateQualifier")
• qType: The type that qualifies the qualifier itself (semantic identifier)
• valueType: The data type of the qualifier value (e.g., "xs:string", "xs:boolean", "xs:int")
• value: The actual value of the qualifier as a string

Returns:

• *QualifiersBuilder: Returns the builder instance for method chaining
• error: Returns an error if the qualifier kind or value type cannot be parsed, nil otherwise

The method validates that the kind and valueType are valid according to the AAS metamodel before creating the qualifier. If parsing fails, detailed error information is printed to the console.

Example:

builder := NewQualifiersBuilder()
builder.AddQualifier(1, "ConceptQualifier", "ExpressionSemantic", "xs:string", "example value")
builder.AddQualifier(2, "ValueQualifier", "ExpressionLogic", "xs:boolean", "true")

func (*QualifiersBuilder) AddSemanticID ¶

func (b *QualifiersBuilder) AddSemanticID(qualifierDbID int64, semanticIDRows json.RawMessage, semanticIDReferredSemanticIDRows json.RawMessage) (*QualifiersBuilder, error)

AddSemanticID adds a SemanticID reference to a qualifier. This method expects exactly one reference and will return an error if zero or multiple references are provided.

Parameters:

• qualifierDbID: The database ID of the qualifier to add the SemanticID to
• semanticIdRows: JSON-encoded array of ReferenceRow objects representing the SemanticId
• semanticIdReferredSemanticIdRows: JSON-encoded array of ReferredReferenceRow objects representing nested ReferredSemanticIds within the SemanticId

Returns:

• *QualifiersBuilder: Returns the builder instance for method chaining
• error: Returns an error if the qualifier doesn't exist, if parsing fails, or if the number of references is not exactly one

The method uses the internal createExactlyOneReference helper to ensure exactly one reference is created from the provided rows. It also processes any nested ReferredSemanticIds to build the complete reference hierarchy.

Example:

builder.AddSemanticID(1, semanticIdJSON, referredSemanticIdJSON)

func (*QualifiersBuilder) AddSupplementalSemanticIDs ¶

func (b *QualifiersBuilder) AddSupplementalSemanticIDs(qualifierDbID int64, supplementalSemanticIDsRows json.RawMessage, supplementalSemanticIDsReferredSemanticIDRows json.RawMessage) (*QualifiersBuilder, error)

AddSupplementalSemanticIDs adds supplemental semantic IDs to a qualifier. Supplemental semantic IDs provide additional semantic context beyond the primary SemanticID, allowing multiple semantic interpretations or classifications to be associated with a qualifier.

Parameters:

• qualifierDbID: The database ID of the qualifier to add the supplemental semantic IDs to
• supplementalSemanticIdsRows: JSON-encoded array of ReferenceRow objects representing the supplemental semantic ID references
• supplementalSemanticIdsReferredSemanticIdRows: JSON-encoded array of ReferredReferenceRow objects representing nested ReferredSemanticIds within the supplemental semantic IDs

Returns:

• *QualifiersBuilder: Returns the builder instance for method chaining
• error: Returns an error if the qualifier doesn't exist or if parsing fails, nil otherwise

Unlike AddSemanticID and AddValueID, this method accepts multiple references (zero or more) as supplemental semantic IDs are inherently a collection. Each reference can have its own nested ReferredSemanticID hierarchy.

Example:

builder.AddSupplementalSemanticIDs(1, supplementalSemanticIdsJSON, referredSemanticIdsJSON)

func (*QualifiersBuilder) AddValueID ¶

func (b *QualifiersBuilder) AddValueID(qualifierDbID int64, valueIDRows json.RawMessage, valueIDReferredSemanticIDRows json.RawMessage) (*QualifiersBuilder, error)

AddValueID adds a ValueID reference to a qualifier. The ValueID references the value of the qualifier in a global, unique way, allowing the qualifier's value to be semantically interpreted across different contexts. This method expects exactly one reference and will return an error if zero or multiple references are provided.

Parameters:

• qualifierDbID: The database ID of the qualifier to add the ValueID to
• valueIdRows: JSON-encoded array of ReferenceRow objects representing the ValueId
• valueIdReferredSemanticIdRows: JSON-encoded array of ReferredReferenceRow objects representing nested ReferredSemanticIds within the ValueId

Returns:

• *QualifiersBuilder: Returns the builder instance for method chaining
• error: Returns an error if the qualifier doesn't exist, if parsing fails, or if the number of references is not exactly one

The method uses the internal createExactlyOneReference helper to ensure exactly one reference is created from the provided rows. It also processes any nested ReferredSemanticIds to build the complete reference hierarchy.

Example:

builder.AddValueID(1, valueIdJSON, referredSemanticIdJSON)

func (*QualifiersBuilder) Build ¶

func (b *QualifiersBuilder) Build() []types.IQualifier

Build finalizes the construction of all qualifiers and their associated references. This method must be called after all qualifiers and their references have been added through the Add* methods. It performs the following operations:

1. Calls BuildNestedStructure() on all ReferenceBuilders to construct the hierarchical ReferredSemanticID trees within each reference
2. Collects all qualifiers from the internal map into a slice for return

Returns:

• []gen.Qualifier: A slice containing all constructed qualifiers with their complete reference hierarchies

After calling Build(), the builder can be discarded as all data has been extracted and properly structured. The returned qualifiers contain fully constructed references with nested ReferredSemanticIds where applicable.

Typical usage pattern:

// 1. Create the builder
builder := NewQualifiersBuilder()

// 2. Add qualifiers and their references (typically in a loop over database rows)
builder.AddQualifier(1, "ConceptQualifier", "ExpressionSemantic", "xs:string", "example")
builder.AddSemanticID(1, semanticIdRows, referredSemanticIdRows)
builder.AddValueID(1, valueIdRows, referredValueIdRows)
builder.AddSupplementalSemanticIds(1, supplSemanticIdsRows, supplReferredRows)

builder.AddQualifier(2, "ValueQualifier", "ExpressionLogic", "xs:boolean", "true")
builder.AddValueID(2, valueIdRows2, referredValueIdRows2)

// 3. Build and retrieve the final qualifiers
qualifiers := builder.Build()

// Now 'qualifiers' contains all qualifiers with complete reference hierarchies

func (*ReferenceBuilder) BuildNestedStructure ¶

func (rb *ReferenceBuilder) BuildNestedStructure()

BuildNestedStructure constructs the hierarchical tree of ReferredSemanticIds by linking child references to their parent references. This method should be called after all references and keys have been added through CreateReferredSemanticID and CreateReferredSemanticIdKey.

The method iterates through all ReferredSemanticIds and assigns each one to its parent's ReferredSemanticID field, building the complete nested structure. References already attached to the root are skipped.

Typical usage pattern:

// 1. Create the builder
ref, builder := NewReferenceBuilder("ExternalReference", 123)

// 2. Add keys and ReferredSemanticIds (typically in a loop over database rows)
builder.CreateKey(1, "Submodel", "https://example.com/submodel")
builder.CreateReferredSemanticID(456, 123, "ModelReference")
builder.CreateReferredSemanticIdKey(456, 2, "ConceptDescription", "0173-1#01-ABC123#001")
builder.CreateReferredSemanticID(789, 456, "ExternalReference")
builder.CreateReferredSemanticIdKey(789, 3, "GlobalReference", "https://example.com/concept")

// 3. Build the nested structure
builder.BuildNestedStructure()

// Now 'ref' contains the complete nested hierarchy

func (*ReferenceBuilder) CreateKey ¶

func (rb *ReferenceBuilder) CreateKey(keyID int64, keyType types.KeyTypes, keyValue string)

CreateKey adds a new key to the root reference. Keys are the building blocks of a reference and define the path to the referenced element. Duplicate keys (based on database ID) are automatically skipped to prevent duplication when processing multiple database rows.

Parameters:

• key_id: The database ID of the key for duplicate detection
• key_type: The type of key (e.g., "Submodel", "GlobalReference", "ConceptDescription")
• key_value: The value of the key (e.g., a URL or identifier)

Example:

builder.CreateKey(1, "Submodel", "https://example.com/submodel/123")
builder.CreateKey(2, "SubmodelElementCollection", "MyCollection")

func (*ReferenceBuilder) CreateReferredSemanticID ¶

func (rb *ReferenceBuilder) CreateReferredSemanticID(referredSemanticIDDbID int64, parentID int64, referenceType types.ReferenceTypes) *ReferenceBuilder

CreateReferredSemanticID creates a new ReferredSemanticID reference within the hierarchy. ReferredSemanticIds can be nested, forming a tree structure where each reference can have its own ReferredSemanticId. This method handles creating new references and tracking their position in the hierarchy.

Parameters:

• referredSemanticIdDbID: The database ID of the ReferredSemanticID reference
• parentID: The database ID of the parent reference in the hierarchy
• referenceType: The type of the ReferredSemanticID reference

Returns:

• *ReferenceBuilder: Returns the builder instance for method chaining

If the parentID matches the root reference's database ID, the ReferredSemanticID is immediately attached to the root reference. Otherwise, it's stored for later attachment during the BuildNestedStructure phase.

Example:

// Create a ReferredSemanticID directly under the root reference
builder.CreateReferredSemanticID(456, 123, "ExternalReference")
// Create a nested ReferredSemanticID under another ReferredSemanticId
builder.CreateReferredSemanticID(789, 456, "ModelReference")

func (*ReferenceBuilder) CreateReferredSemanticIDKey ¶

func (rb *ReferenceBuilder) CreateReferredSemanticIDKey(referredSemanticIDDbID int64, keyID int64, keyType types.KeyTypes, keyValue string) error

CreateReferredSemanticIDKey adds a key to a specific ReferredSemanticID reference in the hierarchy. This method delegates to the appropriate builder for the target reference.

Parameters:

• referredSemanticIdDbID: The database ID of the ReferredSemanticID to add the key to
• key_id: The database ID of the key for duplicate detection
• key_type: The type of key (e.g., "ConceptDescription", "GlobalReference")
• key_value: The value of the key

Returns:

• error: Returns an error if the ReferredSemanticID builder cannot be found, nil otherwise

This method must be called after CreateReferredSemanticID has been called for the corresponding referredSemanticIdDbID, otherwise it will return an error.

Example:

builder.CreateReferredSemanticID(456, 123, "ExternalReference")
err := builder.CreateReferredSemanticIDKey(456, 1, "GlobalReference", "https://example.com")
if err != nil {
    // Handle error
}

func (*ReferenceBuilder) SetReferredSemanticID ¶

func (rb *ReferenceBuilder) SetReferredSemanticID(referredSemanticID types.IReference)

SetReferredSemanticID directly assigns a ReferredSemanticID to the root reference. This is used when the referred semantic ID is already constructed and needs to be attached to the reference.

Parameters:

• referredSemanticID: A pointer to the Reference that should be set as the ReferredSemanticId

Note: This method is typically used after the referred semantic ID has been fully constructed with all its keys and nested structure.

func (SimpleToken) GetName ¶

func (sp SimpleToken) GetName() string

GetName returns the name of the simple token.