Type

Source: javascript/web/pentaho/type/filter/isEqual.js, line 28

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

Overrides: pentaho.type.Property.Type#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/_type.js, line 234

Inherited From: pentaho.type.Type#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/_type.js, line 640

Inherited From: pentaho.type.Type#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/_type.js, line 713

Inherited From: pentaho.type.Type#category

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

Gets the context that defined this type class.

Source: javascript/web/pentaho/type/_type.js, line 149

Inherited From: pentaho.type.Type#context

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 225

Inherited From: pentaho.type.Property.Type#declaringType

Gets or sets the default view for instances of this type.

When a string, it is the identifier of the view's AMD module. If the identifier is relative, it is relative to sourceId.

Setting this to undefined causes the default view to be inherited from the ancestor type, except for the root type, Instance.type (which has no ancestor), where the attribute is null.

Setting this to a falsy value (like null or an empty string), clears the value of the attribute and sets it to null, ignoring any inherited value.

When a function, it is the class or factory of the default view.

Source: javascript/web/pentaho/type/_type.js, line 981

Inherited From: pentaho.type.Type#defaultView

See also:  pentaho.type.Type#defaultViewClass , pentaho.type.Type#buildSourceRelativeId

Gets a promise for the default view class or factory, if any; or null.

A default view exists if property pentaho.type.Type#defaultView has a non-null value.

Source: javascript/web/pentaho/type/_type.js, line 1031

Inherited From: pentaho.type.Type#defaultViewClass

See also:  pentaho.type.Type#defaultView

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/_type.js, line 669

Inherited From: pentaho.type.Type#description

Gets the singular name of Property.Type list-elements.

Source: javascript/web/pentaho/type/property.js, line 191

Inherited From: pentaho.type.Property.Type#elemName

Default Value: "property"

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, pentaho.type.List.Type#of, is returned.

Otherwise, pentaho.type.Property.type is returned.

Source: javascript/web/pentaho/type/property.js, line 359

Inherited From: pentaho.type.Property.Type#elemType

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

Source: javascript/web/pentaho/type/_type.js, line 247

Inherited From: pentaho.type.Type#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/_type.js, line 753

Inherited From: pentaho.type.Type#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/_type.js, line 397

Overrides: pentaho.type.Property.Type#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 237

Inherited From: pentaho.type.Property.Type#index

Gets the style classes of this and any base types.

Does not modify the returned array.

Source: javascript/web/pentaho/type/_type.js, line 895

Inherited From: pentaho.type.Type#inheritedStyleClasses

Gets the prototype of the instances of this type.

Source: javascript/web/pentaho/type/_type.js, line 259

Inherited From: pentaho.type.Type#instance

Gets or sets 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 572

Inherited From: pentaho.type.Type#isAbstract

Default Value: false

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/_type.js, line 828

Inherited From: pentaho.type.Type#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/_type.js, line 790

Inherited From: pentaho.type.Type#isBrowsable

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

Source: javascript/web/pentaho/type/_type.js, line 356

Inherited From: pentaho.type.Type#isComplex

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

Source: javascript/web/pentaho/type/_type.js, line 308

Inherited From: pentaho.type.Type#isContainer

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

Source: javascript/web/pentaho/type/_type.js, line 332

Inherited From: pentaho.type.Type#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 339

Inherited From: pentaho.type.Property.Type#isList

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

Source: javascript/web/pentaho/type/_type.js, line 295

Inherited From: pentaho.type.Type#isProperty

Gets or sets whether the value of properties of this type can be changed.

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

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

Source: javascript/web/pentaho/type/_type.js, line 344

Inherited From: pentaho.type.Type#isRefinement

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/_type.js, line 218

Inherited From: pentaho.type.Type#isRoot

See also:  pentaho.type.Type#root

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

Source: javascript/web/pentaho/type/_type.js, line 368

Inherited From: pentaho.type.Type#isSimple

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

Source: javascript/web/pentaho/type/_type.js, line 283

Inherited From: pentaho.type.Type#isValue

Gets the key of the property.

The key of a property is its name.

Source: javascript/web/pentaho/type/property.js, line 210

Inherited From: pentaho.type.Property.Type#key

Gets the singular name of Property.Type keys.

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

Inherited From: pentaho.type.Property.Type#keyName

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/_type.js, line 604

Inherited From: pentaho.type.Type#label

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/_type.js, line 929

Inherited From: pentaho.type.Type#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/_type.js, line 175

Inherited From: pentaho.type.Type#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/_type.js, line 472

Inherited From: pentaho.type.Type#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, as is the case with the pentaho.type.Type#defaultView attribute.

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/_type.js, line 442

Inherited From: pentaho.type.Type#sourceId

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

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 null clears the property value.

Setting to undefined, makes the property assume its default value.

The default value of a type with an id is the identifier converted to snake-case, plus special characters like \, /, _ and spaces are converted to: a dash (–). For example: "pentaho/visual/models/heatGrid" would have a default styleClass of: "pentaho-visual-ccc-heat-grid". The default value of an anonymous type is null.

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

Inherited From: pentaho.type.Type#styleClass

Gets or sets 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.

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/_type.js, line 169

Inherited From: pentaho.type.Type#uid

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. A cloned value is used each time.

