Value
pentaho.type. Value
The base, abstract class of instances
which are the value of properties
.
A Value
has a key that uniquely identifies the entity it represents.
AMD Module
require(["pentaho/type/value"], function(Value) { /* code goes here */ });
See also: pentaho.type.spec.IValue , pentaho.type.spec.IValueProto , pentaho.type.spec.IValueTypeProto
Extends
Implements
Constructor
Name | Description |
---|---|
new Value(spec) Abstract | Creates a |
Classes
Name | Summary |
---|---|
Type | The base type class of value types. |
Members
Name | Description |
---|---|
$isValid : | Determines if this value is a valid. |
$key : | Gets the key of the value. |
$type : | Gets the type of this instance. |
Methods
Name | Description |
---|---|
extend(name, instSpec, classSpec, keyArgs) : Class.<<code>pentaho.type.Value > Static | Creates a subtype of this one. |
_configure(config) Protected | Configures this value with a given distinct and non- |
_equals(other) : boolean Protected | Gets a value that indicates if a given distinct, non-null value of the same type represents the same entity. |
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) | Configures this value with a given configuration. |
equals(other) : boolean | Determines if a given value represents the same entity. |
equalsContent(other) : boolean | Gets a value that indicates if a given equal value has the same content as this one. |
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.<<code>pentaho.type.ValidationError > | Determines if this value is valid. |
Constructor Details
new Value(spec) Abstract | ||||||
---|---|---|---|---|---|---|
Creates a Source: javascript/web/pentaho/type/value.js, line 46
See also: pentaho.type.spec.IValue , pentaho.type.spec.IValueProto , pentaho.type.spec.IValueTypeProto |
Members Details
$isValid: |
---|
Determines if this value is a valid. This attribute calls |
$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. If two values have the same concrete type and their keys are equal, then it must also be the case that The default implementation returns the result of calling Source: javascript/web/pentaho/type/value.js, line 89 See also: pentaho.type.Value#equals |
$type: |
---|
Gets the type of this instance. Source: javascript/web/pentaho/type/value.js, line 334 Overrides: pentaho.type.Instance#$type |
Methods Details
extend(name, instSpec, classSpec, keyArgs) : Class.<<code>pentaho.type.Value > Static | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a subtype of this one. For more information on class extension, in general, see Source: javascript/web/pentaho/type/value.js, line 556
See also: pentaho.type.Instance.extend |
_configure(config) Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Configures this value with a given distinct and non- This method can only be called when there is an ambient transaction. The default implementation throws an error if this value's type is Source: javascript/web/pentaho/type/value.js, line 264
See also: pentaho.type.Value#configure , pentaho.type.Complex#_configure , pentaho.type.List#_configure |
_equals(other) : boolean Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given distinct, non-null value of the same type represents the same entity. The default implementation considers two values equal if they have the equal keys. Source: javascript/web/pentaho/type/value.js, line 135
See also: pentaho.type.Value#equals , pentaho.type.Value#$key |
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 202
|
clone() : pentaho.type.Value Abstract | ||||
---|---|---|---|---|
Creates a shallow clone of this value. Source: javascript/web/pentaho/type/value.js, line 93
|
configure(config) | ||
---|---|---|
Configures this value with a given configuration. This method ensures a transaction exists and then delegates to For more information on the semantics of configuration, see |
Name | Default Value | Summary |
---|---|---|
config : any | The value configuration. |
Name | Description |
---|---|
TypeError | When the value would be changed and its type is |
See also: pentaho.type.Element#configureOrCreate , pentaho.type.Complex#_configure , pentaho.type.List#_configure
equals(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a given value represents the same entity. This method checks if the given value is identical to this one. Otherwise, if not Source: javascript/web/pentaho/type/value.js, line 116
See also: pentaho.type.Value#_equals |
equalsContent(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given equal value has the same content as this one. This method must only be called if the The default implementation returns Source: javascript/web/pentaho/type/value.js, line 152
See also: pentaho.type.Value#equals |
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 272 Overrides: pentaho.type.Instance#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.<<code>pentaho.type.ValidationError > | ||||
---|---|---|---|---|
Determines if this value is valid. 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 187
See also: pentaho.type.Value#$isValid |