PropertyType

Creates a property type object.

Source: javascript/web/pentaho/type/Property.js, line 41

See also: pentaho.type.Complex

Gets a value that indicates if the label is locally set.

Source: javascript/web/pentaho/type/InstanceType.js, line 652

Overrides: pentaho.type.mixins.DiscreteDomainType#_isLabelSet

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 null.

Source: javascript/web/pentaho/type/InstanceType.js, line 515

Overrides: pentaho.type.mixins.DiscreteDomainType#alias

See also: pentaho.type.Type#id

Gets the parent type in the current type hierarchy, if any, or null.

The root type returns null.

Source: javascript/web/pentaho/type/InstanceType.js, line 265

Overrides: pentaho.type.mixins.DiscreteDomainType#ancestor

See also: pentaho.type.Type#root , pentaho.type.Type#hasDescendants

Gets or sets the application attribute of this type.

The application property serves as a collection of properties specific to the container application that can be modified via the Configuration Service.

Setting this to a Nully value will have no effect.

Source: javascript/web/pentaho/type/InstanceType.js, line 670

Overrides: pentaho.type.mixins.DiscreteDomainType#application

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 undefined causes this attribute to use the inherited value, except for the root type, Instance.type (which has no ancestor), where the attribute is null.

Setting this to null or to an empty string clears the attribute and sets it to null, thus ignoring any inherited value.

Source: javascript/web/pentaho/type/InstanceType.js, line 739

Overrides: pentaho.type.mixins.DiscreteDomainType#category

See also: pentaho.type.Type#isBrowsable , pentaho.type.Type#ordinal

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 isRequired and the countMin attributes to determine the effective element count range of a property type.

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 isRequired attribute to determine the effective element count range of a property type.

Gets the complex type that declares this property type.

Source: javascript/web/pentaho/type/Property.js, line 246

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 Nully value.

The value null is a valid default value.

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 undefined causes this attribute to use the inherited value, except for the root type, Instance.type (which has no ancestor), where this attribute is null.

Setting this to null or to an empty string clears the attribute and sets it to null, ignoring any inherited value.

Source: javascript/web/pentaho/type/InstanceType.js, line 699

Overrides: pentaho.type.mixins.DiscreteDomainType#description

Gets or sets the list of valid values (or a function that evaluates to these) of properties of this type.

Evaluates the value of the domain attribute of a property of this type on a given owner complex value.

Source: javascript/web/pentaho/type/mixins/DiscreteDomain.js, line 68

Inherited From: pentaho.type.mixins.DiscreteDomainType#domainOn

See also: pentaho.type.PropertyType#domain

Gets the element type of this type.

If this type is a list type, returns its of attribute. Otherwise, this type is an element type, and it returns itself.

Source: javascript/web/pentaho/type/InstanceType.js, line 420

Overrides: pentaho.type.mixins.DiscreteDomainType#elementType

See also: pentaho.type.Type#isList , pentaho.type.Type#isElement , pentaho.type.ListType#of

Gets the singular name of PropertyType list-elements.

Source: javascript/web/pentaho/type/Property.js, line 209

Default Value: "property"

Gets a value that indicates if this type has any descendant types.

Source: javascript/web/pentaho/type/InstanceType.js, line 278

Overrides: pentaho.type.mixins.DiscreteDomainType#hasDescendants

See also: pentaho.type.Type#ancestor

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 undefined causes this attribute to use the inherited value, except for the root type, Instance.type (which has no ancestor), where the attribute is null.

Setting this to null or to an empty string clears the attribute and sets it to null, ignoring any inherited value.

Source: javascript/web/pentaho/type/InstanceType.js, line 775

Overrides: pentaho.type.mixins.DiscreteDomainType#helpUrl

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 pentaho.type.Type#uid.

This attribute is not inherited.

When unspecified, defaults to the value of sourceId.

Source: javascript/web/pentaho/type/InstanceType.js, line 449

Overrides: pentaho.type.mixins.DiscreteDomainType#id

See also: pentaho.type.Type#sourceId

Gets the index of the property in the containing complex type.

