Type
pentaho.type.Value. Type
The base type class of value types.
Value types can be singular or plural (isList
). A Value type should not be instantiated if it is abstract
.
For more information see pentaho.type.Value
.
Extends
Implements
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. |
elementType : | Gets the element type 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 |
isContinuous : | Gets a value that indicates if this is a continuous type. |
isElement : | Gets a value that indicates if this type |
isEntity : | Gets a value that indicates if this type is an entity type. |
isList : | |
isProperty : | Gets a value that indicates if this type |
isReadOnly : | Gets a value that indicates whether this type, and all of the types of any contained values, cannot be changed, from the outside. |
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 |
---|---|
_assertNoSubtypesAttribute(attributeName) Protected | Asserts that the type has no subtypes and that as such the given attribute can be set. |
_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) : pentaho.type.spec.ITypeProto Protected | Performs initialization tasks that take place before the instance is extended with its specification. |
_normalizeInstanceSpec(instSpec) : any Protected | Actually normalizes a given non- |
_postInit(spec, keyArgs) Protected | Performs initialization tasks that take place after the instance is extended with its specification. |
areEqual(valueA, valueB) : boolean | Gets a value that indicates if two given values are considered equal. |
areEqualContent(valueA, valueB) : boolean | Gets a value that indicates if two values are equal and content-equal. |
areEqualContentElements(listA, listB) : boolean | Gets a value that indicates if all of the elements of two lists of the same type are content-equal. |
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.<<code>pentaho.type.Instance > | Creates or resolves an instance of this type, asynchronously, given an instance reference. |
hasNormalizedInstanceSpecKeyData(instSpec) : boolean | Gets a value that indicates if a given normalized value specification has any key information. |
is(value) : boolean | Determines if a value is an instance of this type. |
isSubtypeOf(superType) : boolean | Determines if this is a subtype of another. |
normalizeInstanceSpec(instSpec) : object | Normalizes a given value specification. |
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() Static |
---|
Members Details
_isLabelSet: Protected |
---|
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 |
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 542 Overrides: pentaho.type.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 268 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 697 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 766 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 183 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 1015 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 1050 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 726 Inherited From: pentaho.type.Type#description |
elementType: |
---|
Gets the element type of this type. If this type is a 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 |
hasDescendants: |
---|
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 |
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 802 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 452 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 935 Inherited From: pentaho.type.Type#inheritedStyleClasses |
instance: |
---|
Gets the prototype of the instances of this type. Source: javascript/web/pentaho/type/_type.js, line 293 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 565 Default Value: false Overrides: pentaho.type.Type#isAbstract |
isAdvanced: |
---|
Gets or sets the Types with Setting this to a Source: javascript/web/pentaho/type/_type.js, line 869 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 835 Inherited From: pentaho.type.Type#isBrowsable |
isComplex: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 377 Inherited From: pentaho.type.Type#isComplex |
isContainer: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 342 Inherited From: pentaho.type.Type#isContainer |
isContinuous: |
---|
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 Source: javascript/web/pentaho/type/_type.js, line 405 Inherited From: pentaho.type.Type#isContinuous |
isElement: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 366 Inherited From: pentaho.type.Type#isElement |
isEntity: |
---|
Gets a value that indicates if this type is an entity type. An entity type is an
Source: javascript/web/pentaho/type/value.js, line 358 See also: pentaho.type.Value#$key |
isList: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 354 Inherited From: pentaho.type.Type#isList |
isProperty: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 329 Inherited From: pentaho.type.Type#isProperty |
isReadOnly: |
---|
Gets a value that indicates whether this type, and all of the types of any contained values, cannot be changed, from the outside.
A
The default implementation returns |
isRoot: |
---|
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 |
isSimple: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 389 Inherited From: pentaho.type.Type#isSimple |
isValue: |
---|
Gets a value that indicates if this type Source: javascript/web/pentaho/type/_type.js, line 317 Overrides: 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 640 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 584 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 969 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 209 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 497 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 482 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 913 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 203 Inherited From: pentaho.type.Type#uid |
Methods Details
_assertNoSubtypesAttribute(attributeName) Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
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
|
_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 1375 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 668 Inherited From: pentaho.type.Type#_getLabelDefault
|
_init(spec, keyArgs) : pentaho.type.spec.ITypeProto 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 152 Inherited From: pentaho.type.Type#_init
|
_normalizeInstanceSpec(instSpec) : any Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Actually normalizes a given non- 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
|
_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 172 Inherited From: pentaho.type.Type#_postInit
|
areEqual(valueA, valueB) : 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. The execution proceeds as follows:
Source: javascript/web/pentaho/type/value.js, line 410
See also: pentaho.type.Value#$key , pentaho.type.Value#equals |
areEqualContent(valueA, valueB) : boolean | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if two values are equal and content-equal. Checks that both values are Source: javascript/web/pentaho/type/value.js, line 430
|
areEqualContentElements(listA, listB) : boolean | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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
|
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 519 Inherited From: pentaho.type.Type#buildSourceRelativeId
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 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} ]); // ... }); }); |
createAsync(instRef, instKeyArgs) : Promise.<<code>pentaho.type.Instance > | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 1178 Inherited From: pentaho.type.Type#createAsync
See also: pentaho.type.Type#create |
hasNormalizedInstanceSpecKeyData(instSpec) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given normalized value specification has any key information. The default implementation returns Source: javascript/web/pentaho/type/value.js, line 524
See also: pentaho.type.Value.Type#isEntity , pentaho.type.Value.Type#normalizeInstanceSpec , pentaho.type.Value#$key |
is(value) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
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
|
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 1251 Inherited From: pentaho.type.Type#isSubtypeOf
|
normalizeInstanceSpec(instSpec) : object | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Normalizes a given value specification. Usually, "deserialization" is handled in a type's constructor. However, for proper handling of the 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 Source: javascript/web/pentaho/type/value.js, line 487
|
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 1272 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 1350 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 1468 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 1488 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 1303 Inherited From: pentaho.type.Type#toSpec |
Name | Default Value | Summary | ||||||
---|---|---|---|---|---|---|---|---|
keyArgs : Object Optional | The keyword arguments object. Passed to every type and instance serialized within this scope. Please see the documentation of subclasses for information on additional, supported keyword arguments.
|
Name | Description |
---|---|
pentaho.type.spec.ITypeProto | A specification of this type. |
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 1326 Overrides: 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 1499 Inherited From: pentaho.type.Type#toString
|