DataSourcePathSegmentData Class

Ankiro Enterprise Suite Reference Documentation

Represents a segment in a data source hierarchy. A data source hierarchy is a structure exposed by data sources external to the Ankiro Suite, such as a content management system or a web site. To create a data source hierarchy one can either manually synchronize the entire hierarchy through the ManagementService or by processing the documents of the hiearchy in a top down manner.

Inheritance Hierarchy

System Object
Ankiro.SearchServer.Data DataSourcePathSegmentData

Namespace: Ankiro.SearchServer.Data
Assembly: Ankiro.SearchServer.Data (in Ankiro.SearchServer.Data.dll) Version: 1.13.770.19207 (1.13.770.19207)

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class DataSourcePathSegmentData : IExtensibleDataObject, 
	IComparable<DataSourcePathSegmentData>, IEquatable<DataSourcePathSegmentData>

[SerializableAttribute]
public class DataSourcePathSegmentData : IExtensibleDataObject, 
	IComparable<DataSourcePathSegmentData>, IEquatable<DataSourcePathSegmentData>

The DataSourcePathSegmentData type exposes the following members.

Constructors

	Name	Description
	DataSourcePathSegmentData	Initializes a new instance of the DataSourcePathSegmentData class

Top

Methods

	Name	Description
	CompareTo
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Equals(DataSourcePathSegmentData)
	GetChildByForeignId
	GetHashCode	(Overrides Object GetHashCode .)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasChanged
	ShallowClone
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	TraverseBreadthFirst

Top

Properties

	Name	Description
	Children
	EffectiveIncludeState	Specifies the effective include state of the path segment, taking ancestors and inheritance hierarchy into account. This value will always be either Include or Exclude.
	EffectiveWeight	Specifies the effective static document weight of the path segment, taking ancestors into account. This value will always be a number in the interval [0.0-1.0].
	ExtensionData
	ForeignId	The ForeignId is a unique identifier used by an external data source to identify a segment/node in the hierarchy.
	ForeignLabel	The ForeignLabel is the label used by an external data source as display name. Unlike ForeignId, the label does not have to be unique within the tree.
	IncludeState	Controls index inclusion of the path segment or path segment sub-tree. This value may be null, in which case the value defaults to 'Inherit'. If no path segments (not even the root segment) specify an inclusion state, path segments defaults to 'Include'. Include state controls whether documents belonging to a path segment are included in an associated index or not.
	ParentForeignId	The ParentForeignId is the ForeignId identifier of the parent in the hierarchy.
	Rules
	Weight	Controls static document weight in the interval [0.0-1.0] of documents belonging to a path segment sub-tree. This value may be null, in which case the value defaults to 1.0. If no path segments (not even the root segment) specify a weight, path segments defaults to 1.0. Static document weight is used as one of the factors taking into account in the process of document ranking during the search process. Documents that have a statically higher weight are more likely to be returned at the top of search results.

Top