Packagestimulsoft.report.dictionary
Classpublic class StiDictionary
InheritanceStiDictionary Inheritance StiObject Inheritance Object
Implements IStiRef, IStiSerializable


Public Properties
 PropertyDefined By
  autoSynchronize : int
[static] Gets or sets Synchronization mode of the Dictionary.
StiDictionary
  businessObjects : StiBusinessObjectsCollection
Gets or sets collection of the business objects.
StiDictionary
  cacheDataSet : DataSet
Gets or sets a DataSet for caching.
StiDictionary
  cachedUserNamesAndPasswords : StiHashtable
StiDictionary
  databases : StiDatabaseCollection
Gets or sets collection of the databases.
StiDictionary
  dataSources : StiDataSourcesCollection
Gets or sets collection of the data sources.
StiDictionary
  dataStore : StiDataCollection
Gets or sets DataStore.
StiDictionary
  isRequestFromUserVariablesPresent : Boolean
[read-only]
StiDictionary
  ref : int
StiDictionary
  relations : StiDataRelationsCollection
Gets or sets collection of relations.
StiDictionary
  report : StiReport
Gets or sets report in which given dictionary is placed.
StiDictionary
  restrictions : StiRestrictions
Gets or sets collections of dictionary restrictions.
StiDictionary
  useInternalData : Boolean
If the property is true then all data sources (including SQL sources) connect only with DataSet data, which were passed using RegData method.
StiDictionary
  variables : StiVariablesCollection
Gets or sets collection of variables.
StiDictionary
Public Methods
 MethodDefined By
  
StiDictionary(report:StiReport = null)
StiDictionary
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
StiDictionary
  
clear():void
Clears data dictionary.
StiDictionary
  
clearCache():void
Clear cached names
StiDictionary
  
clone(... args):Object
[override]
StiDictionary
  
connect(loadData:Boolean = true):void
StiDictionary
  
connectVirtualDataSources():void
Intenal use only.
StiDictionary
  
createDatabases(loadData:Boolean):void
StiDictionary
  
disconnect():void
Disconnects the Data Source from data.
StiDictionary
  
dispatchEvent(event:Event):Boolean
StiDictionary
  
doAutoSynchronize(report:StiReport):void
[static]
StiDictionary
 Inherited
equals(object:Object):Boolean
StiObject
  
getDataSet(dataSetName:String):DataSet
Returns a new DataSet from the dictionary.
StiDictionary
 Inherited
getShortTypeName():String
Get a short object type name (without library path).
StiObject
 Inherited
getType():Class
StiObject
 Inherited
getTypeName():String
StiObject
  
getUnusedRelationsFromDataStore(categories:StiHashtable = null):StiDataRelationsCollection
StiDictionary
  
hasEventListener(type:String):Boolean
StiDictionary
 Inherited
isSimple(object:*):Boolean
[static]
StiObject
  
memberwiseClone():Object
[override]
StiDictionary
  
regRelation(relation:StiDataRelation, virtualSources:Boolean = false):void
Register new relation of the dictionary DataSet.
StiDictionary
  
regRelations(virtualSources:Boolean = false):void
Register new relations of the dictionary DataSet.
StiDictionary
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
StiDictionary
  
removeUnusedData():void
Removes from dictionary unused data sources, relations, and rows and etc.
StiDictionary
  
retrievalData(usedRelations:StiHashtable, usedDataSources:StiHashtable, usedColumns:StiHashtable):void
Returns Hashtables with the used relations, data sources and columns.
StiDictionary
  
sortItems(order:int = 0):void
Sorts the DataSources collection and columns in each DataSource.
StiDictionary
  
synchronize():void
Synchronizes the content of the DataStore and Dictionary.
StiDictionary
  
synchronizeColumns(data:StiData, dataSource:StiDataSource):void
StiDictionary
Property Detail
autoSynchronizeproperty
autoSynchronize:int

Gets or sets Synchronization mode of the Dictionary.


Implementation
    public static function get autoSynchronize():int
    public static function set autoSynchronize(value:int):void
businessObjectsproperty 
businessObjects:StiBusinessObjectsCollection

Gets or sets collection of the business objects.


Implementation
    public function get businessObjects():StiBusinessObjectsCollection
    public function set businessObjects(value:StiBusinessObjectsCollection):void
cacheDataSetproperty 
cacheDataSet:DataSet

Gets or sets a DataSet for caching.


Implementation
    public function get cacheDataSet():DataSet
    public function set cacheDataSet(value:DataSet):void
cachedUserNamesAndPasswordsproperty 
cachedUserNamesAndPasswords:StiHashtable


Implementation
    public function get cachedUserNamesAndPasswords():StiHashtable
    public function set cachedUserNamesAndPasswords(value:StiHashtable):void
databasesproperty 
databases:StiDatabaseCollection

