SleelaDoc API
HTML documentation for the SLeeLa standard library (/lib)
Home › Packages › sst

Package sst

This package contains 11 source unit(s) defining 11 class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.

DynamiteConnector #sleela 2.5 (lib/sst/DynamiteConnector.sleela)

DynamiteConnector class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
referenceNameString referenceNameNo description in source.
importPathString importPathNo description in source.
configurationString configurationNo description in source.
propertiesString propertiesNo description in source.
statusString statusNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializefunction initialize()No description in source.
resolvefunction resolve()No description in source.
deferConstructionfunction deferConstruction()No description in source.

MySQLConnector #sleela 2.5 (lib/sst/MySQLConnector.sleela)

MySQLConnector class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
hostString hostNo description in source.
portint portNo description in source.
databaseString databaseNo description in source.
userString userNo description in source.
statusString statusNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializefunction initialize()No description in source.
configurefunction configure()No description in source.
connectfunction connect()No description in source.
disconnectfunction disconnect()No description in source.
installfunction install()No description in source.

PostgreSQLConnector #sleela 2.5 (lib/sst/PostgreSQLConnector.sleela)

PostgreSQLConnector class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
hostString hostNo description in source.
portint portNo description in source.
databaseString databaseNo description in source.
userString userNo description in source.
statusString statusNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializefunction initialize()No description in source.
configurefunction configure()No description in source.
connectfunction connect()No description in source.
disconnectfunction disconnect()No description in source.
installfunction install()No description in source.

SLPackage #sleela 2.5 (lib/sst/SLPackage.sleela)

SLPackage class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
nameString nameNo description in source.
versionString versionNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializefunction initialize()No description in source.
packageNamefunction packageName()No description in source.
packageVersionfunction packageVersion()No description in source.

SQLConnector #sleela 2.5 (lib/sst/SQLConnector.sleela)

SQLConnector class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
providerString providerNo description in source.
hostString hostNo description in source.
portint portNo description in source.
databaseString databaseNo description in source.
userString userNo description in source.
statusString statusNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializefunction initialize()No description in source.
configurefunction configure()No description in source.
connectfunction connect()No description in source.
disconnectfunction disconnect()No description in source.
installfunction install()No description in source.
installedfunction installed()No description in source.

SSTLibrary #sleela 2.5 (lib/sst/SSTLibrary.sleela)

SSTLibrary class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
rootString rootNo description in source.
packageCountuint32 packageCountNo description in source.
sourceCountuint32 sourceCountNo description in source.
symbolCountuint32 symbolCountNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurefunction configure(libraryRoot)No description in source.
discoverfunction discover()No description in source.
containsPackagefunction containsPackage(name)No description in source.
containsSourcefunction containsSource(path)No description in source.
recordInventoryfunction recordInventory(packages,sources,symbols)No description in source.
validatefunction validate()No description in source.

SSTSource #sleela 2.5 (lib/sst/SSTSource.sleela)

SSTSource class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
pathString pathNo description in source.
libraryRootString libraryRootNo description in source.
targetString targetNo description in source.
profileString profileNo description in source.
sourceSetString sourceSetNo description in source.
sourcePackageCountuint32 sourcePackageCountNo description in source.
sourceSymbolCountuint32 sourceSymbolCountNo description in source.
validateduint32 validatedNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurefunction configure(sourcePath,root,targetName,profileName)No description in source.
attachSourceSetfunction attachSourceSet(name)No description in source.
recordLibraryfunction recordLibrary(packageCount,symbolCount)No description in source.
validatefunction validate()No description in source.

SSTSymbol #sleela 2.5 (lib/sst/SSTSymbol.sleela)

SSTSymbol class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
packageNameString packageNameNo description in source.
nameString nameNo description in source.
qualifiedNameString qualifiedNameNo description in source.
kindString kindNo description in source.
pathString pathNo description in source.
visibilityString visibilityNo description in source.
signatureString signatureNo description in source.
statusString statusNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializefunction initialize()No description in source.
qualifyfunction qualify()No description in source.
declarefunction declare()No description in source.
resolvefunction resolve()No description in source.
emitfunction emit()No description in source.

SSTSymbolKind #sleela 2.5 (lib/sst/SSTSymbolKind.sleela)

SSTSymbolKind class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString valueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializefunction initialize()No description in source.
classKindfunction classKind()No description in source.
functionKindfunction functionKind()No description in source.
fieldKindfunction fieldKind()No description in source.
constantKindfunction constantKind()No description in source.
variableKindfunction variableKind()No description in source.
moduleKindfunction moduleKind()No description in source.
packageKindfunction packageKind()No description in source.
typeKindfunction typeKind()No description in source.
interfaceKindfunction interfaceKind()No description in source.

SSTSymbolReference #sleela 2.5 (lib/sst/SSTSymbolReference.sleela)

SSTSymbolReference class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
qualifiedNameString qualifiedNameNo description in source.
packageNameString packageNameNo description in source.
symbolNameString symbolNameNo description in source.
statusString statusNo description in source.
sourceString sourceNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializefunction initialize()No description in source.
resolvefunction resolve()No description in source.
unresolvedfunction unresolved()No description in source.
validfunction valid()No description in source.

SSTSymbolTable #sleela 2.5 (lib/sst/SSTSymbolTable.sleela)

SSTSymbolTable class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
libraryRootString libraryRootNo description in source.
packageNameString packageNameNo description in source.
symbolCountint symbolCountNo description in source.
resolvedCountint resolvedCountNo description in source.
unresolvedCountint unresolvedCountNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializefunction initialize()No description in source.
declarefunction declare()No description in source.
resolvefunction resolve()No description in source.
rejectfunction reject()No description in source.
completefunction complete()No description in source.