Click or drag to resize

DataFrame Class

Object for processing and parsing data returned from OnDemand servers. Parses data formatted for a factlet and provides accessors to get that data. Stores the parsed results. Stores any warnings or errors that occurred during data retrieval, as well Can index by columns - for example, if "Id" is being used as an indexing string, then if a column named Id is present in the results, the DataFrame will categorize each row by what Id it belongs to, and data can be retrieved by Id by using the getColumnForIndex functions For example, if there are 5 rows with IBM as the Id, 5 rows with AAPL, and 5 rows with FDS, calling GetIndices on the dataframe will return {"IBM","AAPL","FDS"} Calling getColumnForIndexAsDouble("IBM", 2) will return all data points in column 2 that have "IBM" as their ID as Doubles
Inheritance Hierarchy

Namespace:  Kratos_3.Network
Assembly:  Kratos_3 (in Kratos_3.dll) Version: 3.6.2.0 (3.6.2.0)
Syntax
public class DataFrame : IDataTable

The DataFrame type exposes the following members.

Constructors
Methods
  NameDescription
Public methodcheckForErrors
Search the input of this DataFrame for lines containing "FactSetOnDemandQueryError", indicating that there was an error
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodgetCellT
Get the dat point at the given row and column
Public methodgetCellAt
Returns a datapoint at a given row and column as an object
Public methodgetCellFloat
Returns a datapoint at given row and column as double
Public methodgetCellInt
Returns a datapoint at given row and column as integer
Public methodgetCellString
Returns a datapoint at given row and column as string
Public methodgetColumnT
Returns all data points in a particular column
Public methodgetColumnAsDoubles
Returns all datapoints in a column as doubles
Public methodgetColumnAsInts
Returns all datapoints in a column as integers
Public methodgetColumnAsStrings
Returns all datapoints in a column as strings
Public methodgetColumnForIndexT
Returns a particular column for a particular index
Public methodgetColumnForIndexAsDoubles
Returns a particular column for a particular index as a double Array
Public methodgetColumnForIndexAsInts
Returns a particular column for a particular index as an int Array
Public methodgetColumnForIndexAsMatlabString
For a specified index, returns all the values in one column as a string. Column values can be separated by the separator string. For a column with the values 1 2 and 3, we can format them to return as: '1','2','3' (by passing , for separator and ' for a surrounder) or "1"|"2"|"3" (by passing | for separator and " for surrounder)
Public methodgetColumnForIndexAsStrings
Returns a particular column for a particular index as a string Array
Public methodgetColumnNames
Returns array with all column names
Public methodgetColumnTypes
Returns array with all column types
Public methodgetColumnTypesAsStrings
Public methodgetDotNetColumnTypes
Return array containing .NET types each column is best cast to
Public methodgetError
Get the exception this dataframe is storing, stored through the MarkException method. Call this if the dataframe has an error to find out what error it is
Public methodgetFSOD
Returns the FactSetOnDemand api object
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodgetIndices
Get an array with all the index groups
Public methodgetInput
Returns the input received from the server, pre-parse
Public methodgetNumberOfColumns
Returns the number of columns in this dataframe
Public methodgetNumberOfRows
Returns the number of rows in this dataframe
Public methodgetSummaryBuilder
Return the summarybuilder object that contains some data about the request
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodhasError
Returns true if this dataframe is storing an exception
Public methodisDoneParsing
Returns true if the dataframe is done
Public methodIsMatrixData
If the results downloaded by OnDemand servers state that the data contained in this DataFrame is Matrix-type data, this will be set to true
Public methodMarkException
Call to store an exception in the dataframe for future reference
Public methodParse(String)
Parse the dataframe
Public methodParse(String, ListString)
Parse the dataframe
Public methodParse(String, String)
Parse the dataframe
Public methodreceiveData
Public methodthrowErrorIfAnyIsPresent
Throw the error this dataframe is storing.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldfullyParsed
Indicates whether or not this dataframe is done collecting data and parsing.
Public fieldisDone
Indicates whether or not all processes associated with the dataframe are done, including post-factlet logging
Top
See Also