Source: javascript/web/pentaho/type/Property.js, line 258

Gets the prototype of the instances of this type.

Source: javascript/web/pentaho/type/InstanceType.js, line 290

Overrides: pentaho.type.mixins.DiscreteDomainType#instance

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/InstanceType.js, line 538

Default Value: false

Overrides: pentaho.type.mixins.DiscreteDomainType#isAbstract

Gets or sets the isAdvanced attribute of this type.

Types with isAdvanced attributes set to false are typically immediately accessible to the user. An advanced type typically escapes the expected flow of utilization, yet it is sufficiently relevant to be shown in a user interface.

Setting this to a Nully value causes this attribute to use the inherited value, except for the root type, Instance.type (which has no ancestor), where the attribute is false.

Source: javascript/web/pentaho/type/InstanceType.js, line 842

Overrides: pentaho.type.mixins.DiscreteDomainType#isAdvanced

See also: pentaho.type.Type#isBrowsable

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.

Gets or sets whether the property is a boundary property.

A boundary property identifies the limits of the aggregate of its declaring type.

If the value type is a list type, then this property sets its lists as boundary lists.

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.

Gets or sets the isBrowsable attribute of this type.

Browsable types are exposed to the end user. Set this attribute to false to prevent exposing the type in a user interface.

Setting this to a Nully value causes this attribute to use the inherited value, except for the root type, Instance.type (which has no ancestor), where the attribute is true.

Source: javascript/web/pentaho/type/InstanceType.js, line 808

Overrides: pentaho.type.mixins.DiscreteDomainType#isBrowsable

Gets a value that indicates if this type is a complex type.

Source: javascript/web/pentaho/type/InstanceType.js, line 374

Overrides: pentaho.type.mixins.DiscreteDomainType#isComplex

Gets a value that indicates if this type is a list or a complex type.

Source: javascript/web/pentaho/type/InstanceType.js, line 339

Overrides: pentaho.type.mixins.DiscreteDomainType#isContainer

Gets a value that indicates if this is a continuous type.

A non-continuous type is said to be categorical.

The default implementation returns false.

The types pentaho.type.Number and pentaho.type.Date are known to be continuous.

Source: javascript/web/pentaho/type/InstanceType.js, line 402

Overrides: pentaho.type.mixins.DiscreteDomainType#isContinuous

Gets a value that indicates if this type is an element type.

Source: javascript/web/pentaho/type/InstanceType.js, line 363

Overrides: pentaho.type.mixins.DiscreteDomainType#isElement

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.

Gets a value that indicates if the property is a list.

A property is a list property if its value type is a list type, that is, if it is or extends List.

Source: javascript/web/pentaho/type/Property.js, line 361

Overrides: pentaho.type.mixins.DiscreteDomainType#isList

Gets a value that indicates if this type is a property type.

Source: javascript/web/pentaho/type/InstanceType.js, line 326

Overrides: pentaho.type.mixins.DiscreteDomainType#isProperty

Gets whether the value of properties of this type cannot be changed, from the outside.

If the value type is a list type, then this property effectively makes the list read-only.

This attribute can only be set when defining a root property or an abstract property type.

When the property belongs to a read-only complex type, then the property is necessarily read-only, as well as the element type of the property's value type.

The default read-only value of false.

Source: javascript/web/pentaho/type/Property.js, line 389

See also: pentaho.type.ValueType#isReadOnly , pentaho.type.PropertyType#valueType

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 null; or, in the case of a list property type, it has zero elements.

Note that this attribute is taken together with the countMin attribute to determine the effective element count range of a property type.

Gets a value that indicates if this type is the root of its type hierarchy.

Source: javascript/web/pentaho/type/InstanceType.js, line 249

Overrides: pentaho.type.mixins.DiscreteDomainType#isRoot

See also: pentaho.type.Type#root

Gets a value that indicates if this type is a simple type.

Source: javascript/web/pentaho/type/InstanceType.js, line 386

Overrides: pentaho.type.mixins.DiscreteDomainType#isSimple

Gets a value that indicates if this type is a value type.

Source: javascript/web/pentaho/type/InstanceType.js, line 314

