| Package | stimulsoft.report.dictionary.dataSources |
| Class | public class StiDataSource |
| Inheritance | StiDataSource  StiObject Object |
| Implements | IStiName, IStiInherited, IStiEnumerator, IStiRef, IStiSerializable, IStiClonable |
| Subclasses | StiDataStoreSource |
| Property | Defined By | ||
|---|---|---|---|
| alias : String Gets or sets of the Data Source alias. | StiDataSource | ||
| columns : StiDataColumnsCollection Gets or sets the column collection. | StiDataSource | ||
| connectionOrder : int Gets or sets value which indicates in which order that datasource will be connect to the data. | StiDataSource | ||
| connectOnStart : Boolean Gets or sets value which indicates that datasource not connect to the data automatically. | StiDataSource | ||
| count : int [read-only] Gets count of elements. | StiDataSource | ||
| dataTable : DataTable Gets DataTable. | StiDataSource | ||
| detailRows : Array = null | StiDataSource | ||
| dictionary : StiDictionary Gets or sets the dictionary in which this Data Source is located. | StiDataSource | ||
| inherited : Boolean | StiDataSource | ||
| initForSubreport : Boolean = false | StiDataSource | ||
| isBof : Boolean Gets value indicates that this position specifies to the beginning of data. | StiDataSource | ||
| isConnected : Boolean [read-only] Gets value indicates which Data Source is connected with data. | StiDataSource | ||
| isEmpty : Boolean [read-only] Gets value indicates that no data. | StiDataSource | ||
| isEof : Boolean Gets value indicates that this position specifies to the data end. | StiDataSource | ||
| isInited : Boolean = false | StiDataSource | ||
| name : String Gets or sets of the Data Source name. | StiDataSource | ||
| parameters : StiDataParametersCollection Gets or sets the parameter collection. | StiDataSource | ||
| position : int Gets the current position. | StiDataSource | ||
| realCount : int [read-only] | StiDataSource | ||
| ref : int | StiDataSource | ||
| rows : StiRowsCollection | StiDataSource | ||
| rowToLevel : StiHashtable = null | StiDataSource | ||
| states : StiStatesManager [read-only] Gets the component states manager. | StiDataSource | ||
| Property | Defined By | ||
|---|---|---|---|
| columnsIndexs : StiHashtable | StiDataSource | ||
| dataAdapterService : StiDataAdapterService = null | StiDataSource | ||
| isBofValue : Boolean = false | StiDataSource | ||
| isEofValue : Boolean = false | StiDataSource | ||
| positionValue : int = 0 | StiDataSource | ||
| Method | Defined By | ||
|---|---|---|---|
StiDataSource(name:String = DataSource, alias:String = DataSource) | StiDataSource | ||
checkColumnsIndexs():void | StiDataSource | ||
clearAllStates():void Clear all earlier saved object states. | StiDataSource | ||
clone(... args):Object [override] | StiDataSource | ||
connect(datas:StiDataCollection = null, loadData:Boolean = true):void Connect Data Source to data. | StiDataSource | ||
disconnect():void | StiDataSource | ||
equals(object:Object):Boolean [override] | StiDataSource | ||
first():void Sets a position at the beginning. | StiDataSource | ||
getCategoryName():String Returns the name to categories of the Data Source. | StiDataSource | ||
getChildDataSource(relationName:String):StiDataSource Returns the child Data Source by the relation name. | StiDataSource | ||
Returns a collection of Child relations. | StiDataSource | ||
getColumnIndex(columnName:String):int | StiDataSource | ||
getConditions(dataBand:StiDataBand):Array | StiDataSource | ||
getData(columnName:String, index:int = -1):Object | StiDataSource | ||
| StiDataSource | |||
| StiDataSource | |||
getLabel():String | StiDataSource | ||
getLevel():int | StiDataSource | ||
getParentData(relationName:String):StiDataRow Returns the parent row with data for the indicated relation. | StiDataSource | ||
getParentDataSource(relationName:String):StiDataSource Returns the parent Data Source by the relation name. | StiDataSource | ||
Returns the colection of Parent relations. | StiDataSource | ||
 | getShortTypeName():String Get a short object type name (without library path). | StiObject | |
