Interface ISeedRootContext

Represents the context in which ISeed can have parent-child relationships.

Namespace: Snowflake.Scraping

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface ISeedRootContext

Properties

Item[Guid]

Returns the seed with the given GUID. If it does not exists, returns null.

Declaration

ISeed this[Guid seedGuid] { get; }

Parameters

Type	Name	Description
System.Guid	seedGuid	The GUID of the seed.

Property Value

Type	Description
ISeed	The seed with the given GUID if it exists within the context, otherwise the root seed.

Root

Gets the root of the context where all seeds are attached to

Declaration

ISeed Root { get; }

Property Value

Type	Description
ISeed

SeedCollectionGuid

Gets a unique ID identifying this context. The Root will have a Parent value of SeedCollectionGuid

Declaration

Guid SeedCollectionGuid { get; }

Property Value

Type	Description
System.Guid

Methods

Add(ISeed)

Adds a seed directly to the context.

Declaration

void Add(ISeed seed)

Parameters

Type	Name	Description
ISeed	seed	The seed to add to the context.

Add(SeedContent, ISeed, String)

Adds a seed to the context.

Declaration

ISeed Add(SeedContent value, ISeed parent, string source)

Parameters

Type	Name	Description
SeedContent	value	The seed content of the seed.
ISeed	parent	The parent of the seed.
System.String	source	The source of the seed.

Returns

Type	Description
ISeed	The newly created seed with the given value and a parent relative to this context.

AddRange(IEnumerable<ISeed>)

Adds multiple seeds directly to the context.

Declaration

void AddRange(IEnumerable<ISeed> seeds)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ISeed>	seeds	The seeds to add directly to the context.

AddRange(IEnumerable<(SeedContent value, ISeed parent)>, String)

Adds multiple seeds to the context.

Declaration

IEnumerable<ISeed> AddRange(IEnumerable<(SeedContent value, ISeed parent)> seeds, string source)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.ValueTuple<SeedContent, ISeed>>	seeds	The values of the seeds to add.
System.String	source	The source of the seed.

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISeed>	The newly created seeds with the given value and a parent relative to this context.

CullSeedTree(ISeed)

Culls the given seed and all of its descendants.

Declaration

void CullSeedTree(ISeed seed)

Parameters

Type	Name	Description
ISeed	seed	The seed to cull.

GetAll()

Gets all the seeds in this context, whether culled or unculled.

Declaration

IEnumerable<ISeed> GetAll()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISeed>	All the seed in this context.

GetAllOfType(String)

Gets all the unculled seeds of the given type that exist in this context.

Declaration

IEnumerable<ISeed> GetAllOfType(string type)

Parameters

Type	Name	Description
System.String	type	The semantic type of the seed.

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISeed>	All seeds with the given type that exist in the context.

GetChildren(ISeed)

Gets all the unculled children of the given seed relative to this context, not including the given seed.

Declaration

IEnumerable<ISeed> GetChildren(ISeed seed)

Parameters

Type	Name	Description
ISeed	seed	The seed of which whose children are returned.

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISeed>	All the children of the given seed relative to this context.

GetDescendants(ISeed)

Gets all the unculled descendants of a given seed.

Declaration

IEnumerable<ISeed> GetDescendants(ISeed seed)

Parameters

Type	Name	Description
ISeed	seed	The seed whose descendants are returned.

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISeed>	All the descendants of the given seed.

GetRootSeeds()

Gets all the unculled children of the root.

Declaration

IEnumerable<ISeed> GetRootSeeds()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISeed>	All the children of the root.

GetSiblings(ISeed)

Gets all the unculled siblings of the given seed relative to this context, not including the given seed.

Declaration

IEnumerable<ISeed> GetSiblings(ISeed seed)

Parameters

Type	Name	Description
ISeed	seed	The seed of which whose siblings are returned.

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISeed>	All the siblings of the given seed relative to this context.

GetUnculled()

Gets seeds that have not been marked as culled in this context.

Declaration

IEnumerable<ISeed> GetUnculled()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISeed>	All the seed in this context that have not been marked as culled.