Overrides: pentaho.type.mixins.DiscreteDomainType#isValue

Gets the key of the property.

The key of a property is its name.

Source: javascript/web/pentaho/type/Property.js, line 228

Gets the singular name of PropertyType keys.

Source: javascript/web/pentaho/type/Property.js, line 218

Default Value: "name"

Gets or sets the label of this type.

When set to a non-Nully and non-String value, the value is first replaced by the result of calling its toString method.

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, Instance.type, in which case it has no effect).

The default value is the inherited value.

The initial value of the attribute on the top-root type is "instance".

Source: javascript/web/pentaho/type/InstanceType.js, line 613

Overrides: pentaho.type.mixins.DiscreteDomainType#label

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 Nully value, nothing is done.

Source: javascript/web/pentaho/type/InstanceType.js, line 557

Overrides: pentaho.type.mixins.DiscreteDomainType#mixins

Gets or sets the name of the property type.

The name of a property type identifies it within its declaring type.

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.

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 Nully value causes this attribute to use the inherited value, except for the root type, Instance.type (which has no ancestor), where the attribute is 0.

Source: javascript/web/pentaho/type/InstanceType.js, line 875

Overrides: pentaho.type.mixins.DiscreteDomainType#ordinal

See also: pentaho.type.Type#isBrowsable , pentaho.type.Type#category

Gets the root type of this type hierarchy.

Even though the ultimate type root of types defined in this system is Instance, the system is designed to represent multiple type hierarchies, each representing concrete, more meaningful concepts.

When deriving a type from Instance, it can be marked as the root of a type hierarchy, by specifying the isRoot keyword argument to extend.

Typically, root types are immediate subtypes of Instance. However, this is not enforced and it is up to the developer to decide at what level a practical, meaningful type root arises.

For example, Value is the root of value types. However, Property, also an immediate subtype of Instance, is not considered a root type. It is the immediate subtypes of Property (each root property within a complex type) which are considered roots. This aligns with users expectations of what an attribute named root in a property type should mean.

Source: javascript/web/pentaho/type/InstanceType.js, line 206

Overrides: pentaho.type.mixins.DiscreteDomainType#root

See also: pentaho.type.Type#isRoot , pentaho.type.Type#ancestor

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/InstanceType.js, line 492

Overrides: pentaho.type.mixins.DiscreteDomainType#shortId

See also: pentaho.type.Type#id , pentaho.type.Type#alias

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 identifier when an AMD package or custom mapping is configured for the module.

The source identifier is used to resolve module identifiers relative to the source module.

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 id.

Source: javascript/web/pentaho/type/InstanceType.js, line 477

Overrides: pentaho.type.mixins.DiscreteDomainType#sourceId

See also: pentaho.type.Type#id

Gets the unique identifier of this type.

Unique type identifiers are auto-generated in each session.

