Element
pentaho.type.Element
The base class of singular values.
AMD Module
require(["pentaho/type/element"], function(Element) { /* code goes here */ });
See also: pentaho.type.List
Extends
Constructor
Name | Description |
---|---|
new Element() | Creates an element instance. |
Classes
Name | Summary |
---|---|
Type | The base type class of singular value types. |
Members
Name | Description |
---|---|
$isValid : | Determines if this value is a valid instance of its type. |
$key : | Gets the key of the value. |
$type : | Gets the type of this instance. |
Methods
Name | Description |
---|---|
_configure(config) Protected | Configures this value with a given non-nully configuration. |
assertValid() | Ensures that the value is valid, and throws the first validation error if it is not. |
clone() : pentaho.type.Value Abstract | Creates a shallow clone of this value. |
configure(config) : pentaho.type.Value | Configures this value with a given configuration. |
equals(other) : boolean | Determines if a given value, of the same type, represents the same entity. |
toJSON() : UJsonValue | Creates a top-level JSON specification that describes this instance. |
toSpec(keyArgs) : pentaho.type.spec.UInstance | Creates a specification that describes this value. |
toSpecInContext(keyArgs) : any Abstract | Creates a specification that describes this instance. |
validate() : Array.< | Determines if this value is a valid instance of its type. |
Constructor Details
new Element() |
---|
Creates an element instance. Source: javascript/web/pentaho/type/element.js, line 39 See also: pentaho.type.List |
Members Details
$isValid: |
---|
Determines if this value is a valid instance of its type. This attribute calls Source: javascript/web/pentaho/type/value.js, line 123 Inherited From: pentaho.type.Value#$isValid |
$key: |
---|
Gets the key of the value. The key of a value must identify it among values of the same concrete type. Two values of the same concrete type and with the same key represent the same entity. The default implementation returns the result of calling Source: javascript/web/pentaho/type/value.js, line 82 Inherited From: pentaho.type.Value#$key See also: pentaho.type.Value#equals , pentaho.type.Value.Type#areEqual |
$type: |
---|
Gets the type of this instance. Source: javascript/web/pentaho/type/value.js, line 246 Inherited From: pentaho.type.Value#$type |
Methods Details
_configure(config) Protected | ||||||
---|---|---|---|---|---|---|
Configures this value with a given non-nully configuration. The default implementation does nothing. Source: javascript/web/pentaho/type/value.js, line 178 Inherited From: pentaho.type.Value#_configure
|
assertValid() | ||||
---|---|---|---|---|
Ensures that the value is valid, and throws the first validation error if it is not. This method calls the Source: javascript/web/pentaho/type/value.js, line 152 Inherited From: pentaho.type.Value#assertValid
|
clone() : pentaho.type.Value Abstract | ||||
---|---|---|---|---|
Creates a shallow clone of this value. Source: javascript/web/pentaho/type/value.js, line 86 Inherited From: pentaho.type.Value#clone
|
configure(config) : pentaho.type.Value | ||
---|---|---|
Configures this value with a given configuration. Source: javascript/web/pentaho/type/value.js, line 165 Inherited From: pentaho.type.Value#configure |
Name | Default Value | Summary |
---|---|---|
config : any | The configuration. |
Name | Description |
---|---|
pentaho.type.Value | This instance. |
equals(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a given value, of the same type, represents the same entity. The default implementation delegates the operation to the Source: javascript/web/pentaho/type/value.js, line 107 Inherited From: pentaho.type.Value#equals
See also: pentaho.type.Value#$key , pentaho.type.Value.Type#areEqual |
toJSON() : UJsonValue | ||||
---|---|---|---|---|
Creates a top-level JSON specification that describes this instance. Attributes which do not have a JSON-compatible specification are omitted. Specifically, for inline types, attributes with a function value are not supported. This method simply calls Source: javascript/web/pentaho/type/instance.js, line 210 Inherited From: pentaho.type.Instance#toJSON
See also: pentaho.type.Instance#toSpec |
toSpec(keyArgs) : pentaho.type.spec.UInstance | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this value. If an Source: javascript/web/pentaho/type/value.js, line 184 Inherited From: pentaho.type.Value#toSpec |
Name | Default Value | Summary | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
keyArgs : Object Optional | The keyword arguments object. Passed to every value and type serialized within this scope. Please see the documentation of value subclasses for information on additional, supported keyword arguments.
|
Name | Description |
---|---|
pentaho.type.spec.UInstance | A specification of this value. |
toSpecInContext(keyArgs) : any Abstract | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this instance. Source: javascript/web/pentaho/type/instance.js, line 190 Inherited From: pentaho.type.Instance#toSpecInContext
See also: pentaho.type.Instance#toSpec |
validate() : Array.< | ||||
---|---|---|---|---|
Determines if this value is a valid instance of its type. The default implementation delegates to Source: javascript/web/pentaho/type/value.js, line 137 Inherited From: pentaho.type.Value#validate
See also: pentaho.type.Value#$isValid |