| getType():Class | StiObject | |
| getTypeName():String | StiObject | |
| isSimple(object:*):Boolean [static] | StiObject | |
last():void Sets a position on the last element. | StiDataSource | ||
memberwiseClone():Object [override] | StiDataSource | ||
next():void Sets a position on the next element. | StiDataSource | ||
prior():void Sets a position on the previous element. | StiDataSource | ||
resetData():void | StiDataSource | ||
resetDetailsRows():void | StiDataSource | ||
restoreState(stateName:String):void Restores the earlier saved object state. | StiDataSource | ||
saveState(stateName:String):void Saves the current state of an object. | StiDataSource | ||
setData(dataBand:StiDataBand, relationName:String, filterMethod:Object, sortColumns:Array, reinit:Boolean, component:StiComponent):void | StiDataSource | ||
setDetails(relationName:String):void Set the details data for Data Source. | StiDataSource | ||
setFilter(filterMethod:Object):void Apply filter to data. | StiDataSource | ||
setSort(conditions:Array, sortColumns:Array, component:StiComponent, databand:StiDataBand, groupHeaders:StiComponentsCollection):void Sorts data. | StiDataSource | ||
synchronizeColumns():void | StiDataSource | ||
toString():String | StiDataSource | ||
| Method | Defined By | ||
|---|---|---|---|
invokeConnecting():void | StiDataSource | ||
invokeDisconnecting():void | StiDataSource | ||
| alias | property |
Hide Inherited Public Methods
Show Inherited Public Methodsalias:StringGets or sets of the Data Source alias.
public function get alias():String public function set alias(value:String):void| columns | property |
columns:StiDataColumnsCollectionGets or sets the column collection.
public function get columns():StiDataColumnsCollection public function set columns(value:StiDataColumnsCollection):void| columnsIndexs | property |
protected var columnsIndexs:StiHashtable| connectionOrder | property |
connectionOrder:intGets or sets value which indicates in which order that datasource will be connect to the data.
public function get connectionOrder():int public function set connectionOrder(value:int):void| connectOnStart | property |
connectOnStart:BooleanGets or sets value which indicates that datasource not connect to the data automatically.
public function get connectOnStart():Boolean public function set connectOnStart(value:Boolean):void| count | property |
count:int [read-only] Gets count of elements.
public function get count():int| dataAdapterService | property |
protected var dataAdapterService:StiDataAdapterService = null| dataTable | property |
dataTable:DataTableGets DataTable.
public function get dataTable():DataTable public function set dataTable(value:DataTable):void| detailRows | property |
public var detailRows:Array = null| dictionary | property |
dictionary:StiDictionaryGets or sets the dictionary in which this Data Source is located.
public function get dictionary():StiDictionary public function set dictionary(value:StiDictionary):void| inherited | property |
inherited:Boolean public function get inherited():Boolean public function set inherited(value:Boolean):void| initForSubreport | property |
public var initForSubreport:Boolean = false| isBof | property |
isBof:BooleanGets value indicates that this position specifies to the beginning of data.
public function get isBof():Boolean public function set isBof(value:Boolean):void| isBofValue | property |
protected var isBofValue:Boolean = false| isConnected | property |
isConnected:Boolean [read-only] Gets value indicates which Data Source is connected with data.
public function get isConnected():Boolean| isEmpty | property |
isEmpty:Boolean [read-only] Gets value indicates that no data.
public function get isEmpty():Boolean| isEof | property |
isEof:BooleanGets value indicates that this position specifies to the data end.
public function get isEof():Boolean public function set isEof(value:Boolean):void| isEofValue | property |
protected var isEofValue:Boolean = false| isInited | property |
public var isInited:Boolean = false| name | property |
name:StringGets or sets of the Data Source name.
public function get name():String public function set name(value:String):void| parameters | property |
parameters:StiDataParametersCollectionGets or sets the parameter collection.
public function get parameters():StiDataParametersCollection public function set parameters(value:StiDataParametersCollection):void| position | property |
position:intGets the current position.
public function get position():int public function set position(value:int):void| positionValue | property |
protected var positionValue:int = 0| realCount | property |
realCount:int [read-only] public function get realCount():int| ref | property |
ref:int public function get ref():int public function set ref(value:int):void| rows | property |
rows:StiRowsCollection public function get rows():StiRowsCollection public function set rows(value:StiRowsCollection):void| rowToLevel | property |
public var rowToLevel:StiHashtable = null| states | property |
states:StiStatesManager [read-only] Gets the component states manager.
public function get states():StiStatesManager| StiDataSource | () | Constructor |
public function StiDataSource(name:String = DataSource, alias:String = DataSource)name:String (default = DataSource) | |
alias:String (default = DataSource) |
| checkColumnsIndexs | () | method |
public function checkColumnsIndexs():void| clearAllStates | () | method |
public function clearAllStates():voidClear all earlier saved object states.
| clone | () | method |
override public function clone(... args):ObjectParameters
... args |
Object |
| connect | () | method |
public function connect(datas:StiDataCollection = null, loadData:Boolean = true):voidConnect Data Source to data. It is necessary to call the parent of the method(super.connect).
Parameters
datas:StiDataCollection (default = null) | |
loadData:Boolean (default = true) |
| disconnect | () | method |
public function disconnect():void| equals | () | method |
override public function equals(object:Object):BooleanParameters
object:Object |
Boolean |
| first | () | method |
public function first():voidSets a position at the beginning.
| getCategoryName | () | method |
public function getCategoryName():StringReturns the name to categories of the Data Source.
ReturnsString |
| getChildDataSource | () | method |
public function getChildDataSource(relationName:String):StiDataSourceReturns the child Data Source by the relation name.
Parameters
relationName:String |
StiDataSource |
| getChildRelations | () | method |
public function getChildRelations():StiDataRelationsCollectionReturns a collection of Child relations.
ReturnsStiDataRelationsCollection |
| getColumnIndex | () | method |
public function getColumnIndex(columnName:String):intParameters
columnName:String |
int |
| getConditions | () | method |
public function getConditions(dataBand:StiDataBand):ArrayParameters
dataBand:StiDataBand |
Array |
| getData | () | method |
public function getData(columnName:String, index:int = -1):ObjectParameters
columnName:String | |
index:int (default = -1) |
Object |
| getDataAdapter | () | method |
| getDataTable | () | method |
public function getDataTable(table:DataTable = null):DataTableParameters
table:DataTable (default = null) |
DataTable |
| getLabel | () | method |
public function getLabel():StringReturnsString |
| getLevel | () | method |
public function getLevel():intReturnsint |
| getParentData | () | method |
public function getParentData(relationName:String):StiDataRowReturns the parent row with data for the indicated relation.
Parameters
relationName:String |
StiDataRow |
| getParentDataSource | () | method |
public function getParentDataSource(relationName:String):StiDataSourceReturns the parent Data Source by the relation name.
Parameters
relationName:String |
StiDataSource |
| getParentRelations | () | method |
public function getParentRelations():StiDataRelationsCollectionReturns the colection of Parent relations.
ReturnsStiDataRelationsCollection |
| invokeConnecting | () | method |
protected function invokeConnecting():void| invokeDisconnecting | () | method |
protected function invokeDisconnecting():void| last | () | method |
public function last():voidSets a position on the last element.
| memberwiseClone | () | method |
override public function memberwiseClone():ObjectReturnsObject |
| next | () | method |
public function next():voidSets a position on the next element.
| prior | () | method |
public function prior():voidSets a position on the previous element.
| resetData | () | method |
public function resetData():void| resetDetailsRows | () | method |
public function resetDetailsRows():void| restoreState | () | method |
public function restoreState(stateName:String):voidRestores the earlier saved object state.
Parameters
stateName:String |
| saveState | () | method |
public function saveState(stateName:String):voidSaves the current state of an object.
Parameters
stateName:String |
| setData | () | method |
public function setData(dataBand:StiDataBand, relationName:String, filterMethod:Object, sortColumns:Array, reinit:Boolean, component:StiComponent):voidParameters
dataBand:StiDataBand | |
relationName:String | |
filterMethod:Object | |
sortColumns:Array | |
reinit:Boolean | |
component:StiComponent |
| setDetails | () | method |
public function setDetails(relationName:String):voidSet the details data for Data Source.
Parameters
relationName:String |
| setFilter | () | method |
public function setFilter(filterMethod:Object):voidApply filter to data.
Parameters
filterMethod:Object |
| setSort | () | method |
public function setSort(conditions:Array, sortColumns:Array, component:StiComponent, databand:StiDataBand, groupHeaders:StiComponentsCollection):voidSorts data. If data source is not able to sort data then this command is ignored.
Parameters
conditions:Array | |
sortColumns:Array | |
component:StiComponent | |
databand:StiDataBand | |
groupHeaders:StiComponentsCollection |
| synchronizeColumns | () | method |
public function synchronizeColumns():void| toString | () | method |
public function toString():StringReturnsString |