Type
pentaho.type.Property.Type
The type of a property of a complex type.
A property type only exists within a complex type.
See also: pentaho.type.Complex
Extends
Implements
Constructor
Name | Description |
---|---|
new Type() Static Abstract | Creates a property type object. |
Members
Name | Description |
---|---|
_isLabelSet : Protected | Gets a value that indicates if the label is locally set. |
alias : | Gets the alias for the identifier of this type. |
ancestor : | Gets the parent type in the current type hierarchy, if any, or |
application : | Gets or sets the |
category : | Gets or sets the category associated with this type. |
context : | Gets the context that defined this type class. |
countMax : | Gets or sets the maximum number of elements that properties of this type can have. |
countMaxOn | Evaluates the value of the |
countMin : | Gets or sets the minimum number of elements that properties of this type must have. |
countMinOn | Evaluates the value of the |
declaringType : | Gets the complex type that declares this property type. |
defaultValue : | Gets or sets the default value of properties of this type. |
defaultView : | Gets or sets the default view for instances of this type. |
defaultViewAbs : | Gets the absolute view module identifier, if any. |
description : | Gets or sets the description of this type. |
domain : | Gets or sets the list of valid values (or a function that evaluates to these) of properties of this type. |
domainOn | Evaluates the value of the |
elemName : | Gets the singular name of |
elemType : | The base element type of the singular values that the property can hold. |
hasDescendants : | Gets a value that indicates if this type has any descendant types. |
helpUrl : | Gets or sets a URL pointing to documentation associated with this type. |
id : | Gets the identifier of this type. |
index : | Gets the index of the property in the containing complex type. |
inheritedStyleClasses : | Gets the style classes of this and any base types. |
instance : | Gets the prototype of the instances of this type. |
isAbstract : | Gets a value that indicates if this type is abstract. |
isAdvanced : | Gets or sets the |
isApplicable : | Gets or sets a value or function that indicates if properties of this type are applicable. |
isApplicableOn | Evaluates the value of the |
isBoundary : | Gets or sets whether the property is a boundary property. |
isBrowsable : | Gets or sets the |
isComplex : | |
isContainer : | Gets a value that indicates if this type |
isElement : | Gets a value that indicates if this type |
isEnabled : | Gets or sets a value, or function, that indicates if properties of this type can be changed by a user, in a user interface. |
isEnabledOn | Evaluates the value of the |
isList : | Gets a value that indicates if the property is a list. |
isProperty : | Gets a value that indicates if this type |
isReadOnly : | Gets or sets whether the value of properties of this type can be changed. |
isRequired : | Gets or sets a value that indicates if properties of this type are required. |
isRequiredOn | Evaluates the value of the |
isRoot : | Gets a value that indicates if this type is the root of its type hierarchy. |
isSimple : | |
isValue : | |
key : | Gets the key of the property. |
keyName : | Gets the singular name of |
label : | Gets or sets the label of this type. |
mixins : | Gets or sets the mixin types that are locally mixed into this type. |
name : | Gets or sets the name of the property type. |
nameAlias : | Gets or sets the alias for the name of the property type. |
ordinal : | Gets or sets the ordinal associated with this type. |
root : | Gets the root type of this type hierarchy. |
shortId : | Gets the short identifier of this type. |
sourceId : | Gets the source module identifier of this type. |
styleClass : | Gets or sets the CSS class associated with this type. |
uid : | Gets the unique identifier of this type. |
valueType : | Gets or sets the type of value that properties of this type can hold. |
Methods
Name | Description |
---|---|
_extend() Static | |
_collectElementValidators(addValidator, owner, value) Protected | Called each time a property value is validated to collect the list of element validators. |
_fillSpecInContext(spec, keyArgs) : boolean Protected | Fills the given specification with this type's attributes' local values, and returns whether any attribute was actually added. |
_getLabelDefault() : string Protected | Gets the default label of the property. |
_init(spec, keyArgs) Protected | Performs initialization tasks that take place before the instance is extended with its spec. |
_postInit(spec, keyArgs) Protected | Performs initialization tasks that take place after the instance is extended with its specification. |
_validateValueOn(owner, value) : pentaho.type.ValidationError | Array.< Protected | Validates the given non-null value in the context of this property. |
buildSourceRelativeId(id) : string | Builds an absolute module identifier from one that is relative to the type's |
countRangeOn(owner) : pentaho.IRange.< | Evaluates the element count range of a property of this type on a given complex value. |
create(instRef, instKeyArgs) : pentaho.type.Instance | Creates or resolves an instance of this type given an instance reference. |
createAsync(instRef, instKeyArgs) : Promise.< | Creates or resolves an instance of this type, asynchronously, given an instance reference. |
defaultValueOn(owner) : pentaho.type.Value | Gets a default value for use in a given |
is(value) : boolean | Determines if a value is an instance of this type. |
isSubtypeOf(superType) : boolean | Determines if this is a subtype of another. |
to(value, keyArgs) : pentaho.type.Instance | Converts a value to an instance of this type, if it is not one already. |
toJSON() : UJsonValue | Creates a JSON specification that describes this type. |
toRef(keyArgs) : pentaho.type.spec.UTypeReference | Returns a reference to this type. |
toRefInContext(keyArgs) : pentaho.type.spec.UTypeReference | Returns a reference to this type under a given specification context. |
toSpec(keyArgs) : pentaho.type.spec.ITypeProto | Creates a specification that describes this type. |
toSpecInContext(keyArgs) : pentaho.type.spec.ITypeProto | Creates a specification that describes this type. |
toString() : string | Returns a textual representation suitable to identify this type in an error message. |
toValueOn(defaultValueOwner, valueSpec) : pentaho.type.Value | Converts the given value or value specification to a value of this property's value type. |
validateOn(owner) : pentaho.type.ValidationError | Array.< | Determines if this property is valid on a given complex instance. |
Constructor Details
new Type() Static Abstract |
---|
Creates a property type object. Source: javascript/web/pentaho/type/property.js, line 38 See also: pentaho.type.Complex |
Members Details
_isLabelSet: Protected |
---|
Gets a value that indicates if the label is locally set. Source: javascript/web/pentaho/type/_type.js, line 640 Overrides: pentaho.type.mixins.DiscreteDomain.Type#_isLabelSet |
alias: |
---|
Gets the alias for the identifier of this type. The alias of a type can only be specified when extending the ancestor type. This attribute is not inherited. When unspecified, defaults to Source: javascript/web/pentaho/type/_type.js, line 503 Overrides: pentaho.type.mixins.DiscreteDomain.Type#alias See also: pentaho.type.Type#id |
ancestor: |
---|
Gets the parent type in the current type hierarchy, if any, or The root type returns Source: javascript/web/pentaho/type/_type.js, line 266 Overrides: pentaho.type.mixins.DiscreteDomain.Type#ancestor See also: pentaho.type.Type#root , pentaho.type.Type#hasDescendants |
application: |
---|
Gets or sets the The application property serves as a collection of properties specific to the container application that can be modified via the Setting this to a Source: javascript/web/pentaho/type/_type.js, line 658 Overrides: pentaho.type.mixins.DiscreteDomain.Type#application |
category: |
---|
Gets or sets the category associated with this type. The category is used primarily to group similar types (or instances of) in a user interface. Attempting to set to a non-string value type implicitly converts the value to a string before assignment. Setting this to Setting this to Source: javascript/web/pentaho/type/_type.js, line 727 Overrides: pentaho.type.mixins.DiscreteDomain.Type#category See also: pentaho.type.Type#isBrowsable , pentaho.type.Type#ordinal |
context: |
---|
Gets the context that defined this type class. |
countMax: |
---|
Gets or sets the maximum number of elements that properties of this type can have. A non-negative integer. Note that this attribute is taken together with the This attribute is DynamicWhen a dynamic attribute is set to a function, it can evaluate to a different value for each complex instance. When a dynamic attribute is set to a value other than a function or a This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type having a Because this attribute is also dynamic, the actual This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. The first set local value must respect the monotonicity property with the inherited value. Other characteristicsThe value got by the attribute is the last set local, value, if any - a function, a constant value; or, When set to a When set and the property already has The default (root) Source: javascript/web/pentaho/type/property.js, line 1214 See also: pentaho.type.Complex#countRangeOf , pentaho.type.spec.IPropertyTypeProto#countMax |
countMaxOn: |
---|
Evaluates the value of the This method is used to determine the effective Source: javascript/web/pentaho/type/property.js, line 1198 See also: pentaho.type.Property.Type#countMax |
countMin: |
---|
Gets or sets the minimum number of elements that properties of this type must have. A non-negative integer. Note that this attribute is taken together with the This attribute is DynamicWhen a dynamic attribute is set to a function, it can evaluate to a different value for each complex instance. When a dynamic attribute is set to a value other than a function or a This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type having a Because this attribute is also dynamic, the actual This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. The first set local value must respect the monotonicity property with the inherited value. Other characteristicsThe value got by the attribute is the last set local, value, if any - a function, a constant value or When set to a When set and the property already has The default (root) Source: javascript/web/pentaho/type/property.js, line 1128 See also: pentaho.type.Complex#countRangeOf , pentaho.type.spec.IPropertyTypeProto#countMin |
countMinOn: |
---|
Evaluates the value of the This method is used to determine the effective Source: javascript/web/pentaho/type/property.js, line 1112 See also: pentaho.type.Property.Type#countMin |
declaringType: |
---|
Gets the complex type that declares this property type. |
defaultValue: |
---|
Gets or sets the default value of properties of this type. The default value is the "prototype" value that properties of this type take, on complex instances, when the property is unspecified or specified as a The value This attribute is DynamicWhen a dynamic attribute is set to a function, it can evaluate to a different value for each complex instance. When a dynamic attribute is set to a value other than a function or a GetWhen got and the default value (local or inherited) is not an instance of the value type (local or inherited), SetWhen set and the property already has When set to When set to the control value
When set to a function, it is accepted. For each complex instance, the function is evaluated and its result converted to the property type's When set to any other value, it is immediately converted to the property type's |
defaultView: |
---|
Gets or sets the default view for instances of this type. The identifier of the view's AMD module. If the identifier is relative, it is relative to Setting this to Setting this to a falsy value (like Source: javascript/web/pentaho/type/_type.js, line 973 Overrides: pentaho.type.mixins.DiscreteDomain.Type#defaultView See also: pentaho.type.Type#buildSourceRelativeId |
defaultViewAbs: |
---|
Gets the absolute view module identifier, if any. A default view exists if property Source: javascript/web/pentaho/type/_type.js, line 1008 Overrides: pentaho.type.mixins.DiscreteDomain.Type#defaultViewAbs See also: pentaho.type.Type#defaultView |
description: |
---|
Gets or sets the description of this type. Attempting to set to a non-string value type implicitly converts the value to a string before assignment. Setting this to Setting this to Source: javascript/web/pentaho/type/_type.js, line 687 Overrides: pentaho.type.mixins.DiscreteDomain.Type#description |
domain: |
---|
Gets or sets the list of valid values (or a function that evaluates to these) of properties of this type. This attribute is DynamicWhen a dynamic attribute is set to a function, it can evaluate to a different value for each complex instance. When a dynamic attribute is set to a value other than a function, its value is the same for every complex instance. This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, the list of valid values can only be successfully reduced. When the Because this attribute is also dynamic, the actual This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. The first set local value must respect the monotonicity property with the inherited value. Other characteristicsThe value got by the attribute is the last set local, value, if any - a function, a constant value; or, When set to a When set and the property already has When the The last specified domain determines the order. Source: javascript/web/pentaho/type/mixins/discreteDomain.js, line 77 See also: pentaho.type.Complex#domainOf , pentaho.type.mixins.spec.IDiscreteDomainTypeProto#domain |
domainOn: |
---|
Evaluates the value of the Source: javascript/web/pentaho/type/mixins/discreteDomain.js, line 65 Inherited From: pentaho.type.mixins.DiscreteDomain.Type#domainOn See also: pentaho.type.Property.Type#domain |
elemName: |
---|
Gets the singular name of Source: javascript/web/pentaho/type/property.js, line 185 Default Value: "property" |
elemType: |
---|
The base element type of the singular values that the property can hold. When the property is a list property, that list type's element type, Otherwise, |
hasDescendants: |
---|
Gets a value that indicates if this type has any descendant types. Source: javascript/web/pentaho/type/_type.js, line 279 Overrides: pentaho.type.mixins.DiscreteDomain.Type#hasDescendants See also: pentaho.type.Type#ancestor |
helpUrl: |
---|
Gets or sets a URL pointing to documentation associated with this type. Attempting to set to a non-string value type implicitly converts the value to a string before assignment. Setting this to Setting this to |
id: |
---|
Gets the identifier of this type. The identifier of a type can only be specified when extending the ancestor type. The identifier is only defined for types which have an associated AMD/RequireJS module. However, note that all have a This attribute is not inherited. When unspecified, defaults to the value of Source: javascript/web/pentaho/type/_type.js, line 416 Overrides: pentaho.type.mixins.DiscreteDomain.Type#id See also: pentaho.type.Type#sourceId |
index: |
---|
Gets the index of the property in the containing complex type. |
inheritedStyleClasses: |
---|
Gets the style classes of this and any base types. The returned array should not be modified. Source: javascript/web/pentaho/type/_type.js, line 896 Overrides: pentaho.type.mixins.DiscreteDomain.Type#inheritedStyleClasses |
instance: |
---|
Gets the prototype of the instances of this type. |
isAbstract: |
---|
Gets a value that indicates if this type is abstract. This attribute can only be set once, upon the type definition. Source: javascript/web/pentaho/type/_type.js, line 526 Default Value: false Overrides: pentaho.type.mixins.DiscreteDomain.Type#isAbstract |
isAdvanced: |
---|
Gets or sets the Types with Setting this to a Source: javascript/web/pentaho/type/_type.js, line 830 Overrides: pentaho.type.mixins.DiscreteDomain.Type#isAdvanced See also: pentaho.type.Type#isBrowsable |
isApplicable: |
---|
Gets or sets a value or function that indicates if properties of this type are applicable. When a property is not (currently) applicable, then it does not apply, as it does not make sense in a certain situation. It may only be applicable when another property of the complex type has a specific value, for example. When a property is not currently applicable, its value is not significant and, as such, any validations concerning it are not performed. This attribute is DynamicWhen a dynamic attribute is set to a function, it can evaluate to a different value for each complex instance. When a dynamic attribute is set to a value other than a function or a This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type marked as applicable can later be marked as not applicable. However, a property type marked as not applicable can no longer go back to being applicable. Because this attribute is also dynamic, the actual This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. The first set local value must respect the monotonicity property with the inherited value. Other characteristicsThe value got by the attribute is the last set local, value, if any - a function, a constant value; or, When set to a When set and the property already has The default (root) Source: javascript/web/pentaho/type/property.js, line 1296 See also: pentaho.type.Property.Type#isRequired , pentaho.type.Complex#isApplicableOf , pentaho.type.spec.IPropertyTypeProto#isApplicable |
isApplicableOn: |
---|
Evaluates the value of the Source: javascript/web/pentaho/type/property.js, line 1284 See also: pentaho.type.Property.Type#isApplicable |
isBoundary: |
---|
Gets or sets whether the property is a boundary property. A boundary property identifies the limits of the aggregate of its If the value type is a The validity of the object with a boundary property is not affected by the validity of the property's value (or values). Also, changes within its value(s) do not bubble through it. Boundary properties do not cause their values to hold inverse references to the property holder. This means that, in objects connected by boundary properties, only the property holders prevent their values from being garbage collected, and not the other way round. On the contrary, non-boundary properties form object aggregates that can only be garbage-collected as a whole. GetThe default value is SetOnly a root property type can set its boundary attribute. When set on a non-root property type, an error is thrown. When set and the root property already has When set to a Otherwise, the set value is converted to boolean, by using Source: javascript/web/pentaho/type/property.js, line 726 Default Value: false |
isBrowsable: |
---|
Gets or sets the Browsable types are exposed to the end user. Set this attribute to Setting this to a Source: javascript/web/pentaho/type/_type.js, line 796 Overrides: pentaho.type.mixins.DiscreteDomain.Type#isBrowsable |
isComplex: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 376 Overrides: pentaho.type.mixins.DiscreteDomain.Type#isComplex |
isContainer: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 340 Overrides: pentaho.type.mixins.DiscreteDomain.Type#isContainer |
isElement: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 364 Overrides: pentaho.type.mixins.DiscreteDomain.Type#isElement |
isEnabled: |
---|
Gets or sets a value, or function, that indicates if properties of this type can be changed by a user, in a user interface. A property should be set disabled whenever its value is implied/imposed somehow, and thus cannot be changed directly by the user through a user interface. This attribute is DynamicWhen a dynamic attribute is set to a function, it can evaluate to a different value for each complex instance. When a dynamic attribute is set to a value other than a function or a This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type marked as enabled can later be marked as not enabled. However, a property type marked as not enabled can no longer go back to being enabled. Because this attribute is also dynamic, the actual This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. The first set local value must respect the monotonicity property with the inherited value. Other characteristicsThe value got by the attribute is the last set local, value, if any - a function, a constant value; or, When set to a When set and the property already has The default (root) Source: javascript/web/pentaho/type/property.js, line 1376 See also: pentaho.type.Complex#isEnabledOf , pentaho.type.spec.IPropertyTypeProto#isEnabled |
isEnabledOn: |
---|
Evaluates the value of the Source: javascript/web/pentaho/type/property.js, line 1364 See also: pentaho.type.Property.Type#isEnabled |
isList: |
---|
Gets a value that indicates if the property is a list. A property is a list property if its |
isProperty: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 327 Overrides: pentaho.type.mixins.DiscreteDomain.Type#isProperty |
isReadOnly: |
---|
Gets or sets whether the value of properties of this type can be changed. If the value type is a GetThe default read-only value is the inherited read-only value. A root property type has a default read-only value of SetWhen set and the property already has When set to a Otherwise, the set value is converted to boolean, by using This property is monotonic. Once set to |
isRequired: |
---|
Gets or sets a value that indicates if properties of this type are required. When a property is of a required property type, it is considered invalid if its value (in a complex instance) is Note that this attribute is taken together with the This attribute is DynamicWhen a dynamic attribute is set to a function, it can evaluate to a different value for each complex instance. When a dynamic attribute is set to a value other than a function or a This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type marked as not required can later be marked as required. However, a property type marked as required can no longer go back to being not required. Because this attribute is also dynamic, the actual required values are only known when evaluated for specific complex instances. This behavior ensures that monotonic changes are deferred until evaluation. No errors are thrown; non-monotonic changes simply do not take effect. This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. The first set local value must respect the monotonicity property with the inherited value. Other characteristicsThe value got by the attribute is the last set local, value, if any - a function, a constant value or When set to a When set and the property already has The default (root) Source: javascript/web/pentaho/type/property.js, line 1039 See also: pentaho.type.Complex#isRequiredOf , pentaho.type.spec.IPropertyTypeProto#isRequired |
isRequiredOn: |
---|
Evaluates the value of the This method is used to determine the effective Source: javascript/web/pentaho/type/property.js, line 1023 See also: pentaho.type.Property.Type#isRequired |
isRoot: |
---|
Gets a value that indicates if this type is the root of its type hierarchy. Source: javascript/web/pentaho/type/_type.js, line 250 Overrides: pentaho.type.mixins.DiscreteDomain.Type#isRoot See also: pentaho.type.Type#root |
isSimple: |
---|
Gets a value that indicates if this type |
isValue: |
---|
Gets a value that indicates if this type |
key: |
---|
Gets the key of the property. The key of a property is its name. |
keyName: |
---|
Gets the singular name of Source: javascript/web/pentaho/type/property.js, line 194 Default Value: "name" |
label: |
---|
Gets or sets the label of this type. When set to a non- When set to an empty string or a nully value, the attribute value is reset. When reset, the attribute assumes its default value (except on the top-root type, The default value is the inherited value. The initial value of the attribute on the top-root type is |
mixins: |
---|
Gets or sets the mixin types that are locally mixed into this type. Can be set to either type identifiers, instance classes or type instances and arrays thereof. The attributes defined by the added mixin types become available for extension/configuration on this type. When extending, mixins are always applied first. When set to a |
name: |
---|
Gets or sets the name of the property type. The name of a property type identifies it within its SetThis attribute must be set when defining a new property type, and cannot be changed afterwards. When set to a non- |
nameAlias: |
---|
Gets or sets the alias for the name of the property type. The alias for the name of a property type is an alternative identifier for serialization purposes. SetThis attribute can only be set when defining a new property type, and cannot be changed afterwards. When set to a non- |
ordinal: |
---|
Gets or sets the ordinal associated with this type. The ordinal is used to disambiguate the order with which a type (or an instance of it) is shown in a user interface. Setting this to a Source: javascript/web/pentaho/type/_type.js, line 930 Overrides: pentaho.type.mixins.DiscreteDomain.Type#ordinal See also: pentaho.type.Type#isBrowsable , pentaho.type.Type#category |
root: |
---|
Gets the root type of this type hierarchy. Even though the ultimate type root of types defined in this system is When deriving a type from Typically, root types are immediate subtypes of For example, Source: javascript/web/pentaho/type/_type.js, line 207 Overrides: pentaho.type.mixins.DiscreteDomain.Type#root See also: pentaho.type.Type#isRoot , pentaho.type.Type#ancestor |
shortId: |
---|
Gets the short identifier of this type. The short identifier of a type is equal to its alias, provided it is defined. Otherwise, it is equal to the identifier. Source: javascript/web/pentaho/type/_type.js, line 461 Overrides: pentaho.type.mixins.DiscreteDomain.Type#shortId See also: pentaho.type.Type#id , pentaho.type.Type#alias |
sourceId: |
---|
Gets the source module identifier of this type. The source identifier is the module identifier of the actual AMD/RequireJS module that provides the type and may be different from the The source identifier is used to resolve module identifiers relative to the source module, as is the case with the The source identifier of a type can only be specified when extending the ancestor type. This attribute is not inherited. When unspecified, defaults to the value of Source: javascript/web/pentaho/type/_type.js, line 446 Overrides: pentaho.type.mixins.DiscreteDomain.Type#sourceId See also: pentaho.type.Type#id , pentaho.type.Type#defaultView |
styleClass: |
---|
Gets or sets the CSS class associated with this type. This attribute is typically used to associate an icon with a type. Attempting to set to a non-string value type implicitly converts the value to a string before assignment. An empty string or Setting to The default value of a type with an Source: javascript/web/pentaho/type/_type.js, line 874 Overrides: pentaho.type.mixins.DiscreteDomain.Type#styleClass |
uid: |
---|
Gets the unique identifier of this type. Unique type identifiers are auto-generated in each session. Note that even anonymous types (those whose This attribute is not inherited. Source: javascript/web/pentaho/type/_type.js, line 201 Overrides: pentaho.type.mixins.DiscreteDomain.Type#uid |
valueType: |
---|
Gets or sets the type of value that properties of this type can hold. If the value type is a GetThe default value type is the inherited value type. A root property type has a default value type of SetWhen set and the property already has When set to a Otherwise, the set value is assumed to be an When set to a value type that is not a Relation to the |
Methods Details
_extend() Static |
---|
_collectElementValidators(addValidator, owner, value) Protected | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Called each time a property value is validated to collect the list of element validators. When overriding this method, be sure to also call the base implementation. Source: javascript/web/pentaho/type/property.js, line 893 Overrides: pentaho.type.mixins.DiscreteDomain.Type#_collectElementValidators
|
_fillSpecInContext(spec, keyArgs) : boolean Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Fills the given specification with this type's attributes' local values, and returns whether any attribute was actually added. This method requires that there currently exists an This method does not add the special Source: javascript/web/pentaho/type/_type.js, line 1315 Overrides: pentaho.type.mixins.DiscreteDomain.Type#_fillSpecInContext
See also: pentaho.type.Instance#toSpecInContext |
_getLabelDefault() : string Protected | ||||
---|---|---|---|---|
Gets the default label of the property. The label of a root property is reset to a capitalization of the Source: javascript/web/pentaho/type/property.js, line 620 Overrides: pentaho.type.mixins.DiscreteDomain.Type#_getLabelDefault
|
_init(spec, keyArgs) Protected | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Performs initialization tasks that take place before the instance is extended with its spec. Source: javascript/web/pentaho/type/property.js, line 134 Overrides: pentaho.type.mixins.DiscreteDomain.Type#_init
|
_postInit(spec, keyArgs) Protected | |||||||||
---|---|---|---|---|---|---|---|---|---|
Performs initialization tasks that take place after the instance is extended with its specification. This method is typically overridden to validate or default the values of the attributes. Source: javascript/web/pentaho/type/_type.js, line 170 Overrides: pentaho.type.mixins.DiscreteDomain.Type#_postInit
|
_validateValueOn(owner, value) : pentaho.type.ValidationError | Array.< Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Validates the given non-null value in the context of this property. The base implementation calls When overriding this method, the error utilities in Source: javascript/web/pentaho/type/property.js, line 853
|
buildSourceRelativeId(id) : string | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Builds an absolute module identifier from one that is relative to the type's Relative module identifiers start with a Absolute identifiers are returned without modification. Source: javascript/web/pentaho/type/_type.js, line 480 Overrides: pentaho.type.mixins.DiscreteDomain.Type#buildSourceRelativeId
See also: pentaho.type.Type#sourceId |
countRangeOn(owner) : pentaho.IRange.< | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Evaluates the element count range of a property of this type on a given complex value. The element count range is a conciliation of the effective value of the following attributes:
The logic can be best explained by the following simple example function:
When the property is not a If The Source: javascript/web/pentaho/type/property.js, line 1484
See also: pentaho.type.Complex#countRangeOf |
create(instRef, instKeyArgs) : pentaho.type.Instance | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates or resolves an instance of this type given an instance reference. This method delegates to Source: javascript/web/pentaho/type/_type.js, line 1115 Overrides: pentaho.type.mixins.DiscreteDomain.Type#create
See also: pentaho.type.Type#createAsync , pentaho.type.Type#to , pentaho.type.Type#is Examples Create a complex instance from a specification that contains the type inline. require(["pentaho/type/Context"], function(Context) { Context.createAsync({application: "data-explorer-101"}) .then(function(context) { var Value = context.get("value"); var product = Value.type.create({ _: { props: ["id", "name", {name: "price", valueType: "number"}] }, id: "mpma", name: "Principia Mathematica", price: 1200 }); // ... }); }); Create a list instance from a specification that contains the type inline. require(["pentaho/type/Context"], function(Context) { Context.createAsync({application: "data-explorer-101"}) .then(function(context) { var Value = context.get("value"); var productList = Value.type.create({ _: [{ props: ["id", "name", {name: "price", valueType: "number"}] }], d: [ {id: "mpma", name: "Principia Mathematica", price: 1200}, {id: "flot", name: "The Laws of Thought", price: 500} ] }); // ... }); }); Create an instance from a specification that does not contain the type inline. require(["pentaho/type/Context"], function(Context) { Context.createAsync({application: "data-explorer-101"}) .then(function(context) { var ProductList = context.get([{ props: [ "id", "name", {name: "price", valueType: "number"} ] }]); // Provide the default type, in case the instance spec doesn't provide one. var productList = ProductList.type.create( [ {id: "mpma", name: "Principia Mathematica", price: 1200}, {id: "flot", name: "The Laws of Thought", price: 500} ]); // ... }); }); |
createAsync(instRef, instKeyArgs) : Promise.< | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates or resolves an instance of this type, asynchronously, given an instance reference. This method delegates to Source: javascript/web/pentaho/type/_type.js, line 1136 Overrides: pentaho.type.mixins.DiscreteDomain.Type#createAsync
See also: pentaho.type.Type#create |
defaultValueOn(owner) : pentaho.type.Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a default value for use in a given Ensures that list properties always have a non-null default value. Source: javascript/web/pentaho/type/property.js, line 592
|
is(value) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a value is an instance of this type. Source: javascript/web/pentaho/type/_type.js, line 1179 Overrides: pentaho.type.mixins.DiscreteDomain.Type#is
|
isSubtypeOf(superType) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if this is a subtype of another. A type is considered a subtype of itself. Source: javascript/web/pentaho/type/_type.js, line 1191 Overrides: pentaho.type.mixins.DiscreteDomain.Type#isSubtypeOf
|
to(value, keyArgs) : pentaho.type.Instance | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Converts a value to an instance of this type, if it is not one already. If a Otherwise, if a given value is not already an instance of this type (checked using Source: javascript/web/pentaho/type/_type.js, line 1212 Overrides: pentaho.type.mixins.DiscreteDomain.Type#to
|
toJSON() : UJsonValue | ||||
---|---|---|---|---|
Creates a JSON specification that describes this type. Attributes which do not have a JSON-compatible specification are omitted. Specifically, attributes with a function value are not supported. This method simply calls Source: javascript/web/pentaho/type/_type.js, line 1290 Overrides: pentaho.type.mixins.DiscreteDomain.Type#toJSON
See also: pentaho.type.Instance#toSpec |
toRef(keyArgs) : pentaho.type.spec.UTypeReference | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Returns a reference to this type. This method returns a reference to this type that is appropriate to be the value of an If an When a type is not anonymous, the For anonymous types, a Some standard types have a special reference syntax. For example: Source: javascript/web/pentaho/type/_type.js, line 1408 Overrides: pentaho.type.mixins.DiscreteDomain.Type#toRef
See also: pentaho.type.Type#toSpec |
toRefInContext(keyArgs) : pentaho.type.spec.UTypeReference | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Returns a reference to this type under a given specification context. This method requires that there currently exists an Source: javascript/web/pentaho/type/_type.js, line 1428 Overrides: pentaho.type.mixins.DiscreteDomain.Type#toRefInContext
See also: pentaho.type.Type#toRef |
toSpec(keyArgs) : pentaho.type.spec.ITypeProto | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this type. If an This method creates a new Source: javascript/web/pentaho/type/_type.js, line 1243 Overrides: pentaho.type.mixins.DiscreteDomain.Type#toSpec
See also: pentaho.type.Type#toSpecInContext , pentaho.type.Type#_fillSpecInContext |
toSpecInContext(keyArgs) : pentaho.type.spec.ITypeProto | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this type. This method requires that there currently exists an The default implementation returns a plain object with the identifier of the type and any other specified attributes (like Source: javascript/web/pentaho/type/_type.js, line 1266 Overrides: pentaho.type.mixins.DiscreteDomain.Type#toSpecInContext
See also: pentaho.type.Type#toSpec |
toString() : string | ||||
---|---|---|---|---|
Returns a textual representation suitable to identify this type in an error message. Source: javascript/web/pentaho/type/_type.js, line 1439 Overrides: pentaho.type.mixins.DiscreteDomain.Type#toString
|
toValueOn(defaultValueOwner, valueSpec) : pentaho.type.Value | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Converts the given value or value specification to a value of this property's value type. If the given value is already an instance of the property's value type, it is returned. By default, if, Source: javascript/web/pentaho/type/property.js, line 566
|
validateOn(owner) : pentaho.type.ValidationError | Array.< | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if this property is valid on a given complex instance. If this property is not a Afterwards, the cardinality is verified against the attributes Source: javascript/web/pentaho/type/property.js, line 791
See also: pentaho.type.Complex#validate |