Interface IDatasetProcessor

A processor used for loading and processing a IDataset from the UI across multiple views in a consistent manner

See https://web.lemonedge.com/help/datasets/ for more information

Inherited Members
System.IDisposable.Dispose()
Namespace: LemonEdge.API.Processors
Assembly: API.dll
Syntax
public interface IDatasetProcessor : IBaseDataSetProcessorWithDBSave, IBaseDataSetProcessor, IProcessor, IDisposable

Properties

Dataset

The root dataset item this processor is responsible for

Declaration
IDataset Dataset { get; }
Property Value
Type Description
IDataset

DatasetQueryableItems

The list of items that are being queried by this dataset

Declaration
IEnumerable<IDatasetQueryableItem> DatasetQueryableItems { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IDatasetQueryableItem>

FieldInfos

The list of field info records that describe what produced a specified column ISQLTypeWrapper record.

This links the queryable item field GetFields(IReadOnlyCache) to the corrosponding column holding the value result

Declaration
IEnumerable<IDatasetQueryableItemFieldInfo> FieldInfos { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IDatasetQueryableItemFieldInfo>

Filters

A list of all the filter records to be applied to the dataset results

Declaration
IEnumerable<IFilterDescriptor> Filters { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IFilterDescriptor>

Wrapper

The ISQLWrapper that backs this dataset and holds the automatically created sql

Declaration
ISQLWrapper Wrapper { get; }
Property Value
Type Description
ISQLWrapper

Methods

GetQueryableItem(Guid)

Returns an instance of the actual queryable item for the specified IDatasetQueryableItem

Declaration
IQueryableItem GetQueryableItem(Guid forDataSourceQueryableItemID)
Parameters
Type Name Description
System.Guid forDataSourceQueryableItemID

The IDatasetQueryableItem to return an instance of the actual queryable item for
Returns
Type Description
IQueryableItem

An instance of the actual queryable item for the specified IDatasetQueryableItem

GetQueryableItemFields(Guid)

Returns all the possible field items for the specified IDatasetQueryableItem

Declaration
IEnumerable<IQueryableFieldInfo> GetQueryableItemFields(Guid forDataSourceQueryableItemID)
Parameters
Type Name Description
System.Guid forDataSourceQueryableItemID

The IDatasetQueryableItem to return all the possible field items for
Returns
Type Description
System.Collections.Generic.IEnumerable<IQueryableFieldInfo>

All the possible field items for the specified IDatasetQueryableItem

GetQueryableItemParams(Guid)

Returns all the possible parameters for the specified IDatasetQueryableItem

Declaration
IEnumerable<IQueryableParamInfo> GetQueryableItemParams(Guid forDataSourceQueryableItemID)
Parameters
Type Name Description
System.Guid forDataSourceQueryableItemID

The IDatasetQueryableItem to return all the possible parameters for
Returns
Type Description
System.Collections.Generic.IEnumerable<IQueryableParamInfo>

All the possible parameters for the specified IDatasetQueryableItem

GetTotalQueriedEntities()

Returns all the entities that are queried in this dataset and any sub-datasets

Declaration
IEnumerable<EntityDescriptor> GetTotalQueriedEntities()
Returns
Type Description
System.Collections.Generic.IEnumerable<EntityDescriptor>

All the entities that are queried in this dataset and any sub-datasets

GetWrapperTypes(SQLTypeWrapperType)

Returns the collection of ISQLTypeWrapper that are for the parameters or column results of this dataset (and thus in turn the ISQLWrapper itself)

Declaration
IEnumerable<ISQLTypeWrapper> GetWrapperTypes(SQLTypeWrapperType type)
Parameters
Type Name Description
SQLTypeWrapperType type

The type of sql type wrappers to return - either for the parameters or columns
Returns
Type Description
System.Collections.Generic.IEnumerable<ISQLTypeWrapper>

The collection of ISQLTypeWrapper that are for the parameters or column results of this dataset

Joins(Guid)

A list of all the join records (where TargetDatasetQueryableItemID equals forDataSetQueryableItemID) for the specified IDatasetQueryableItem

Declaration
IEnumerable<IDatasetQueryableItemJoin> Joins(Guid forDataSetQueryableItemID)
Parameters
Type Name Description
System.Guid forDataSetQueryableItemID

The IDatasetQueryableItem to return all join records for
Returns
Type Description
System.Collections.Generic.IEnumerable<IDatasetQueryableItemJoin>

A list of all the join records (where TargetDatasetQueryableItemID equals forDataSetQueryableItemID) for the specified IDatasetQueryableItem

OnAddFieldInfo(IDatasetQueryableItemFieldInfo)

Adds the specified queryable item field info record to this dataset

Declaration
void OnAddFieldInfo(IDatasetQueryableItemFieldInfo item)
Parameters
Type Name Description
IDatasetQueryableItemFieldInfo item

The queryable item field info to add to this dataset

OnAddFilter(IFilterDescriptor)

Adds the specified filter descriptor to this dataset

Declaration
void OnAddFilter(IFilterDescriptor filter)
Parameters
Type Name Description
IFilterDescriptor filter

OnAddJoin(IDatasetQueryableItemJoin)

Adds the specified queryable item join record to this dataset

Declaration
void OnAddJoin(IDatasetQueryableItemJoin item)
Parameters
Type Name Description
IDatasetQueryableItemJoin item

The queryable item join to add to this dataset

OnAddQueryableItem(IDatasetQueryableItem)

Adds the specified queryable item record to this dataset

Declaration
Task OnAddQueryableItem(IDatasetQueryableItem item)
Parameters
Type Name Description
IDatasetQueryableItem item

The queryable item to add to this dataset
Returns
Type Description
System.Threading.Tasks.Task

A task indicating the completion of the operation

OnAddWrapperType(ISQLTypeWrapper)

Adds the specified sql wrapper type record, of either a column or parameter, for the dataset and thus the underlying sqlwrapper too

Declaration
void OnAddWrapperType(ISQLTypeWrapper item)
Parameters
Type Name Description
ISQLTypeWrapper item

The sql type wrapper record for a column or parameter of this dataset

OnDeleteFieldInfo(IDatasetQueryableItemFieldInfo)

Deletes the specified queryable item field info record from this dataset

Declaration
void OnDeleteFieldInfo(IDatasetQueryableItemFieldInfo item)
Parameters
Type Name Description
IDatasetQueryableItemFieldInfo item

The queryable item field info to remove from this dataset

OnDeleteFilter(IFilterDescriptor)

Deletes the specified filter descriptor from this dataset

Declaration
void OnDeleteFilter(IFilterDescriptor filter)
Parameters
Type Name Description
IFilterDescriptor filter

OnDeleteJoin(IDatasetQueryableItemJoin)

Deletes the specified queryable item join record from this dataset

Declaration
void OnDeleteJoin(IDatasetQueryableItemJoin item)
Parameters
Type Name Description
IDatasetQueryableItemJoin item

The queryable item join to remove from this dataset

OnDeleteQueryableItem(IDatasetQueryableItem)

Deletes the specified queryable item record from this dataset

Declaration
void OnDeleteQueryableItem(IDatasetQueryableItem item)
Parameters
Type Name Description
IDatasetQueryableItem item

The queryable item to remove from this dataset

OnDeleteWrapperType(ISQLTypeWrapper)

Deletes the specified sql wrapper type record, of either a column or parameter, from the dataset and thus the underlying sqlwrapper too

Declaration
void OnDeleteWrapperType(ISQLTypeWrapper item)
Parameters
Type Name Description
ISQLTypeWrapper item

The sql type wrapper record for a column or parameter of this dataset

Events

OnEventOccured

Raises an event when changes to the processor occur

Declaration
event DatasetProcessorEventHandler OnEventOccured
Event Type
Type Description
DatasetProcessorEventHandler

Extension Methods

See Also