README
¶
Vocabulary Examples
These are reference implementations only - NOT part of the core SemStreams framework.
Purpose
These examples demonstrate how applications should:
- Define domain-specific vocabulary in their own packages
- Register predicates with the vocabulary registry
- Configure alias semantics for entity resolution
Usage in Applications
Step 1: Create Your Vocabulary Package
// In your application: myapp/vocabulary/mydom
ain.go
package vocabulary
import "github.com/c360/semstreams/vocabulary"
const (
MyDomainIdentifierDeviceID = "mydomain.identifier.deviceid"
MyDomainLabelFriendlyName = "mydomain.label.friendlyname"
)
func init() {
vocabulary.RegisterPredicate(vocabulary.PredicateMetadata{
Name: MyDomainIdentifierDeviceID,
Description: "Device ID from our system",
DataType: "string",
Domain: "mydomain",
Category: "identifier",
IsAlias: true,
AliasType: vocabulary.AliasTypeExternal,
AliasPriority: 0,
})
vocabulary.RegisterPredicate(vocabulary.PredicateMetadata{
Name: MyDomainLabelFriendlyName,
Description: "User-friendly display name",
DataType: "string",
Domain: "mydomain",
Category: "label",
IsAlias: true,
AliasType: vocabulary.AliasTypeLabel, // NOT resolvable!
AliasPriority: 999,
})
}
Step 2: Import in Your Main Package
package main
import (
_ "myapp/vocabulary" // Registers predicates via init()
"github.com/c360/semstreams/processor/graph/indexmanager"
)
func main() {
// AliasIndex will automatically discover registered predicates
// No hardcoded predicates in framework!
}
Alias Types
- AliasTypeIdentity: Entity equivalence (owl:sameAs) - resolvable
- AliasTypeLabel: Display names (skos:prefLabel) - NOT resolvable
- AliasTypeAlternate: Secondary identifiers - resolvable
- AliasTypeExternal: External system IDs - resolvable
- AliasTypeCommunication: Network/radio IDs - resolvable
Priority
Lower number = higher priority for conflict resolution.
- Priority 0: Most authoritative (e.g., primary IDs)
- Priority 1-10: Standard aliases
- Priority 999: Display-only labels
Best Practices
- Domain Scoping: Use your domain prefix (e.g.,
robotics.*,iot.*) - Three Levels: Always use
domain.category.propertyformat - Type Semantics: Choose AliasType carefully - labels are NOT resolvable
- Priority Strategy: Primary IDs get priority 0, decreasing importance
- Registration: Use
init()functions for automatic registration
Documentation
¶
Overview ¶
Package examples provides reference vocabulary implementations. These are NOT part of the core framework - they demonstrate how applications should define domain-specific vocabularies and register predicates.
Applications should create similar packages in their own codebases.
Index ¶
Constants ¶
const ( // RoboticsCommunicationCallsign - radio call sign for ATC RoboticsCommunicationCallsign = "robotics.communication.callsign" // RoboticsIdentifierSerial - manufacturer serial number RoboticsIdentifierSerial = "robotics.identifier.serial" // RoboticsIdentifierRegistration - FAA or regulatory registration RoboticsIdentifierRegistration = "robotics.identifier.registration" )
Example robotics domain predicates. Shows how domain-specific applications would define their vocabulary.
const ( // SemanticIdentityAlias - alternative entity identifier (owl:sameAs) SemanticIdentityAlias = "semantic.identity.alias" // SemanticIdentityUUID - universally unique identifier SemanticIdentityUUID = "semantic.identity.uuid" // SemanticLabelPreferred - preferred human-readable name (skos:prefLabel) SemanticLabelPreferred = "semantic.label.preferred" // SemanticLabelAlternate - alternative display name SemanticLabelAlternate = "semantic.label.alternate" )
Example semantic domain predicates for identity and labeling. In a real application, this would be in your application's vocabulary package.
Variables ¶
This section is empty.
Functions ¶
func RegisterRoboticsVocabulary ¶
func RegisterRoboticsVocabulary()
RegisterRoboticsVocabulary registers example robotics domain predicates.
func RegisterSemanticVocabulary ¶
func RegisterSemanticVocabulary()
RegisterSemanticVocabulary registers example semantic domain predicates. Applications would call this from their init() functions or during startup.
Types ¶
This section is empty.
Source Files