Class ProductIndexBuilder
- Namespace
- Dynamicweb.Ecommerce.Indexing
- Assembly
- Dynamicweb.Ecommerce.dll
The class ProductIndexBuilder represents index builder for products
public class ProductIndexBuilder : IndexBuilderBase, IIndexBuilder, IResumable, IIndexBuilderSchemaUpdater
- Inheritance
-
ProductIndexBuilder
- Implements
- Inherited Members
Properties
BulkSize
[AddInParameter("BulkSize")]
[AddInLabel("Bulk size")]
[AddInParameterEditor(typeof(NumberParameterEditor), "")]
public int BulkSize { get; set; }
Property Value
DefaultSettings
Gets default settings collection
public override IDictionary<string, object> DefaultSettings { get; }
Property Value
DoNotAnalyzeDefaultFields
[AddInParameter("DoNotAnalyzeDefaultFields")]
[AddInLabel("Do not analyze default fields")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool DoNotAnalyzeDefaultFields { get; set; }
Property Value
DoNotFailOnMismatchingProductCount
[AddInParameter("DoNotFailOnMismatchingProductCount")]
[AddInLabel("Do not fail on mismatching product count")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool DoNotFailOnMismatchingProductCount { get; set; }
Property Value
DoNotStoreDefaultFields
[AddInParameter("DoNotStoreDefaultFields")]
[AddInLabel("Do not store default fields")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool DoNotStoreDefaultFields { get; set; }
Property Value
EmptyStringReplacement
[AddInParameter("EmptyStringReplacement")]
[AddInLabel("Empty string replacement")]
[AddInParameterEditor(typeof(TextParameterEditor), "")]
public string EmptyStringReplacement { get; set; }
Property Value
HandleInheritedCategoryValues
[AddInParameter("HandleInheritedCategoryValues")]
[AddInLabel("Handle inherited category values")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool HandleInheritedCategoryValues { get; set; }
Property Value
HoursToUpdate
[AddInParameter("HoursToUpdate")]
[AddInLabel("Hours to update")]
[AddInParameterEditor(typeof(NumberParameterEditor), "")]
public int HoursToUpdate { get; set; }
Property Value
MaxProductsToIndex
[AddInParameter("MaxProductsToIndex")]
[AddInLabel("Max products to index")]
[AddInParameterEditor(typeof(NumberParameterEditor), "")]
public int MaxProductsToIndex { get; set; }
Property Value
OnlyIndexActiveProducts
[AddInParameter("OnlyIndexActiveProducts")]
[AddInLabel("Only index active products")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool OnlyIndexActiveProducts { get; set; }
Property Value
ProductIDs
Gets or sets a list of product ids, which will be updated in the index
public IEnumerable<string> ProductIDs { get; set; }
Property Value
Resume
Gets or sets a value indicating the index opened in insert mode
public bool Resume { get; set; }
Property Value
ShopsToIndex
[AddInParameter("ShopsToIndex")]
[AddInLabel("Shops to index")]
[AddInParameterEditor(typeof(TextParameterEditor), "")]
public string ShopsToIndex { get; set; }
Property Value
SkipAllExtendedFields
[AddInParameter("SkipAllExtendedFields")]
[AddInLabel("Skip all extended fields")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipAllExtendedFields { get; set; }
Property Value
SkipAssortments
[AddInParameter("SkipAssortments")]
[AddInLabel("Skip assortment fields")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipAssortments { get; set; }
Property Value
SkipCampaign
[AddInParameter("SkipCampaign")]
[AddInLabel("Skip campaign fields")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipCampaign { get; set; }
Property Value
SkipCategoryFields
[AddInParameter("SkipCategoryFields")]
[AddInLabel("Skip category fields")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipCategoryFields { get; set; }
Property Value
SkipDetailImages
[AddInParameter("SkipDetailImages")]
[AddInLabel("Skip detail images")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipDetailImages { get; set; }
Property Value
SkipExtenders
[AddInParameter("SkipExtenders")]
[AddInLabel("Skip extenders")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipExtenders { get; set; }
Property Value
SkipGrouping
[AddInParameter("SkipGrouping")]
[AddInLabel("Skip grouping")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipGrouping { get; set; }
Property Value
SkipGroupSorting
[AddInParameter("SkipGroupSorting")]
[AddInLabel("Skip group sorting")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipGroupSorting { get; set; }
Property Value
SkipImagePatternImages
[AddInParameter("SkipImagePatternImages")]
[AddInLabel("Skip image pattern images")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipImagePatternImages { get; set; }
Property Value
SkipImages
[AddInParameter("SkipImages")]
[AddInLabel("Skip images")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipImages { get; set; }
Property Value
SkipOrderhistory
[AddInParameter("SkipOrderhistory")]
[AddInLabel("Skip order history fields")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipOrderhistory { get; set; }
Property Value
SkipPrices
[AddInParameter("SkipPrices")]
[AddInLabel("Skip prices")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipPrices { get; set; }
Property Value
SkipRelatedProducts
[AddInParameter("SkipRelatedProducts")]
[AddInLabel("Skip related products")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipRelatedProducts { get; set; }
Property Value
SupportedActions
Gets the supported actions
public override IEnumerable<string> SupportedActions { get; }
Property Value
Methods
Build(IIndexWriter, Tracker)
Build the index
public override void Build(IIndexWriter writer, Tracker tracker)
Parameters
writer
IIndexWriter- An IIndexWriter instance
tracker
Tracker- A Tracker instance
GetFields()
Defines GetFields required operation
public override IEnumerable<FieldDefinitionBase> GetFields()
Returns
UpdateSchema(SchemaDefinition)
Updates the selected schema according to builder settings
public void UpdateSchema(SchemaDefinition schema)
Parameters
schema
SchemaDefinition- Selected schema