C# Class CsQuery.Engine.DomIndexRanged

A DOM index that can return a range of values. The IDomIndexRange interface is known to the selection engine; when availabile it will be use to optimize subqueries.

Inheritance: IDomIndex, IDomIndexSimple, IDomIndexRanged, IDomIndexQueue

Exibir arquivo Open project: prepare/HTML-Renderer

Private Properties

Property	Type	Description
ProcessQueue	void
QueueAddToIndex	void
QueueRemoveFromIndex	void
RangePath	ushort[]
RangePath	ushort[]
RangePath	ushort[]

Public Methods

Method	Description
AddToIndex ( IDomIndexedNode element ) : void	Add an element to the index using the default keys for this element.
AddToIndex ( ushort key, IDomIndexedNode element ) : void	Adds an element to the index for the specified key.
Clear ( ) : void	Clears this object to its blank/initial state.
DomIndexRanged ( ) : System	Default constructor.
QueryIndex ( ushort key ) : IEnumerable	Query the document's index.
QueryIndex ( ushort subKey, int depth, bool includeDescendants ) : IEnumerable	Query the document's index for a subkey up to a specific depth, optionally including descendants that match the selector.
RemoveFromIndex ( IDomIndexedNode element ) : void	Remove an element from the index.
RemoveFromIndex ( ushort key, IDomIndexedNode element ) : void	Remove an element from the index using its key.

Private Methods

Method	Description
ProcessQueue ( ) : void
QueueAddToIndex ( ushort key, IDomIndexedNode element ) : void	Add an element to the index using a specified index key.
QueueRemoveFromIndex ( ushort key ) : void
RangePath ( ushort path ) : ushort[]	Return the default selection key
RangePath ( ushort key, IDomIndexedNode element ) : ushort[]	Convert a key/path combination to a path suitable for view selection.
RangePath ( ushort key, ushort path ) : ushort[]	Convert a key/path combination to a path suitable for view selection.

Method Details

AddToIndex() public method

Add an element to the index using the default keys for this element.

public AddToIndex ( IDomIndexedNode element ) : void
element	IDomIndexedNode	/// The element to add ///
return	void

AddToIndex() public method

Adds an element to the index for the specified key.

public AddToIndex ( ushort key, IDomIndexedNode element ) : void
key	ushort	/// The key to remove. ///
element	IDomIndexedNode	/// The element to add. ///
return	void

Clear() public method

Clears this object to its blank/initial state.

public Clear ( ) : void
return	void

DomIndexRanged() public method

Default constructor.

public DomIndexRanged ( ) : System
return	System

QueryIndex() public method

Query the document's index.

public QueryIndex ( ushort key ) : IEnumerable
key	ushort	/// The key to seek. ///
return	IEnumerable

QueryIndex() public method

Query the document's index for a subkey up to a specific depth, optionally including descendants that match the selector.

public QueryIndex ( ushort subKey, int depth, bool includeDescendants ) : IEnumerable
subKey	ushort	/// The key or subkey to match. If this is a partial key, all keys matching this part will be /// returned. ///
depth	int	/// The zero-based depth to which searches should be limited. ///
includeDescendants	bool	/// When true, descendants of matching keys will be returned ///
return	IEnumerable

RemoveFromIndex() public method

Remove an element from the index.

public RemoveFromIndex ( IDomIndexedNode element ) : void
element	IDomIndexedNode	/// The element to remove ///
return	void

RemoveFromIndex() public method

Remove an element from the index using its key.

public RemoveFromIndex ( ushort key, IDomIndexedNode element ) : void
key	ushort	/// The key to remove. ///
element	IDomIndexedNode	/// The element to remove; this is ignored fort IDomIndexRange because it is identified by the key. ///
return	void