The value null is a valid default value.

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/_type.js, line 1463

Inherited From: pentaho.type.Type#_fillSpecInContext

See also:  pentaho.type.Instance#toSpecInContext

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

Source: javascript/web/pentaho/type/property.js, line 143

Inherited From: pentaho.type.Property.Type#_init

Performs initialization tasks that take place after the instance is extended with its specification.

This method is typically overridden to validate the values of the attributes.

The default implementation does nothing.

Source: javascript/web/pentaho/type/_type.js, line 128

Inherited From: pentaho.type.Type#_postInit

Builds an absolute module identifier from one that is relative to the type's source location.

Relative module identifiers start with a . and do not end with ".js". For example, "./view" and "../view", but not ./view.js.

Absolute identifiers are returned without modification.

Source: javascript/web/pentaho/type/_type.js, line 491

Inherited From: pentaho.type.Type#buildSourceRelativeId

See also:  pentaho.type.Type#sourceId

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.Property.Type#isList
• pentaho.type.Property.Type#isRequired
• pentaho.type.Property.Type#countMin
• pentaho.type.Property.Type#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 1351

Inherited From: pentaho.type.Property.Type#countRangeEval

See also:  pentaho.type.Complex#countRange

Creates an instance of this type, given an instance specification.

If the instance specification contains an inline type reference, in property "_", the referenced type is used to create the instance (as long as it is a subtype of this type).

If the specified instance specification does not contain an inline type reference, the type is assumed to be this type.

Source: javascript/web/pentaho/type/_type.js, line 1189

Inherited From: pentaho.type.Type#create

See also:  pentaho.type.Type#createAsync , pentaho.type.Type#isSubtypeOf , pentaho.type.Context#get

Examples

Create a complex instance from a specification that contains the type inline.

require(["pentaho/type/Context"], function(Context) {

 var context = new Context({application: "data-explorer-101"});
 var Value = context.get("value");

 var product = Value.type.create({
 _: {
 props: ["id", "name", {name: "price", type: "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) {

 var context = new Context({application: "data-explorer-101"});
 var Value = context.get("value");

 var productList = Value.type.create({
 _: [{
 props: ["id", "name", {name: "price", type: "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) {

 var context = new Context({application: "data-explorer-101"});
 var ProductList = context.get([{
 props: [
 "id",
 "name",
 {name: "price", type: "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 an instance of this type, asynchronously, given an instance specification.

If the instance specification contains an inline type reference, in property "_", the referenced type is used to create the instance (as long as it is a subtype of this type).

If the specified instance specification does not contain an inline type reference, the type is assumed to be this type.

Source: javascript/web/pentaho/type/_type.js, line 1258

Inherited From: pentaho.type.Type#createAsync

See also:  pentaho.type.Type#create , pentaho.type.Type#isSubtypeOf , pentaho.type.Context#get

Creates a subtype of this one.

This method creates a subtype that does not have own instance or type constructors. The base type's instance and type constructors are used to initialize instances and the type.

To create a type with own constructors, extend from the base instance constructor instead, by calling its extend method.

Source: javascript/web/pentaho/type/_type.js, line 1055

Inherited From: pentaho.type.Type#extendProto

Determines if a value is an instance of this type.

Source: javascript/web/pentaho/type/_type.js, line 1326

Inherited From: pentaho.type.Type#is

Determines if this is a subtype of another.

A type is considered a subtype of itself.

Source: javascript/web/pentaho/type/_type.js, line 1338

Inherited From: pentaho.type.Type#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/_type.js, line 1359

Inherited From: pentaho.type.Type#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/_type.js, line 1438

Inherited From: pentaho.type.Type#toJSON

See also:  pentaho.type.Instance#toSpec

Returns a reference to this type.

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.

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

When a type is not anonymous, the id 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.

Some standard types have a special reference syntax. For example: List.Type#toRef.

Source: javascript/web/pentaho/type/_type.js, line 1539

Inherited From: pentaho.type.Type#toRef

See also:  pentaho.type.Type#toSpec

Returns a reference to this type under a given specification context.

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

Source: javascript/web/pentaho/type/_type.js, line 1559

Inherited From: pentaho.type.Type#toRefInContext

See also:  pentaho.type.Type#toRef

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.

Source: javascript/web/pentaho/type/_type.js, line 1390

Inherited From: pentaho.type.Type#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.

The default implementation returns a plain object with the identifier of the type and any other specified attributes (like label or description).

Source: javascript/web/pentaho/type/_type.js, line 1413

Inherited From: pentaho.type.Type#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/_type.js, line 1570

Inherited From: pentaho.type.Type#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, a Nully value is converted to (a clone of) the property's default value, pentaho.type.Property.Type#value.

Source: javascript/web/pentaho/type/property.js, line 529

Inherited From: pentaho.type.Property.Type#toValue

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

This method first ensures the value of the property is consistent with its type. Afterwards, the cardinality is verified against the attributes pentaho.type.Property.Type#countMin and pentaho.type.Property.Type#countMax.

Source: javascript/web/pentaho/type/property.js, line 743

Inherited From: pentaho.type.Property.Type#validate

See also:  pentaho.type.Complex#validate