Gets or sets collection of the databases.


Implementation
    public function get databases():StiDatabaseCollection
    public function set databases(value:StiDatabaseCollection):void
dataSourcesproperty 
dataSources:StiDataSourcesCollection

Gets or sets collection of the data sources.


Implementation
    public function get dataSources():StiDataSourcesCollection
    public function set dataSources(value:StiDataSourcesCollection):void
dataStoreproperty 
dataStore:StiDataCollection

Gets or sets DataStore.


Implementation
    public function get dataStore():StiDataCollection
    public function set dataStore(value:StiDataCollection):void
isRequestFromUserVariablesPresentproperty 
isRequestFromUserVariablesPresent:Boolean  [read-only]


Implementation
    public function get isRequestFromUserVariablesPresent():Boolean
refproperty 
ref:int


Implementation
    public function get ref():int
    public function set ref(value:int):void
relationsproperty 
relations:StiDataRelationsCollection

Gets or sets collection of relations.


Implementation
    public function get relations():StiDataRelationsCollection
    public function set relations(value:StiDataRelationsCollection):void
reportproperty 
report:StiReport

Gets or sets report in which given dictionary is placed.


Implementation
    public function get report():StiReport
    public function set report(value:StiReport):void
restrictionsproperty 
restrictions:StiRestrictions

Gets or sets collections of dictionary restrictions.


Implementation
    public function get restrictions():StiRestrictions
    public function set restrictions(value:StiRestrictions):void
useInternalDataproperty 
useInternalData:Boolean

If the property is true then all data sources (including SQL sources) connect only with DataSet data, which were passed using RegData method. DataNames of data sources are to be the same.


Implementation
    public function get useInternalData():Boolean
    public function set useInternalData(value:Boolean):void
variablesproperty 
variables:StiVariablesCollection

Gets or sets collection of variables.


Implementation
    public function get variables():StiVariablesCollection
    public function set variables(value:StiVariablesCollection):void
Constructor Detail
StiDictionary()Constructor
public function StiDictionary(report:StiReport = null)



Parameters
report:StiReport (default = null)
Method Detail
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
useWeakReference:Boolean (default = false)

clear()method 
public function clear():void

Clears data dictionary.

clearCache()method 
public function clearCache():void

Clear cached names

clone()method 
override public function clone(... args):Object

Parameters

... args

Returns
Object
connect()method 
public function connect(loadData:Boolean = true):void

Parameters

loadData:Boolean (default = true)

connectVirtualDataSources()method 
public function connectVirtualDataSources():void

Intenal use only.

createDatabases()method 
public function createDatabases(loadData:Boolean):void

Parameters

loadData:Boolean

disconnect()method 
public function disconnect():void

Disconnects the Data Source from data.

dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
doAutoSynchronize()method 
public static function doAutoSynchronize(report:StiReport):void

Parameters

report:StiReport

getDataSet()method 
public function getDataSet(dataSetName:String):DataSet

Returns a new DataSet from the dictionary.

Parameters

dataSetName:String

Returns
DataSet
getUnusedRelationsFromDataStore()method 
public function getUnusedRelationsFromDataStore(categories:StiHashtable = null):StiDataRelationsCollection

Parameters

categories:StiHashtable (default = null)

Returns
StiDataRelationsCollection
hasEventListener()method 
public function hasEventListener(type:String):Boolean

Parameters

type:String

Returns
Boolean
memberwiseClone()method 
override public function memberwiseClone():Object

Returns
Object
regRelation()method 
public function regRelation(relation:StiDataRelation, virtualSources:Boolean = false):void

Register new relation of the dictionary DataSet.

Parameters

relation:StiDataRelation
 
virtualSources:Boolean (default = false)

regRelations()method 
public function regRelations(virtualSources:Boolean = false):void

Register new relations of the dictionary DataSet.

Parameters

virtualSources:Boolean (default = false)

removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

removeUnusedData()method 
public function removeUnusedData():void

Removes from dictionary unused data sources, relations, and rows and etc.

retrievalData()method 
public function retrievalData(usedRelations:StiHashtable, usedDataSources:StiHashtable, usedColumns:StiHashtable):void

Returns Hashtables with the used relations, data sources and columns.

Parameters

usedRelations:StiHashtable
 
usedDataSources:StiHashtable
 
usedColumns:StiHashtable

sortItems()method 
public function sortItems(order:int = 0):void

Sorts the DataSources collection and columns in each DataSource.

Parameters

order:int (default = 0)

synchronize()method 
public function synchronize():void

Synchronizes the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.

synchronizeColumns()method 
public function synchronizeColumns(data:StiData, dataSource:StiDataSource):void

Parameters

data:StiData
 
dataSource:StiDataSource





Mon Mar 27 2017, 09:08 AM +03:00