Skip to main content
Pentaho Documentation

Replace

pentaho.type.changes.Replace

The Replace class describes the primitive operation that replaces the value of an element property of a complex instance.

This type of change is always part of a pentaho.type.changes.ComplexChangeset.

AMD Module

require(["pentaho/type/changes/Replace"], function(Replace) { /* code goes here */ });

Extends

Constructor

Name Description
new Replace(propType, value)

Creates an instance.

Members

Name Description
base : function
 
Protected

If a method has been overridden, then the base method provides access to the overridden method.

property : pentaho.type.Property.Type

Gets the property whose value is replaced.

type : string

Gets the type of change.

value : pentaho.type.Element

Gets the value that will replace the current value of the property.

Methods

Name Description
_apply(target)
 
Protected

Applies any local primitive changes.

extend(source, keyArgs) : Object

Extend an object with the properties of another.

Constructor Details

new Replace(propType, value)

Creates an instance.

Source: javascript/web/pentaho/type/changes/Replace.js, line 47

Parameters:
Name Default Value Summary
propType : pentaho.type.Property.Type

The property type.

value : pentaho.type.Element

The proposed value of the property.

Members Details

base: function
 
Protected

If a method has been overridden, then the base method provides access to the overridden method.

Can also be called from within a constructor function.

Source: javascript/web/pentaho/lang/Base.js, line 265

Inherited From: pentaho.lang.Base#base

property: pentaho.type.Property.Type

Gets the property whose value is replaced.

Source: javascript/web/pentaho/type/changes/Replace.js, line 48

type: string

Gets the type of change.

Source: javascript/web/pentaho/type/changes/Replace.js, line 99

Default Value: "replace"

Overrides: pentaho.type.changes.PrimitiveChange#type

value: pentaho.type.Element

Gets the value that will replace the current value of the property.

Source: javascript/web/pentaho/type/changes/Replace.js, line 109

Methods Details

_apply(target)
 
Protected

Applies any local primitive changes.

Source: javascript/web/pentaho/type/changes/Change.js, line 50

Overrides: pentaho.type.changes.PrimitiveChange#_apply

Parameters:
Name Default Value Summary
target : pentaho.type.ContainerMixin

The container to which changes are applied.

extend(source, keyArgs) : Object

Extend an object with the properties of another.

Methods that are overridden are accessible through this.base.

This object is extended, but its class doesn't change.

Can be applied to non-Base instances (e.g. using Base.prototype.extend.call(alien, {a: "hello"})).

Source: javascript/web/pentaho/lang/Base.js, line 808

Inherited From: pentaho.lang.Base#extend

Parameters:
Name Default Value Summary
source : Object

The instance specification.

keyArgs : Object
 
Optional

The keyword arguments.

Parameters:
Name Default Value Summary
exclude : Object
 
Optional

A map of property names to exclude from source.

Returns:
Name Description
Object

This object.