Class JsonPropertyIndexValueFactoryBase<TSerialized>

Abstract base for property index value factories where the value is json.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Core.dll

Syntax

public abstract class JsonPropertyIndexValueFactoryBase<TSerialized> : IPropertyIndexValueFactory

Type Parameters

Name	Description
TSerialized	The type to deserialize the json to.

Constructors

View Source

JsonPropertyIndexValueFactoryBase(IJsonSerializer)

Constructor for the JsonPropertyIndexValueFactoryBase.

Declaration

protected JsonPropertyIndexValueFactoryBase(IJsonSerializer jsonSerializer)

Parameters

Type	Name	Description
IJsonSerializer	jsonSerializer

View Source

JsonPropertyIndexValueFactoryBase(IJsonSerializer, IOptionsMonitor<IndexingSettings>)

Constructor for the JsonPropertyIndexValueFactoryBase.

Declaration

protected JsonPropertyIndexValueFactoryBase(IJsonSerializer jsonSerializer, IOptionsMonitor<IndexingSettings> indexingSettings)

Parameters

Type	Name	Description
IJsonSerializer	jsonSerializer
IOptionsMonitor<IndexingSettings>	indexingSettings

Properties

View Source

ForceExplicitlyIndexEachNestedProperty

Declaration

protected bool ForceExplicitlyIndexEachNestedProperty { get; set; }

Property Value

Type	Description
System.Boolean

Methods

View Source

GetIndexValues(IProperty, String, String, Boolean)

Declaration

public IEnumerable<KeyValuePair<string, IEnumerable<object>>> GetIndexValues(IProperty property, string culture, string segment, bool published)

Parameters

Type	Name	Description
IProperty	property
System.String	culture
System.String	segment
System.Boolean	published

Returns

Type	Description
IEnumerable<KeyValuePair<System.String, IEnumerable<System.Object>>>

View Source

GetIndexValues(IProperty, String, String, Boolean, IEnumerable<String>)

Gets the index values for a property.

Declaration

public IEnumerable<KeyValuePair<string, IEnumerable<object>>> GetIndexValues(IProperty property, string culture, string segment, bool published, IEnumerable<string> availableCultures)

Parameters

Type	Name	Description
IProperty	property
System.String	culture
System.String	segment
System.Boolean	published
IEnumerable<System.String>	availableCultures

Returns

Type	Description
IEnumerable<KeyValuePair<System.String, IEnumerable<System.Object>>>

Remarks

Returns key-value pairs, where keys are indexed field names. By default, that would be the property alias, and there would be only one pair, but some implementations (see for instance the grid one) may return more than one pair, with different indexed field names.

And then, values are an enumerable of objects, because each indexed field can in turn have multiple values. By default, there would be only one object: the property value. But some implementations may return more than one value for a given field.

View Source

Handle(TSerialized, IProperty, String, String, Boolean)

Method that handle the deserialized object.

Declaration

protected abstract IEnumerable<KeyValuePair<string, IEnumerable<object>>> Handle(TSerialized deserializedPropertyValue, IProperty property, string culture, string segment, bool published)

Parameters

Type	Name	Description
TSerialized	deserializedPropertyValue
IProperty	property
System.String	culture
System.String	segment
System.Boolean	published

Returns

Type	Description
IEnumerable<KeyValuePair<System.String, IEnumerable<System.Object>>>

View Source

Handle(TSerialized, IProperty, String, String, Boolean, IEnumerable<String>)

Method that handle the deserialized object.

Declaration

protected virtual IEnumerable<KeyValuePair<string, IEnumerable<object>>> Handle(TSerialized deserializedPropertyValue, IProperty property, string culture, string segment, bool published, IEnumerable<string> availableCultures)

Parameters

Type	Name	Description
TSerialized	deserializedPropertyValue
IProperty	property
System.String	culture
System.String	segment
System.Boolean	published
IEnumerable<System.String>	availableCultures

Returns

Type	Description
IEnumerable<KeyValuePair<System.String, IEnumerable<System.Object>>>

View Source

HandleResume(List<KeyValuePair<String, IEnumerable<Object>>>, IProperty, String, String, Boolean)

Method to return a list of summary of the content. By default this returns an empty list

Declaration

protected virtual IEnumerable<KeyValuePair<string, IEnumerable<object>>> HandleResume(List<KeyValuePair<string, IEnumerable<object>>> result, IProperty property, string culture, string segment, bool published)

Parameters

Type	Name	Description
List<KeyValuePair<System.String, IEnumerable<System.Object>>>	result
IProperty	property
System.String	culture
System.String	segment
System.Boolean	published

Returns

Type	Description
IEnumerable<KeyValuePair<System.String, IEnumerable<System.Object>>>