Note that even anonymous types (those whose pentaho.type.Type#id is null) have a unique identifier.

This attribute is not inherited.

Source: javascript/web/pentaho/type/InstanceType.js, line 200

Overrides: pentaho.type.mixins.DiscreteDomainType#uid

Gets the type of value that properties of this type can hold.

If the value type is a list type, then this property will be a list (or multiple-elements) property; otherwise, this property will be an element (or single-element) property.

The default value type is the inherited value type.

A root property type has a default value type of string.

This attribute can only be specified upon property definition.

When a Nully value is specified, it is ignored.

Otherwise, the specified value is assumed to be an spec.TypeReference and is first resolved using ILoader#resolveType.

An error is thrown when the specified value is not a subtype of the attribute's current value type.

An error is thrown when the specified value is such that its element type would not be read-only and the property belongs to a read-only complex type.

Source: javascript/web/pentaho/type/Property.js, line 1051

Asserts that a given value type is consistent with the isReadOnly status of the declaring type.

Source: javascript/web/pentaho/type/Property.js, line 501

Sets the value type of the property.

Source: javascript/web/pentaho/type/Property.js, line 464

Asserts that the type has no subtypes and that as such the given attribute can be set.

Source: javascript/web/pentaho/type/InstanceType.js, line 1045

Overrides: pentaho.type.mixins.DiscreteDomainType#_assertNoSubtypesAttribute

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 928

Overrides: pentaho.type.mixins.DiscreteDomainType#_collectElementValidators

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 ambient specification context.

This method does not add the special id and base attributes to the specification.

Source: javascript/web/pentaho/type/InstanceType.js, line 1248

Overrides: pentaho.type.mixins.DiscreteDomainType#_fillSpecInContext

See also: pentaho.type.Instance#toSpecInContext

Gets the default label of the property.

The label of a root property is reset to a capitalization of the name attribute. A non-root property inherits the label of its closest ancestor.

Source: javascript/web/pentaho/type/Property.js, line 708

Overrides: pentaho.type.mixins.DiscreteDomainType#_getLabelDefault

Performs initialization tasks that take place before the instance is extended with its spec.

Source: javascript/web/pentaho/type/Property.js, line 137

Overrides: pentaho.type.mixins.DiscreteDomainType#_init

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/InstanceType.js, line 182

Overrides: pentaho.type.mixins.DiscreteDomainType#_postInit

Called to actually create a specification of this anonymous type, when it is the first time that this type occurs in the ambient specification context.

Source: javascript/web/pentaho/type/InstanceType.js, line 1197

Overrides: pentaho.type.mixins.DiscreteDomainType#_toSpecInContextCore

See also: pentaho.type.Type#_toSpecInContextCore

Validates the given non-null value in the context of this property.

The base implementation calls _collectElementValidators to obtain the list of currently applicable element validators. Then, each element is validated against the list of collected validators.

When overriding this method, the error utilities in pentaho.type.Util can be used to help in the implementation.

Source: javascript/web/pentaho/type/Property.js, line 887

Evaluates the value of the countMax attribute of a property of this type on a given complex value.

This method is used to determine the effective element count range and is not intended to be used directly.

Source: javascript/web/pentaho/type/Property.js, line 1241

See also: pentaho.type.PropertyType#countMax

Evaluates the value of the countMin attribute of a property of this type on a given complex value.

This method is used to determine the effective element count range and is not intended to be used directly.

Source: javascript/web/pentaho/type/Property.js, line 1154

See also: pentaho.type.PropertyType#countMin

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:

• pentaho.type.PropertyType#isList
• pentaho.type.PropertyType#isRequired
• pentaho.type.PropertyType#countMin
• pentaho.type.PropertyType#countMax

The logic can be best explained by the following simple example function:

function evaluateRange(isList, isRequiredEf, countMinEf, countMaxEf) {
  var min = countMinEf;
  var max = countMaxEf;

  if(!isList && min > 1) min = 1;
  if(!isList && max > 1) max = 1;

  if(isRequiredEf && min < 1) min = 1;

  if(max < min) max = min;

  return {min: min, max};
}

When the property is not a list property, then both the minimum and maximum values can only be either zero or one.

If isRequired is true, then the minimum must be greater than or equal to one.

The countMax value is constrained to be greater than or equal to the minimum.

Source: javascript/web/pentaho/type/Property.js, line 1530

See also: pentaho.type.Complex#countRangeOf

Creates or resolves an instance of this type given an instance reference.

This method delegates to InstancesContainer#get with this type as the typeBase argument.

Source: javascript/web/pentaho/type/InstanceType.js, line 977

Overrides: pentaho.type.mixins.DiscreteDomainType#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/Instance", "pentaho/type/standard"], function(Instance) {

 var product = Instance.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/Instance", "pentaho/type/standard"], function(Instance) {

 var productList = Instance.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/Instance", "pentaho/type/standard"], function(Instance) {

 var ProductList = Instance.type.create([{
 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}
 ]);

 // ...

});

Creates or resolves an instance of this type, asynchronously, given an instance reference.

This method delegates to InstancesContainer#getAsync with this type as the typeBase argument.

Source: javascript/web/pentaho/type/InstanceType.js, line 998

Overrides: pentaho.type.mixins.DiscreteDomainType#createAsync

See also: pentaho.type.Type#create

