Class StiDictionary

Hierarchy

StiDictionary

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new StiDictionary(report?: StiReport): StiDictionary

Parameters
- Default value report: StiReport = null
Returns StiDictionary

Properties

Protected _hash

_hash: StiMeta[]

businessObjects

businessObjects: StiBusinessObjectsCollection

cacheDataSet

cacheDataSet: DataSet

cachedUserNamesAndPasswords

cachedUserNamesAndPasswords: Hashtable = null

dataSources

dataSources: StiDataSourcesCollection

dataStore

dataStore: StiDataCollection = new StiDataCollection()

databases

databases: StiDatabaseCollection

reconnectListForRequestFromUserVariables

reconnectListForRequestFromUserVariables: string[]

relations

relations: StiDataRelationsCollection

report

report: StiReport

resources

resources: StiResourcesCollection = new StiResourcesCollection()

restrictions

restrictions: StiRestrictions = new StiRestrictions()

useInternalData

useInternalData: boolean = false

userFunctions

userFunctions: StiUserFunctionsCollection

variables

variables: StiVariablesCollection = new StiVariablesCollection()

Accessors

isRequestFromUserVariablesPresent

get isRequestFromUserVariablesPresent(): boolean

Returns boolean

Static autoSynchronize

get autoSynchronize(): StiAutoSynchronizeMode
set autoSynchronize(value: StiAutoSynchronizeMode): void

Returns StiAutoSynchronizeMode
Parameters
- value: StiAutoSynchronizeMode
Returns void

Methods

clear

clear(): void

Returns void

clone

clone(): StiDictionary

Implementation of ICloneable.clone

Returns StiDictionary

closeConnections

closeConnections(connections: List<IStiAppConnection>): void

Implementation of IStiAppDictionary.closeConnections

Closes all specified connections. Closes all connections if none of them is specified.

Parameters
- connections: List<IStiAppConnection>
Returns void

connect

connect(loadData?: boolean, dataSources?: StiDataSource[]): void

Parameters
- Default value loadData: boolean = true
- Default value dataSources: StiDataSource[] = null
Returns void

connectAsync

connectAsync(loadData?: boolean, dataSources?: StiDataSource[]): StiPromise<void>

Parameters
- Default value loadData: boolean = true
- Default value dataSources: StiDataSource[] = null
Returns StiPromise<void>

connectCrossTabDataSources

connectCrossTabDataSources(): void

Returns void

connectDataTransformationsAsync

connectDataTransformationsAsync(option?: StiDataRequestOption): StiPromise<void>

Parameters
- Default value option: StiDataRequestOption = StiDataRequestOption.None
Returns StiPromise<void>

connectToDatabases

connectToDatabases(loadData?: boolean, throwException?: boolean): void

Parameters
- Default value loadData: boolean = true
- Default value throwException: boolean = true
Returns void

connectToDatabasesAsync

connectToDatabasesAsync(loadData?: boolean): StiPromise<void>

Parameters
- Default value loadData: boolean = true
Returns StiPromise<void>

connectV2

connectV2(baseReport: StiReport): void

Connects all Data Sources to data V2

Parameters
- baseReport: StiReport
Returns void

connectV2Async

connectV2Async(baseReport: StiReport): Promise<void>

Connects all Data Sources to data V2

Parameters
- baseReport: StiReport
Returns Promise<void>

connectVirtualDataSourcesAsync

connectVirtualDataSourcesAsync(): StiPromise<void>

Returns StiPromise<void>

createDatabases

createDatabases(loadData: boolean): void

Parameters
- loadData: boolean
Returns void

createDatabasesAsync

createDatabasesAsync(loadData: boolean): StiPromise<void>

Parameters
- loadData: boolean
Returns StiPromise<void>

disconnect

disconnect(): void

Returns void

existsUserFunction

existsUserFunction(functionName: string): boolean

Implementation of IStiAppDictionary.existsUserFunction

Parameters
- functionName: string
Returns boolean

fetchDataRelations

fetchDataRelations(): List<IStiAppDataRelation>

Implementation of IStiAppDictionary.fetchDataRelations

Returns an enumeration of the data relations from this dictionary.

Returns List<IStiAppDataRelation>

The enumeration of the data relations.

fetchDataSources

fetchDataSources(): List<IStiAppDataSource>

Implementation of IStiAppDictionary.fetchDataSources

Returns an enumeration of the data source from this dictionary.

Returns List<IStiAppDataSource>

The enumeration of the data source.

fetchVariables

fetchVariables(): List<IStiAppVariable>

Implementation of IStiAppDictionary.fetchVariables

Returns an enumeration of the variables from this dictionary.

Returns List<IStiAppVariable>

The enumeration of the variables.

getApp

getApp(): IStiApp

Implementation of IStiAppDictionary.getApp

Returns IStiApp

getColumnByName

getColumnByName(name: string): IStiAppDataColumn

Implementation of IStiAppDictionary.getColumnByName

Returns data column from the data dictionary by its name.

Parameters
- name: string
  
  A name of the data column.
Returns IStiAppDataColumn

The data column from the data dictionary. Returns null, if data column with specified name is not exists.

getDataSourceByName

getDataSourceByName(name: string): IStiAppDataSource

Implementation of IStiAppDictionary.getDataSourceByName

Returns datasource from the data dictionary by its name.

Parameters
- name: string
  
  A name of the datasource.
Returns IStiAppDataSource

