Interface IDataSetProcessor

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

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

Inherited Members

IBaseDataSetProcessorWithDBSave.ProcessOnDBSave()

IBaseDataSetProcessorWithDBSave.RollbackChanges()

IBaseDataSetProcessorWithDBSave.SaveProcessed

IBaseDataSetProcessorWithDBSave.Order

IBaseDataSetProcessor.IsChangedItemPartOfDataSet(IBaseEntity)

IBaseDataSetProcessor.AddToDataSetToProcess(IBaseEntity, EntityOperation)

IBaseDataSetProcessor.Load()

IBaseDataSetProcessor.IgnoreEvents

IBaseDataSetProcessor.Loaded

IProcessor.Updater

IProcessor.Cache

IProcessor.User

IProcessor.Reporter

IDisposable.Dispose()

Namespace: LemonEdge.API.Core.Processors

Assembly: LemonEdge.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

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
IEnumerable<IDatasetQueryableItemFieldInfo>

Wrapper

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

Declaration

ISQLWrapper Wrapper { get; }

Property Value

Type	Description
ISQLWrapper

Methods

AllDatasetQueryableItems()

Declaration

IEnumerable<IDatasetQueryableItem> AllDatasetQueryableItems()

Returns

Type	Description
IEnumerable<IDatasetQueryableItem>

BelongsToDatasetQueryableItemSet(IFilterDescriptor, IDatasetQueryableItem)

Declaration

bool BelongsToDatasetQueryableItemSet(IFilterDescriptor desc, IDatasetQueryableItem item)

Parameters

Type	Name	Description
IFilterDescriptor	desc
IDatasetQueryableItem	item

Returns

Type	Description
bool

BelongsToDatasetQueryableItemSet(ISQLTypeWrapper, IDatasetQueryableItem)

Declaration

bool BelongsToDatasetQueryableItemSet(ISQLTypeWrapper typeWrapper, IDatasetQueryableItem item)

Parameters

Type	Name	Description
ISQLTypeWrapper	typeWrapper
IDatasetQueryableItem	item

Returns

Type	Description
bool

GetColumns(IDatasetQueryableItem)

Declaration

IEnumerable<ISQLTypeWrapper> GetColumns(IDatasetQueryableItem forRoot)

Parameters

Type	Name	Description
IDatasetQueryableItem	forRoot

Returns

Type	Description
IEnumerable<ISQLTypeWrapper>

GetDatasetQueryableItemRoots()

Declaration

IEnumerable<IDatasetQueryableItem> GetDatasetQueryableItemRoots()

Returns

Type	Description
IEnumerable<IDatasetQueryableItem>

GetDatasetQueryableItems(IDatasetQueryableItem)

Declaration

IEnumerable<IDatasetQueryableItem> GetDatasetQueryableItems(IDatasetQueryableItem parent)

Parameters

Type	Name	Description
IDatasetQueryableItem	parent

Returns

Type	Description
IEnumerable<IDatasetQueryableItem>

GetFilters(Guid?)

Declaration

IEnumerable<IFilterDescriptor> GetFilters(Guid? datasetQueryableItemID)

Parameters

Type	Name	Description
Guid?	datasetQueryableItemID

Returns

Type	Description
IEnumerable<IFilterDescriptor>

GetFirstRootQueryableItem()

Declaration

IDatasetQueryableItem GetFirstRootQueryableItem()

Returns

Type	Description
IDatasetQueryableItem

GetParameters()

Declaration

IEnumerable<ISQLTypeWrapper> GetParameters()

Returns

Type	Description
IEnumerable<ISQLTypeWrapper>

GetQueryableItem(Guid)

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

Declaration

IQueryableItem GetQueryableItem(Guid forDataSourceQueryableItemID)

Parameters

Type	Name	Description
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
Guid	forDataSourceQueryableItemID	The IDatasetQueryableItem to return all the possible field items for

Returns

Type	Description
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
Guid	forDataSourceQueryableItemID	The IDatasetQueryableItem to return all the possible parameters for

Returns

Type	Description
IEnumerable<IQueryableParamInfo>	All the possible parameters for the specified IDatasetQueryableItem

GetRootQueryableItem(IDatasetQueryableItem)

Declaration

IDatasetQueryableItem GetRootQueryableItem(IDatasetQueryableItem item)

Parameters

Type	Name	Description
IDatasetQueryableItem	item

Returns

Type	Description
IDatasetQueryableItem

GetSubEntities()

Declaration

IEnumerable<EntityDescriptor> GetSubEntities()

Returns

Type	Description
IEnumerable<EntityDescriptor>

GetSubQueries()

Returns all sub queries referenced directly by this dataset

Declaration

IEnumerable<SQLWrapperInterpretor> GetSubQueries()

Returns

Type	Description
IEnumerable<SQLWrapperInterpretor>

GetTotalQueriedEntities()

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

Declaration

IEnumerable<EntityDescriptor> GetTotalQueriedEntities()

Returns

Type	Description
IEnumerable<EntityDescriptor>	All the entities that are queried in this dataset and any sub-datasets

IsFirstRootQueryableItem(IDatasetQueryableItem)

Declaration

bool IsFirstRootQueryableItem(IDatasetQueryableItem item)

Parameters

Type	Name	Description
IDatasetQueryableItem	item

Returns

Type	Description
bool

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
Guid	forDataSetQueryableItemID	The IDatasetQueryableItem to return all join records for

Returns

Type	Description
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(IDatasetQueryableItem, IFilterDescriptor)

Adds the specified filter descriptor to this dataset

Declaration

void OnAddFilter(IDatasetQueryableItem rootItem, IFilterDescriptor filter)

Parameters

Type	Name	Description
IDatasetQueryableItem	rootItem
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<int> OnAddQueryableItem(IDatasetQueryableItem item)

Parameters

Type	Name	Description
IDatasetQueryableItem	item	The queryable item to add to this dataset

Returns

Type	Description
Task<int>	A task indicating the completion of the operation

OnAddQueryableItem(IDatasetQueryableItem, bool)

Declaration

Task<int?> OnAddQueryableItem(IDatasetQueryableItem item, bool addDefaultJoins)

Parameters

Type	Name	Description
IDatasetQueryableItem	item
bool	addDefaultJoins

Returns

Type	Description
Task<int?>

OnAddWrapperType(IDatasetQueryableItem, 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(IDatasetQueryableItem rootItem, ISQLTypeWrapper item)

Parameters

Type	Name	Description
IDatasetQueryableItem	rootItem
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

UpdateAllUnionQueryableItemLinks()

Declaration

void UpdateAllUnionQueryableItemLinks()

UpdateColour(IDatasetQueryableItemFieldInfo)

Declaration

void UpdateColour(IDatasetQueryableItemFieldInfo item)

Parameters

Type	Name	Description
IDatasetQueryableItemFieldInfo	item

UpdateFiltersParentID(Guid, Guid, IFilterDescriptor)

Updates filters ParentID after copying the DatasetQueryableItems

Declaration

void UpdateFiltersParentID(Guid originalItemId, Guid copiedItemId, IFilterDescriptor filter)

Parameters

Type	Name	Description
Guid	originalItemId	Original DataSetQueryableItem's Id which is being copied
Guid	copiedItemId	Copied DatasetQueryableItem's Id
IFilterDescriptor	filter	The filter descriptor to add to this dataset

Events

OnEventOccured

Raises an event when changes to the processor occur

Declaration

event DatasetProcessorEventHandler OnEventOccured

Event Type

Type	Description
DatasetProcessorEventHandler

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)

See Also

IDataset