Gets a default value for use in a given Complex instance.

Ensures that list properties always have a non-null default value.

Source: javascript/web/pentaho/type/Property.js, line 679

Determines if a value is an instance of this type.

Source: javascript/web/pentaho/type/InstanceType.js, line 1059

Overrides: pentaho.type.mixins.DiscreteDomainType#is

Evaluates the value of the isApplicable attribute of a property of this type on a given owner complex value.

Source: javascript/web/pentaho/type/Property.js, line 1328

See also: pentaho.type.PropertyType#isApplicable

Evaluates the value of the isEnabled attribute of a property of this type on a given owner complex value.

Source: javascript/web/pentaho/type/Property.js, line 1409

See also: pentaho.type.PropertyType#isEnabled

Evaluates the value of the isRequired attribute of a property of this type on a given complex value.

This method is used to determine the effective element count range and is not intended to be used directly.

Source: javascript/web/pentaho/type/Property.js, line 1064

See also: pentaho.type.PropertyType#isRequired

Determines if this is a subtype of another.

A type is considered a subtype of itself.

Source: javascript/web/pentaho/type/InstanceType.js, line 1071

Overrides: pentaho.type.mixins.DiscreteDomainType#isSubtypeOf

Converts a value to an instance of this type, if it is not one already.

If a Nully value is specified, null is returned.

Otherwise, if a given value is not already an instance of this type (checked using is), this method delegates the creation of an instance to create.

Source: javascript/web/pentaho/type/InstanceType.js, line 1092

Overrides: pentaho.type.mixins.DiscreteDomainType#to

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 pentaho.type.Instance#toSpec with argument keyArgs.isJson as true and exists for seamless integration with JavaScript's JSON.stringify method.

Source: javascript/web/pentaho/type/InstanceType.js, line 1223

Overrides: pentaho.type.mixins.DiscreteDomainType#toJSON

See also: pentaho.type.Instance#toSpec

Creates a specification that describes this type.

If an ambient specification context, currently exists, it is used to manage the serialization process. Otherwise, one is created and set as current.

This method creates a new pentaho.type.SpecificationScope for describing this type, and any other instances and types it references, and then delegates the actual work to pentaho.type.Type#toSpecInContext.

This method returns a reference to this type that is appropriate to be the value of an inline type property that is included on a specification of an instance of this type.

When a type has an identifier, its id (or its alias) is returned.

For anonymous types, a temporary, serialization-only identifier is generated. In the first occurrence in the given scope, that identifier is returned, within a full specification of the type, obtained by calling toSpecInContext. In following occurrences, only the previously used temporary identifier is returned.

Source: javascript/web/pentaho/type/InstanceType.js, line 1137

Overrides: pentaho.type.mixins.DiscreteDomainType#toSpec

See also: pentaho.type.Type#toSpecInContext , pentaho.type.Type#_fillSpecInContext

Creates a specification that describes this type.

This method requires that there currently exists an ambient specification context.

This method handles the cases where this type has an identifier or it does not but a temporary identifier has already been assigned in the ambient specification context. Otherwise, execution delegates to _toSpecInContextCore.

Source: javascript/web/pentaho/type/InstanceType.js, line 1166

Overrides: pentaho.type.mixins.DiscreteDomainType#toSpecInContext

See also: pentaho.type.Type#toSpec

Returns a textual representation suitable to identify this type in an error message.

Source: javascript/web/pentaho/type/InstanceType.js, line 1293

Overrides: pentaho.type.mixins.DiscreteDomainType#toString

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, defaultValueOwner is specified, a Nully value is converted to the property's default value, pentaho.type.PropertyType#defaultValue.

Source: javascript/web/pentaho/type/Property.js, line 639

Determines if this property is valid on a given complex instance.

If this property is not a boundary property, this method validates the value of the property itself.

Afterwards, the cardinality is verified against the attributes pentaho.type.PropertyType#isRequired, pentaho.type.PropertyType#countMin and pentaho.type.PropertyType#countMax.

Source: javascript/web/pentaho/type/Property.js, line 825

See also: pentaho.type.Complex#validate