Type
pentaho.type.Element.Type
The base type class of singular value types.
For more information see pentaho.type.Element
.
Extends
Constructor
Name | Description |
---|---|
new Type() Static |
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 |
---|---|
_areEqual(va, vb) : boolean Protected | Gets a value that indicates if two distinct, non- |
_compare(va, vb) : number Protected | Compares two non-equal, non- |
_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. |
_isEqual(va, vb) : boolean Protected | Gets a value that indicates if one instance of this type is considered equal to a distinct, non-nully value, but possibly not a value instance. |
_postInit(spec, keyArgs) Protected | Performs initialization tasks that take place after the instance is extended with its specification. |
_validate(value) : Array.< Protected | Determines if a value, that is an instance of this type, is also a valid instance of this type. |
areEqual(va, vb) : boolean | Gets a value that indicates if two given values are considered equal. |
buildSourceRelativeId(id) : string | Builds an absolute module identifier from one that is relative to the type's |
compare(va, vb) : number | Compares two values according to their order. |
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. |
isValid(value) : boolean | Determines if a value is a valid instance of this type. |
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. |
validate(value) : Array.< | Determines if a value is a valid instance of this type. |
Constructor Details
new Type() Static |
---|
Members Details
_isLabelSet: Protected |
---|
Gets a value that indicates if the label is locally set. Source: javascript/web/pentaho/type/_type.js, line 640 Inherited From: pentaho.type.Type#_isLabelSet |
alias: |
---|
Gets the alias for the identifier of this type. The alias of a type can only be specified when extending the ancestor type. This attribute is not inherited. When unspecified, defaults to Source: javascript/web/pentaho/type/_type.js, line 503 Overrides: pentaho.type.Value.Type#alias See also: pentaho.type.Type#id |
ancestor: |
---|
Gets the parent type in the current type hierarchy, if any, or The root type returns Source: javascript/web/pentaho/type/_type.js, line 266 Inherited From: pentaho.type.Type#ancestor See also: pentaho.type.Type#root , pentaho.type.Type#hasDescendants |
application: |
---|
Gets or sets the The application property serves as a collection of properties specific to the container application that can be modified via the Setting this to a Source: javascript/web/pentaho/type/_type.js, line 658 Inherited From: pentaho.type.Type#application |
category: |
---|
Gets or sets the category associated with this type. The category is used primarily to group similar types (or instances of) in a user interface. Attempting to set to a non-string value type implicitly converts the value to a string before assignment. Setting this to Setting this to Source: javascript/web/pentaho/type/_type.js, line 727 Inherited From: pentaho.type.Type#category See also: pentaho.type.Type#isBrowsable , pentaho.type.Type#ordinal |
context: |
---|
Gets the context that defined this type class. Source: javascript/web/pentaho/type/_type.js, line 181 Inherited From: pentaho.type.Type#context |
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 Inherited From: pentaho.type.Type#defaultView See also: pentaho.type.Type#buildSourceRelativeId |
defaultViewAbs: |
---|
Gets the absolute view module identifier, if any. A default view exists if property Source: javascript/web/pentaho/type/_type.js, line 1008 Inherited From: pentaho.type.Type#defaultViewAbs See also: pentaho.type.Type#defaultView |
description: |
---|
Gets or sets the description of this type. Attempting to set to a non-string value type implicitly converts the value to a string before assignment. Setting this to Setting this to Source: javascript/web/pentaho/type/_type.js, line 687 Inherited From: pentaho.type.Type#description |
hasDescendants: |
---|
Gets a value that indicates if this type has any descendant types. Source: javascript/web/pentaho/type/_type.js, line 279 Inherited From: pentaho.type.Type#hasDescendants See also: pentaho.type.Type#ancestor |
helpUrl: |
---|
Gets or sets a URL pointing to documentation associated with this type. Attempting to set to a non-string value type implicitly converts the value to a string before assignment. Setting this to Setting this to Source: javascript/web/pentaho/type/_type.js, line 763 Inherited From: pentaho.type.Type#helpUrl |
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 Inherited From: pentaho.type.Type#id See also: pentaho.type.Type#sourceId |
inheritedStyleClasses: |
---|
Gets the style classes of this and any base types. The returned array should not be modified. Source: javascript/web/pentaho/type/_type.js, line 896 Inherited From: pentaho.type.Type#inheritedStyleClasses |
instance: |
---|
Gets the prototype of the instances of this type. Source: javascript/web/pentaho/type/_type.js, line 291 Inherited From: pentaho.type.Type#instance |
isAbstract: |
---|
Gets a value that indicates if this type is abstract. This attribute can only be set once, upon the type definition. Source: javascript/web/pentaho/type/_type.js, line 526 Default Value: false Overrides: pentaho.type.Value.Type#isAbstract |
isAdvanced: |
---|
Gets or sets the Types with Setting this to a Source: javascript/web/pentaho/type/_type.js, line 830 Inherited From: pentaho.type.Type#isAdvanced 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 Source: javascript/web/pentaho/type/_type.js, line 796 Inherited From: pentaho.type.Type#isBrowsable |
isComplex: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 376 Inherited From: pentaho.type.Type#isComplex |
isContainer: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 340 Inherited From: pentaho.type.Type#isContainer |
isElement: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 364 Overrides: pentaho.type.Value.Type#isElement |
isList: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 352 Inherited From: pentaho.type.Type#isList |
isProperty: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 327 Inherited From: pentaho.type.Type#isProperty |
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 Inherited From: pentaho.type.Type#isRoot See also: pentaho.type.Type#root |
isSimple: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 388 Inherited From: pentaho.type.Type#isSimple |
isValue: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 315 Inherited From: pentaho.type.Type#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 Source: javascript/web/pentaho/type/_type.js, line 601 Inherited From: pentaho.type.Type#label |
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 Source: javascript/web/pentaho/type/_type.js, line 545 Inherited From: pentaho.type.Type#mixins |
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 Inherited From: pentaho.type.Type#ordinal See also: pentaho.type.Type#isBrowsable , pentaho.type.Type#category |
root: |
---|
Gets the root type of this type hierarchy. Even though the ultimate type root of types defined in this system is When deriving a type from Typically, root types are immediate subtypes of For example, Source: javascript/web/pentaho/type/_type.js, line 207 Inherited From: pentaho.type.Type#root See also: pentaho.type.Type#isRoot , pentaho.type.Type#ancestor |
shortId: |
---|
Gets the short identifier of this type. The short identifier of a type is equal to its alias, provided it is defined. Otherwise, it is equal to the identifier. Source: javascript/web/pentaho/type/_type.js, line 461 Inherited From: pentaho.type.Type#shortId See also: pentaho.type.Type#id , pentaho.type.Type#alias |
sourceId: |
---|
Gets the source module identifier of this type. The source identifier is the module identifier of the actual AMD/RequireJS module that provides the type and may be different from the The source identifier is used to resolve module identifiers relative to the source module, as is the case with the The source identifier of a type can only be specified when extending the ancestor type. This attribute is not inherited. When unspecified, defaults to the value of Source: javascript/web/pentaho/type/_type.js, line 446 Inherited From: pentaho.type.Type#sourceId See also: pentaho.type.Type#id , pentaho.type.Type#defaultView |
styleClass: |
---|
Gets or sets the CSS class associated with this type. This attribute is typically used to associate an icon with a type. Attempting to set to a non-string value type implicitly converts the value to a string before assignment. An empty string or Setting to The default value of a type with an Source: javascript/web/pentaho/type/_type.js, line 874 Inherited From: pentaho.type.Type#styleClass |
uid: |
---|
Gets the unique identifier of this type. Unique type identifiers are auto-generated in each session. Note that even anonymous types (those whose This attribute is not inherited. Source: javascript/web/pentaho/type/_type.js, line 201 Inherited From: pentaho.type.Type#uid |
Methods Details
_areEqual(va, vb) : boolean Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if two distinct, non- The default implementation checks if one of the values is a value instance, and, if so, delegates the operation to its type's Source: javascript/web/pentaho/type/value.js, line 299 Inherited From: pentaho.type.Value.Type#_areEqual
See also: pentaho.type.Value.Type#areEqual |
_compare(va, vb) : number Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Compares two non-equal, non- The default implementation compares the two values by natural ascending order of their data type. If both values are numbers, numeric order is used. Otherwise, their string representations are compared in lexicographical order. Source: javascript/web/pentaho/type/element.js, line 139
|
_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 Inherited From: pentaho.type.Type#_fillSpecInContext
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 Inherited From: pentaho.type.Type#_getLabelDefault
|
_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 Inherited From: pentaho.type.Type#_init
|
_isEqual(va, vb) : boolean Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if one instance of this type is considered equal to a distinct, non-nully value, but possibly not a value instance. The default implementation considers two values equal if they have the same constructor and equal keys. Source: javascript/web/pentaho/type/value.js, line 321 Inherited From: pentaho.type.Value.Type#_isEqual
See also: pentaho.type.Value.Type#areEqual |
_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 Inherited From: pentaho.type.Type#_postInit
|
_validate(value) : Array.< Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a value, that is an instance of this type, is also a valid instance of this type. Thus, The default implementation does nothing and considers the instance valid. Override to implement a type's specific validation logic. You can use the error utilities in Source: javascript/web/pentaho/type/value.js, line 394 Inherited From: pentaho.type.Value.Type#_validate
See also: pentaho.type.Value.Type#validate |
areEqual(va, vb) : boolean | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. If two values are considered equal, their value instances must have an equal If the values are identical as per JavaScript's Source: javascript/web/pentaho/type/value.js, line 280 Inherited From: pentaho.type.Value.Type#areEqual
See also: pentaho.type.Value#$key , pentaho.type.Value.Type#_areEqual , pentaho.type.Value.Type#_isEqual |
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 Inherited From: pentaho.type.Type#buildSourceRelativeId
See also: pentaho.type.Type#sourceId |
compare(va, vb) : number | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Compares two values according to their order. If the two values are identical, as per JavaScript's Source: javascript/web/pentaho/type/element.js, line 114
|
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 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} ]); // ... }); }); |
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 Inherited From: pentaho.type.Type#createAsync
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 Inherited From: pentaho.type.Type#is
|
isSubtypeOf(superType) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if this is a subtype of another. A type is considered a subtype of itself. Source: javascript/web/pentaho/type/_type.js, line 1191 Inherited From: pentaho.type.Type#isSubtypeOf
|
isValid(value) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a value is a valid instance of this type. This method calls The Source: javascript/web/pentaho/type/value.js, line 341 Inherited From: pentaho.type.Value.Type#isValid
|
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 Inherited From: pentaho.type.Type#to
|
toJSON() : UJsonValue | ||||
---|---|---|---|---|
Creates a JSON specification that describes this type. Attributes which do not have a JSON-compatible specification are omitted. Specifically, attributes with a function value are not supported. This method simply calls Source: javascript/web/pentaho/type/_type.js, line 1290 Inherited From: pentaho.type.Type#toJSON
See also: pentaho.type.Instance#toSpec |
toRef(keyArgs) : pentaho.type.spec.UTypeReference | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Returns a reference to this type. This method returns a reference to this type that is appropriate to be the value of an If an When a type is not anonymous, the For anonymous types, a Some standard types have a special reference syntax. For example: Source: javascript/web/pentaho/type/_type.js, line 1408 Inherited From: pentaho.type.Type#toRef
See also: pentaho.type.Type#toSpec |
toRefInContext(keyArgs) : pentaho.type.spec.UTypeReference | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Returns a reference to this type under a given specification context. This method requires that there currently exists an Source: javascript/web/pentaho/type/_type.js, line 1428 Inherited From: pentaho.type.Type#toRefInContext
See also: pentaho.type.Type#toRef |
toSpec(keyArgs) : pentaho.type.spec.ITypeProto | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this type. If an This method creates a new Source: javascript/web/pentaho/type/_type.js, line 1243 Inherited From: pentaho.type.Type#toSpec
See also: pentaho.type.Type#toSpecInContext , pentaho.type.Type#_fillSpecInContext |
toSpecInContext(keyArgs) : pentaho.type.spec.ITypeProto | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this type. This method requires that there currently exists an The default implementation returns a plain object with the identifier of the type and any other specified attributes (like Source: javascript/web/pentaho/type/_type.js, line 1266 Inherited From: pentaho.type.Type#toSpecInContext
See also: pentaho.type.Type#toSpec |
toString() : string | ||||
---|---|---|---|---|
Returns a textual representation suitable to identify this type in an error message. Source: javascript/web/pentaho/type/_type.js, line 1439 Inherited From: pentaho.type.Type#toString
|
validate(value) : Array.< | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a value is a valid instance of this type. Validation of
Source: javascript/web/pentaho/type/value.js, line 363 Inherited From: pentaho.type.Value.Type#validate
See also: pentaho.type.Value#validate , pentaho.type.Value.Type#isValid , pentaho.type.Value.Type#_validate |