Type

Source: javascript/web/pentaho/type/complex.js, line 47

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

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

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

Overrides: pentaho.type.Element.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 268

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 697

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 766

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 183

Inherited From: pentaho.type.Type#context

Gets the number of properties of the complex type.

Source: javascript/web/pentaho/type/complex.js, line 989

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

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

Inherited From: pentaho.type.Type#defaultView

See also: pentaho.type.Type#buildSourceRelativeId

Gets the absolute view module identifier, if any.

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

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

Inherited From: pentaho.type.Type#defaultViewAbs

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 726

Inherited From: pentaho.type.Type#description

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

Inherited From: pentaho.type.Type#elementType

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

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

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

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 802

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 452

Inherited From: pentaho.type.Type#id

See also: pentaho.type.Type#sourceId

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 935

Inherited From: pentaho.type.Type#inheritedStyleClasses

Gets the prototype of the instances of this type.

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

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

Default Value: false

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

Inherited From: pentaho.type.Type#isAdvanced

See also: pentaho.type.Type#isBrowsable

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 835

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 377

Overrides: pentaho.type.Element.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 342

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

Inherited From: pentaho.type.Type#isContinuous

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

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

Inherited From: pentaho.type.Type#isElement

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

An entity type is an element type that represents a business entity whose identity is reflected by the $key property.

Simple types are inherently entity types. Complex types can set this property to true, and override the $key property, to become entity types.

Source: javascript/web/pentaho/type/value.js, line 358

Overrides: pentaho.type.Element.Type#isEntity

See also: pentaho.type.Value#$key

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

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

Inherited From: pentaho.type.Type#isList

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

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

Inherited From: pentaho.type.Type#isProperty

Gets a value that indicates whether this type, and all of the value types of any property values, cannot be changed, from the outside.

The value of Complex#isReadOnly is false.

A Complex type is necessarily read-only if its base complex type is read-only. Otherwise, a Complex type can be marked read-only, but only upon definition and if the base complex type does not have any properties.

All of the properties of a read-only complex type are implicitly marked read-only. When the valueType of a property is an element type, it must be a read-only type. When the valueType of a property is a list type, then its element type must be read-only.

Source: javascript/web/pentaho/type/complex.js, line 835

Overrides: pentaho.type.Element.Type#isReadOnly

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

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

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 389

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 317

Inherited From: pentaho.type.Type#isValue

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 640

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

Inherited From: pentaho.type.Type#mixins

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 969

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 209

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 497

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 482

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 913

Inherited From: pentaho.type.Type#styleClass

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 203

Inherited From: pentaho.type.Type#uid

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

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

Inherited From: pentaho.type.Type#_assertNoSubtypesAttribute

Adds, overrides or configures properties of this complex type.

Source: javascript/web/pentaho/type/complex.js, line 871

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 1375

Overrides: pentaho.type.Element.Type#_fillSpecInContext

See also: pentaho.type.Instance#toSpecInContext

Gets the default label to use when the label is not set.

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

Inherited From: pentaho.type.Type#_getLabelDefault

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

This method is typically overridden to block the inheritance of certain attributes.

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

Overrides: pentaho.type.Element.Type#_init

Actually normalizes a given non-Nully value specification.

Override this method to improve the Type API support for types that have a non-generic serialization format.

The default implementation simply returns the given value specification.

Source: javascript/web/pentaho/type/value.js, line 507

Inherited From: pentaho.type.Value.Type#_normalizeInstanceSpec

See also: pentaho.type.Value.Type#normalizeInstanceSpec

Normalizes a properties specification.

Source: javascript/web/pentaho/type/complex.js, line 884

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 172

Inherited From: pentaho.type.Type#_postInit

Adds, overrides or configures properties of this complex type.

Source: javascript/web/pentaho/type/complex.js, line 1070

Gets a value that indicates if two given values are considered equal.

Two values are considered equal if they represent the same real-world entity.

The execution proceeds as follows:

1. If either of the values is Nully, then they're equal only if both are Nully;
2. Otherwise, execution is delegated to the first value's pentaho.type.Value#equals method.

