Module com.darkcollective.relix.symbol

Package com.darkcollective.relix.symbol

package com.darkcollective.relix.symbol

Root package for the relix symbol-table module.

Contains the core abstractions shared across the full symbol hierarchy:

• Symbol — sealed root interface for every named entity known to the system. All symbols carry a Provenance (built-in vs user-defined), a ShadowPolicy governing whether they may be replaced, and a case-insensitive name within a namespace.
• ScalarType — the type lattice for column values and function parameters/returns (ANY, STRING, NUMBER, BOOLEAN).
• Schema and ColumnDefinition — structural description of a relation's columns.
• ParameterDefinition — a typed, named parameter used in function signatures.
• RegistrationResult and SymbolError — the result contract for symbol-table registration, supporting full error collection rather than fail-fast exceptions.

Naming convention: every symbol stores both a Symbol.declaredName() (case-preserved, as written by the user) and a Symbol.canonicalName() (lower-cased), ensuring lookups are always case-insensitive regardless of how the symbol was originally typed.

Default namespace: user-defined symbols that do not declare an explicit namespace are placed in the "default" namespace. Built-in symbols use the "builtin" namespace.

Related Packages

Package	Description
com.darkcollective.relix.symbol.function	Function symbol hierarchy.
com.darkcollective.relix.symbol.graph	The schema graph: how relations join.
com.darkcollective.relix.symbol.internal	Name resolution shared by the optimizer and the executor: which side of a join a dotted reference reaches.
com.darkcollective.relix.symbol.relation	Relation symbol hierarchy — the five concrete kinds of named relation.
com.darkcollective.relix.symbol.table	SymbolTable: every relation and function an analysis knows, looked up by name.

Class	Description
ArrayType	A nested array type — an ordered collection of elements of a single element type (which may itself be nested).
ColumnDefinition	A single column in a relation schema — its name, Type, and optional source-relation ColumnProvenance.
ColumnProvenance	The source-relation origin of a schema ColumnDefinition — which relation a column came from, and under what name, so that a relation-qualified reference (rooms.name) can be resolved precisely even after a join has renamed the physical column to disambiguate a collision.
ColumnStatistics	Per-column statistics used by the cost model to refine cardinality estimates.
FunctionProperty	Optimizer hint flags that may be attached to a function symbol.
ParameterDefinition	A single parameter in a function signature: a scalar, or — for a table-valued function only — a relation.
Provenance	Records whether a symbol was provided by the runtime or declared by a user.
RegistrationResult	The outcome of a SymbolTable.register(com.darkcollective.relix.symbol.Symbol) call.
RelationStatistics	Optimizer-facing statistics about a relation — cardinality and structural metadata gathered from a data source (e.g.
ScalarType	The scalar-value type lattice used for column types, function parameter types, and function return types.
Schema	The structural description of a relation — an ordered list of named, typed columns.
ShadowPolicy	Governs what happens when a new symbol is registered under a name that is already occupied in the same namespace.
StructType	A nested struct type — an ordered set of named, typed StructType.Fields.
StructType.Field	A single named, typed field of a StructType.
Symbol	Root sealed interface for every named entity registered in a SymbolTable.
SymbolError	A non-fatal diagnostic produced during symbol registration.
SymbolError.Kind	Classification of symbol registration errors.
Type	The type of a value in relix — a scalar, a nested struct, or an array.