The datasource from the data dictionary.Returns null, if datasource with specified name is not exists.

getSystemVariableValue

getSystemVariableValue(name: string): any

Implementation of IStiAppDictionary.getSystemVariableValue

Returns value of a specified system variable.

Parameters
- name: string
  
  A name of the system variable.
Returns any

The value of the specified system variable.

getUnusedRelationsFromDataStore

getUnusedRelationsFromDataStore(): StiDataRelationsCollection

Returns StiDataRelationsCollection

getVariableByName

getVariableByName(name: string): IStiAppVariable

Implementation of IStiAppDictionary.getVariableByName

Returns variable from the data dictionary by its name.

Parameters
- name: string
  
  A name of the variable.
Returns IStiAppVariable

The variable from the data dictionary. Returns null, if variable with specified name not exists.

getVariableValueByName

getVariableValueByName(name: string): any

Implementation of IStiAppDictionary.getVariableValueByName

Returns a value from the variable by its name.

Parameters
- name: string
  
  A name of the variable.
Returns any

A value which contains in the variable.

getVariableValueInternal

getVariableValueInternal(name: string): any

Parameters
- name: string
Returns any

implements

implements(): any[]

Returns any[]

invokeUserFunction

invokeUserFunction(functionName: string, args: List<any>): any

Implementation of IStiAppDictionary.invokeUserFunction

Parameters
- functionName: string
- args: List<any>
Returns any

isReadOnlyVariable

isReadOnlyVariable(name: string): boolean

Implementation of IStiAppDictionary.isReadOnlyVariable

Returns true if a specified variable is a read-only variable.

Parameters
- name: string
  
  The name of the variable.
Returns boolean

True, if the specified variable is a read-only variable.

isSystemVariable

isSystemVariable(name: string): boolean

Implementation of IStiAppDictionary.isSystemVariable

Returns true if a specified name is a name of a system variable.

Parameters
- name: string
  
  The name of the system variable.
Returns boolean

True, if the specified name is the name of system variable.

loadFromJsonObject

loadFromJsonObject(jObject: StiJson): void

Implementation of IStiJsonReportObject.loadFromJsonObject

Parameters
- jObject: StiJson
Returns void

loadFromXml

loadFromXml(xmlNode: XmlNode): void

Parameters
- xmlNode: XmlNode
Returns void

merge

merge(dictionary: StiDictionary): void

Parameters
- dictionary: StiDictionary
Returns void

mergeFile

mergeFile(filePath: string): void

Parameters
- filePath: string
Returns void

meta

meta(): StiMeta[]

Returns StiMeta[]

openConnections

openConnections(connections: List<IStiAppConnection>): List<IStiAppConnection>

Implementation of IStiAppDictionary.openConnections

Opens specified connections to the data. Opens all connections if none of them is specified.

Parameters
- connections: List<IStiAppConnection>
Returns List<IStiAppConnection>

openConnectionsAsync

openConnectionsAsync(connections: List<IStiAppConnection>): Promise<List<IStiAppConnection>>

Implementation of IStiAppDictionary.openConnectionsAsync

Opens specified connections to the data. Opens all connections if none of them is specified.

Parameters
- connections: List<IStiAppConnection>
Returns Promise<List<IStiAppConnection>>

regRelation

regRelation(relation: StiDataRelation, virtualSources: boolean): void

Parameters
- relation: StiDataRelation
- virtualSources: boolean
Returns void

regRelations

regRelations(virtualSources?: boolean): void

Parameters
- Default value virtualSources: boolean = false
Returns void

removeUnusedData

removeUnusedData(): void

Returns void

removeUnusedDataSourcesV2

removeUnusedDataSourcesV2(): void

Returns void

renameDatabase

renameDatabase(database: StiDatabase, newName: string): void

Parameters
- database: StiDatabase
- newName: string
Returns void

retrievalData

retrievalData(REFusedRelations: any, REFusedDataSources: any, REFusedColumns: any): void

Parameters
- REFusedRelations: any
- REFusedDataSources: any
- REFusedColumns: any
Returns void

saveToJsonObject

saveToJsonObject(mode: StiJsonSaveMode): StiJson

Implementation of IStiJsonReportObject.saveToJsonObject

Parameters
- mode: StiJsonSaveMode
Returns StiJson

synchronize

synchronize(): void

Returns void

synchronizeAsync

synchronizeAsync(): Promise<void>

Returns Promise<void>

synchronizeBusinessObjects

synchronizeBusinessObjects(): void

Returns void

synchronizeColumns

synchronizeColumns(data: StiData, dataSource: StiDataSource): void

Parameters
- data: StiData
- dataSource: StiDataSource
Returns void

synchronizeColumns2

synchronizeColumns2(data: any, source: StiBusinessObject): void

Parameters
- data: any
- source: StiBusinessObject
Returns void

synchronizeColumns3

synchronizeColumns3(data: StiBusinessObjectData, source: StiBusinessObject): void

Parameters
- data: StiBusinessObjectData
- source: StiBusinessObject
Returns void

synchronizeColumnsAsync

synchronizeColumnsAsync(data: StiData, dataSource: StiDataSource): StiPromise<void>

Parameters
- data: StiData
- dataSource: StiDataSource
Returns StiPromise<void>

Static doAutoSynchronize

doAutoSynchronize(report: StiReport): void

Parameters
- report: StiReport
Returns void

Generated using TypeDoc