Source: javascript/web/pentaho/type/value.js, line 410

Inherited From: pentaho.type.Value.Type#areEqual

See also: pentaho.type.Value#$key , pentaho.type.Value#equals

Gets a value that indicates if two values are equal and content-equal.

Checks that both values are equals and equalsContent.

Source: javascript/web/pentaho/type/value.js, line 430

Inherited From: pentaho.type.Value.Type#areEqualContent

Gets a value that indicates if all of the elements of two lists of the same type are content-equal.

Source: javascript/web/pentaho/type/value.js, line 444

Inherited From: pentaho.type.Value.Type#areEqualContentElements

Gets the property type object of the property with a given index, if in range, or null if not.

Source: javascript/web/pentaho/type/complex.js, line 970

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 519

Inherited From: pentaho.type.Type#buildSourceRelativeId

See also: pentaho.type.Type#sourceId

Compares two element values according to their order.

Execution proceeds as follows:

1. If both values are Nully, they have the same order.
2. Otherwise, if the first value is Nully (and the second is not), it is before the second one.
3. Othewise, the operation is delegated to the first value's pentaho.type.Element#compare method.

Source: javascript/web/pentaho/type/element.js, line 297

Inherited From: pentaho.type.Element.Type#compareElements

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

Inherited From: pentaho.type.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}
 ]);

 // ...
 });
});

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

Inherited From: pentaho.type.Type#createAsync

See also: pentaho.type.Type#create

Creates a value of this type based on a given value except with a given configuration applied.

If this is an entity type, it can only be called if either the given configuration does not contain entity key information or if it contains the same entity key information as the given value.

The default implementation obtains the specification of the given value, merges it with the given configuration, and creates a new value from the resulting specification.

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

Inherited From: pentaho.type.Element.Type#createLike

See also: pentaho.type.Value.Type#isEntity , pentaho.type.Value#$key , pentaho.type.Type#hasNormalizedInstanceSpecKeyData

Calls a function for each defined property type.

Source: javascript/web/pentaho/type/complex.js, line 1005

Calls a function for each defined property type that this type shares with another given type and whose value can, in principle, be copied from it.

This method finds the lowest common ancestor of both types. If it is a complex type, each of the corresponding local properties is yielded.

Source: javascript/web/pentaho/type/complex.js, line 1034

Gets the type object of the property with the given name, or null if it is not defined.

If a property type object is specified, it is returned back only if it is the property type object of same name in this complex type.

Source: javascript/web/pentaho/type/complex.js, line 919

Gets a value that indicates if a given property is defined.

If a property type object is specified, this method tests whether it is the same property type object that exists under that name, if any.

Source: javascript/web/pentaho/type/complex.js, line 950

Gets a value that indicates if a given normalized value specification has any key information.

The default implementation returns false.

Source: javascript/web/pentaho/type/value.js, line 524

Inherited From: pentaho.type.Value.Type#hasNormalizedInstanceSpecKeyData

See also: pentaho.type.Value.Type#isEntity , pentaho.type.Value.Type#normalizeInstanceSpec , pentaho.type.Value#$key

Determines if a value is an instance of this type.

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

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 1251

Inherited From: pentaho.type.Type#isSubtypeOf

Normalizes a given value specification.

Usually, "deserialization" is handled in a type's constructor. However, for proper handling of the configure operation, the Type API needs to normalize new value specifications to decide whether it can configure operations an existing instance instead of constructing a new one. This, obviously, has to be done outside of a constructor.

For example, some complex types can serialize as a single string if only its main property is specified. In such cases, this method would return a normal, object, generic specification containing the given value as the value of the main property.

This method calls the _normalizeInstanceSpec when the specified value specification is not Nully.

Source: javascript/web/pentaho/type/value.js, line 487

Inherited From: pentaho.type.Value.Type#normalizeInstanceSpec

See also: pentaho.type.Value.Type#_normalizeInstanceSpec

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 1272

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 1350

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 1468

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 1488

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 1303

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 1326

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 1499

Inherited From: pentaho.type.Type#toString