Type
pentaho.type.Type
The root class of types that can be represented by the Pentaho Type API.
For additional information, see the associated instance class, pentaho.type.Instance
.
Constructor
Name | Description |
---|---|
new Type(spec, keyArgs) | Initializes the type's singleton 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. |
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. |
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. |
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 |
isBrowsable : | Gets or sets the |
isComplex : | |
isContainer : | Gets a value that indicates if this type |
isElement : | Gets a value that indicates if this type |
isList : | |
isProperty : | Gets a value that indicates if this type |
isRoot : | Gets a value that indicates if this type is the root of its type hierarchy. |
isSimple : | |
isValue : | |
label : | Gets or sets the label of this type. |
mixins : | Gets or sets the mixin types that are locally mixed into this 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. |
Methods
Name | Description |
---|---|
_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 to use when the label is not set. |
_init(spec, keyArgs) Protected | Performs initialization tasks that take place before the instance is extended with its specification. |
_postInit(spec, keyArgs) Protected | Performs initialization tasks that take place after the instance is extended with its specification. |
buildSourceRelativeId(id) : string | Builds an absolute module identifier from one that is relative to the type's |
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. |
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. |
Constructor Details
new Type(spec, keyArgs) | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Initializes the type's singleton object. Source: javascript/web/pentaho/type/_type.js, line 57
|
Members Details
_isLabelSet: Protected |
---|
Gets a value that indicates if the label is locally set. |
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 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 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 |
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 See also: pentaho.type.Type#isBrowsable , pentaho.type.Type#ordinal |
context: |
---|
Gets the context that defined this type class. |
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 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 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 |
hasDescendants: |
---|
Gets a value that indicates if this type has any descendant types. Source: javascript/web/pentaho/type/_type.js, line 279 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 See also: pentaho.type.Type#sourceId |
inheritedStyleClasses: |
---|
Gets the style classes of this and any base types. The returned array should not be modified. |
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 |
isAdvanced: |
---|
Gets or sets the Types with Setting this to a Source: javascript/web/pentaho/type/_type.js, line 830 See also: pentaho.type.Type#isBrowsable |
isBrowsable: |
---|
Gets or sets the Browsable types are exposed to the end user. Set this attribute to Setting this to a |
isComplex: |
---|
isContainer: |
---|
Gets a value that indicates if this type |
isElement: |
---|
Gets a value that indicates if this type |
isList: |
---|
isProperty: |
---|
Gets a value that indicates if this type |
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 See also: pentaho.type.Type#root |
isSimple: |
---|
isValue: |
---|
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 |
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 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 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 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 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 |
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. |
Methods Details
_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
See also: pentaho.type.Instance#toSpecInContext |
_getLabelDefault() : string Protected | ||||
---|---|---|---|---|
Gets the default label to use when the label is not set. Source: javascript/web/pentaho/type/_type.js, line 629
|
_init(spec, keyArgs) Protected | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 150
|
_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
|
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
See also: pentaho.type.Type#sourceId |
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
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
See also: pentaho.type.Type#create |
is(value) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a value is an instance of this type. Source: javascript/web/pentaho/type/_type.js, line 1179
|
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
|
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
|
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
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
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
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
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
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
|