Class DescriptorProperty

Fluent API addition for simplifying the process of adding features and labels to a descriptor.

Inheritance

System.Object

DescriptorProperty

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace:numl.Model

Assembly:numl.dll

Syntax

public class DescriptorProperty

Methods

View Source

As(Property)

Adds the specified property to the descriptor with the chained name

Declaration

public Descriptor As(Property property)

Parameters

Type	Name	Description
Property	property	The property.

Returns

Type	Description
Descriptor	descriptor with added property

View Source

As(Type)

Adds property to descriptor with chained name and type.

Declaration

public Descriptor As(Type type)

Parameters

Type	Name	Description
System.Type	type	Property Type.

Returns

Type	Description
Descriptor	descriptor with added property.

View Source

AsCharEnum()

Adds a string property with character segmentation treated as enumerations to the descriptor.

Declaration

public Descriptor AsCharEnum()

Returns

Type	Description
Descriptor	Descriptor.

View Source

AsDateTime(DatePortion)

Adds DateTime property to descriptor with previously chained name.

Declaration

public Descriptor AsDateTime(DatePortion portion)

Parameters

Type	Name	Description
DatePortion	portion	Which date portions to use (can pipe: DateTimeFeature.Year \| DateTimeFeature.DayOfWeek)

Returns

Type	Description
Descriptor	descriptor with added property.

Exceptions

Type	Condition
DescriptorException	Thrown when a Descriptor error condition occurs.

View Source

AsDateTime(DateTimeFeature)

Adds DateTime property to descriptor with previously chained name.

Declaration

public Descriptor AsDateTime(DateTimeFeature features)

Parameters

Type	Name	Description
DateTimeFeature	features	Which date features to use (can pipe: DateTimeFeature.Year \| DateTimeFeature.DayOfWeek)

Returns

Type	Description
Descriptor	descriptor with added property.

Exceptions

Type	Condition
DescriptorException	Thrown when a Descriptor error condition occurs.

View Source

AsEnumerable(Int32)

Adds Enumerable property to descriptor with previousy chained name.

Declaration

public Descriptor AsEnumerable(int length)

Parameters

Type	Name	Description
System.Int32	length	length of enumerable to expand.

Returns

Type	Description
Descriptor	descriptor with added property.

Exceptions

Type	Condition
DescriptorException	Thrown when a Descriptor error condition occurs.

View Source

AsGuid()

Adds guid property to descriptor with previously chained name.

Declaration

public Descriptor AsGuid()

Returns

Type	Description
Descriptor	descriptor with added property.

View Source

AsString()

Adds the default string property to descriptor with previously chained name.

Declaration

public Descriptor AsString()

Returns

Type	Description
Descriptor	descriptor with added property.

View Source

AsString(StringSplitType, String, String)

Adds string property to descriptor with previously chained name.

Declaration

public Descriptor AsString(StringSplitType splitType, string separator = " ", string exclusions = null)

Parameters

Type	Name	Description
StringSplitType	splitType	How to split string.
System.String	separator	(Optional) Separator to use.
System.String	exclusions	(Optional) file describing strings to exclude.

Returns

Type	Description
Descriptor	descriptor with added property.

View Source

AsStringEnum()

Adds string property to descriptor with previously chained name.

Declaration

public Descriptor AsStringEnum()

Returns

Type	Description
Descriptor	descriptor with added property.

View Source

Use(Func<Object, Double>)

Not ready.

Declaration

public Descriptor Use(Func<object, double> conversion)

Parameters

Type	Name	Description
System.Func<System.Object, System.Double>	conversion	Conversion method.

Returns

Type	Description
Descriptor	Descriptor.

Exceptions

Type	Condition
System.NotImplementedException	Thrown when the requested operation is unimplemented.