Class Cube
Namespace: FastReport.Olap.Cube
Assembly: FastCube.Core.dll
Cube instance.
public class Cube : Component
Inheritance
object ← MarshalByRefObject ← Component ← Cube
Constructors
Cube()
Creates a default instnace.
public Cube()
Cube(IContainer)
Creates a new instnace with container.
public Cube(IContainer container)
Parameters
container IContainer
Properties
Aborted
Gets a value indicating that cube execution was aborted.
[Browsable(false)]
public bool Aborted { get; }
Property Value
Active
Determines whether the Cube is Active or not. To open the Cube set correctly SourceType property and Active = true.
public bool Active { get; set; }
Property Value
Caption
The Cube caption. Visible in the Slice grid header and Fields dialog.
public string Caption { get; set; }
Property Value
CompressCubeFile
Defines whether to use compression for cube files
public bool CompressCubeFile { get; set; }
Property Value
CubeFields
Gets cube fields.
public CubeFields CubeFields { get; }
Property Value
DataSource
Gets cube data source.
public DataSource DataSource { get; set; }
Property Value
DayOfWeekISO8601
use ISO8601 to calc day of week
public bool DayOfWeekISO8601 { get; set; }
Property Value
Description
The Cube description. Can be used to set/get a detailed string description. Is not visible in any visual component.
public string Description { get; set; }
Property Value
LoadingStep
Gets current loading step.
[Browsable(false)]
public LoadingStep LoadingStep { get; }
Property Value
Operation
Gets the cube operation that is currently performed.
[Browsable(false)]
public CubeOperation Operation { get; }
Property Value
SaveExtras
Option which regulates what extras saves with Cube to the cube file or stream
public SliceSaveExtras SaveExtras { get; set; }
Property Value
SkipFieldsWithErrors
To ignore fields which have not passed the test on the datasource opening
public bool SkipFieldsWithErrors { get; set; }
Property Value
SourceType
Determines which source of data must be used to load the Cube after setting Active = true
public SourceType SourceType { get; set; }
Property Value
State
More detailed information about the Cube sate. See also Active property.
[Browsable(false)]
public State State { get; }
Property Value
TimeStats
Gets the cube operations duration
[Browsable(false)]
public TimeStats TimeStats { get; }
Property Value
WeekNumberISO8601
use ISO8601 to calc WeekNumber
public bool WeekNumberISO8601 { get; set; }
Property Value
Methods
Abort()
Aborts the cube execution.
public void Abort()
Append(string)
Appends cube by file name.
public void Append(string fileName)
Parameters
fileName string
Append(Stream)
Appends cube by stream.
public void Append(Stream stream)
Parameters
stream Stream
AppendData()
Appends data to the cube.
public void AppendData()
ClearGroups()
Clears the groups.
public void ClearGroups()
Close()
Closes the cube.
public void Close()
GetFieldsCount()
Gets number of fields.
public int GetFieldsCount()
Returns
GetSourceRecordsCount()
Gets number of source records.
public int GetSourceRecordsCount()
Returns
GetSourceValue(int, int)
Returns source value by record index and field index.
public object GetSourceValue(int recordIndex, int fieldIndex)
Parameters
recordIndex int
fieldIndex int
Returns
GetSourceValue(int, CubeField)
Returns source value by record inded and cube field.
public object GetSourceValue(int recordIndex, CubeField cubeField)
Parameters
recordIndex int
cubeField CubeField
Returns
GetSourceValueAsString(int, int)
Returns source value as string by record index and field index.
public string GetSourceValueAsString(int recordIndex, int fieldIndex)
Parameters
recordIndex int
fieldIndex int
Returns
GetSourceValueAsString(int, CubeField)
returns source value as string by record index and cube field.
public string GetSourceValueAsString(int recordIndex, CubeField cubeField)
Parameters
recordIndex int
cubeField CubeField
Returns
GetSourceValueId(int, int)
Returns source value id by record index and field index.
public int GetSourceValueId(int recordIndex, int fieldIndex)
Parameters
recordIndex int
fieldIndex int
Returns
GetSourceValueId(int, CubeField)
Returns source value id by record index and cube field.
public int GetSourceValueId(int recordIndex, CubeField cubeField)
Parameters
recordIndex int
cubeField CubeField
Returns
GetSourceValueIdAndVariant(int, int, out object)
Returns source value id and soure value as variant by record index and field index.
public int GetSourceValueIdAndVariant(int recordIndex, int fieldIndex, out object value)
Parameters
recordIndex int
fieldIndex int
value object
Returns
GetSourceValueIdAndVariant(int, CubeField, out object)
Returns source value id and soure value as variant by record index and cube field.
public int GetSourceValueIdAndVariant(int recordIndex, CubeField cubeField, out object value)
Parameters
recordIndex int
cubeField CubeField
value object
Returns
Load(Stream)
Loads cube from stream.
public void Load(Stream stream)
Parameters
stream Stream
Load(string)
Loads cube from file by filename.
public void Load(string fileName)
Parameters
fileName string
LoadGroups(XmlItem, bool)
Loads groups from xml.
public void LoadGroups(XmlItem item, bool clearGroups)
Parameters
item XmlItem
clearGroups bool
Open()
Opens the cube.
public void Open()
RefreshData()
Refreshes data of the cube.
public void RefreshData()
Save(string)
Saves cube to file by filename.
public void Save(string fileName)
Parameters
fileName string
Save(Stream, bool, object)
Saves cube to stream.
public void Save(Stream s, bool compress = true, object filter = null)
Parameters
s Stream
compress bool
filter object
SaveGroups(XmlItem, bool)
Saves the groups.
public void SaveGroups(XmlItem item, bool onlyForNotSavedFields = false)
Parameters
item XmlItem
onlyForNotSavedFields bool
SendAlert(CubeAlertEventArgs)
Sends the alert to event bus.
protected void SendAlert(CubeAlertEventArgs alert)
Parameters
alert CubeAlertEventArgs
AlertEventHandler
Event on alerts.
public event CubeAlertEventHandler AlertEventHandler
Event Type
ManualLoad
Event on manual load.
public event CubeManualLoadEventHandler ManualLoad