False
pentaho.type.filter.False
The False
type represents a filter that encompasses no data.
In terms of set operations, the False
filter corresponds to the empty set.
AMD Module
require(["{pentaho.type.Factory} pentaho/type/filter/true"], function(False) { /* code goes here */ });
Extends
Constructor
Name | Description |
---|---|
new False() |
Classes
Name | Summary |
---|---|
Type | The type class of the |
Members
Name | Description |
---|---|
instance : Static | Gets the false filter instance. |
$references : | Gets the references to this container, or |
$uid : | Gets the unique identifier of the instance. |
$version : | Gets the current version of the instance. |
base : Protected | If a method has been overridden, then the base method provides access to the overridden method. |
changeset : | Gets the changeset of this instance in the ambient transaction, if any, or |
contentKey : | Gets a key that identifies the content of this filter. |
isNot : | Gets a value that indicates if this filter is a |
isProperty : | Gets a value that indicates if this filter is a |
isTerminal : | Gets a value that indicates if this filter is terminal. |
isValid : | Determines if this value is a valid instance of its type. |
key : | Gets the key of the complex value. |
kind : | Gets the kind of this filter. |
type : | Gets the type of this instance. |
Methods
Name | Description |
---|---|
_buildContentKey() : string Abstract Protected | Builds the content key. |
_clone(clone) Protected | Initializes a clone of this complex value. |
_configure(config) Protected | Configures this value with a given non-nully configuration. |
_contains(elem) : boolean Abstract Protected | Actual implementation that determines if an element is selected by this filter. |
_createChangeset(transaction) : pentaho.type.changes.Changeset Abstract Protected | Creates a changeset with this container as owner and returns it. |
_emit(event) : pentaho.lang.Event Protected | Emits an unstructured event and returns it, unless it was canceled. |
_emitGeneric(event, type, phase, keyArgs) : object Protected | Emits an event given an arbitrary payload object, its type and phase. Returns the event payload object, unless the event is canceled. |
_emitSafe(event) : pentaho.lang.Event Protected | Variation of the |
_hasListeners(type, phase) : boolean Protected | Determines if there are any registrations for a given event type and phase. |
_hasObservers(type) : boolean Protected | Determines if there are any registrations for a given event type, for at least one of its phases. |
_initValue(value, propType) : pentaho.type.Value Protected | Allows further initializing the value of a property. |
_onChangeDid(changeset) Protected | Called after a changeset has been committed. |
_onChangeRejected(changeset, reason) Protected | Called after a changeset has been rejected. |
_onChangeWill(changeset) : pentaho.lang.UserError | undefined Protected | Called before a changeset is committed. |
_visitDefault(transformer) : pentaho.type.filter.Abstract | Creates a filter that is the default transformed version of this filter. |
and(filters) : pentaho.type.filter.Abstract | Creates a filter that is the conjunction (intersection) between this filter and a variable number of other filters. |
andNot(exclude) : pentaho.type.filter.Abstract | Creates a filter that is the "difference" between this filter and a variable number of other filters. |
assertValid() | Ensures that the value is valid, and throws the first validation error if it is not. |
at(name, index, sloppy) : pentaho.type.Element | Nully | Gets one |
atf(name, index, sloppy) : string | Gets the string representation of one element of the value of a property, given the property and the index of the element. |
atv(name, index, sloppy) : any | pentaho.type.Complex | Nully | Gets the primitive value of one element of the value of a property, given the property and the index of the element. |
clone() : pentaho.type.Complex | Creates a shallow clone of this complex value. |
configure(config) : pentaho.type.Value | Configures this value with a given configuration. |
contains(elem) : boolean | Determines if an element is selected by this filter. |
count(name, sloppy) : number | Gets the number of values of a given property. |
countRange(name) : pentaho.IRange | Gets the current valid count range of values of a given property. |
equals(other) : boolean | Determines if a given value, of the same type, represents the same entity. |
extend(source, keyArgs) : Object | Extend an object with the properties of another. |
first(name, sloppy) : pentaho.type.Element | Nully | Gets the first element of the value of a property. |
firstf(name, sloppy) : string | Gets the string representation of the first element of the value of a property. |
firstv(name, sloppy) : any | pentaho.type.Complex | Nully | Gets the primitive value of the first element of the value of a property. |
get(name, sloppy) : pentaho.type.Value | Nully | Gets the value of a property. |
getf(name, sloppy) : string | Gets the string representation of the value of a property. |
getv(name, sloppy) : any | pentaho.type.Complex | pentaho.type.List | Nully | Gets the primitive value of the value of a property. |
isApplicable(name) : boolean | Gets a value that indicates if a given property is currently applicable. |
isEnabled(name) : boolean | Gets a value that indicates if a given property is currently enabled. |
isRequired(name) : boolean | Gets a value that indicates if a given property is currently required. |
negate() : pentaho.type.filter.Abstract | Creates a filter that is the negation of this filter. |
off(typeOrHandle, observer) | Removes one registration given its handle, or all registrations of a given event type (or types) and observer (or listener function). |
on(type, observer, keyArgs) : pentaho.lang.IEventRegistrationHandle | Registers an observer (or listener function) for an event(s) of a given type(s). |
or(filters) : pentaho.type.filter.Abstract | Creates a filter that is the disjunction (union) between this filter and a variable number of other filters. |
path(steps, sloppy) : pentaho.type.Value | Nully | Gets the value of a property/index/key path based on the current complex. |
set(name, valueSpec) | Sets the value of a property. |
toDnf() : pentaho.type.filter.True | pentaho.type.filter.False | pentaho.type.filter.Or | Converts a copy of this filter into Disjunctive Normal Form and returns it. |
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 | Creates a specification that describes this instance. |
validate() : Array.< | Determines if this complex value is a valid instance of its type. |
visit(transformer) : pentaho.type.filter.Abstract | Creates a filter that is a transformed version of this filter. |
Constructor Details
new False() |
---|
Source: javascript/web/pentaho/type/filter/_core/false.js, line 36 |
Members Details
instance: Static |
---|
Gets the false filter instance. Source: javascript/web/pentaho/type/filter/_core/false.js, line 89 |
$references: |
---|
Gets the references to this container, or Note that the returned array may be empty. Do NOT change the returned array or its elements in any way. Source: javascript/web/pentaho/type/ContainerMixin.js, line 119 Inherited From: pentaho.type.ContainerMixin#$references |
$uid: |
---|
Gets the unique identifier of the instance. Source: javascript/web/pentaho/type/ContainerMixin.js, line 103 Inherited From: pentaho.type.ContainerMixin#$uid |
$version: |
---|
Gets the current version of the instance. Source: javascript/web/pentaho/type/ContainerMixin.js, line 150 Inherited From: pentaho.type.ContainerMixin#$version |
base: 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 |
changeset: |
---|
Gets the changeset of this instance in the ambient transaction, if any, or Source: javascript/web/pentaho/type/ContainerMixin.js, line 175 Inherited From: pentaho.type.ContainerMixin#changeset |
contentKey: |
---|
Gets a key that identifies the content of this filter. Source: javascript/web/pentaho/type/filter/abstract.js, line 125 Inherited From: pentaho.type.filter.Abstract#contentKey |
isNot: |
---|
Gets a value that indicates if this filter is a Source: javascript/web/pentaho/type/filter/abstract.js, line 105 Inherited From: pentaho.type.filter.Abstract#isNot |
isProperty: |
---|
Gets a value that indicates if this filter is a Source: javascript/web/pentaho/type/filter/abstract.js, line 115 Inherited From: pentaho.type.filter.Abstract#isProperty |
isTerminal: |
---|
Gets a value that indicates if this filter is terminal. The non-terminal filter types are Source: javascript/web/pentaho/type/filter/abstract.js, line 95 Overrides: pentaho.type.filter.Abstract#isTerminal |
isValid: |
---|
Determines if this value is a valid instance of its type. This attribute calls Source: javascript/web/pentaho/type/value.js, line 137 Inherited From: pentaho.type.Value#isValid |
key: |
---|
Gets the key of the complex value. The key of a value identifies it among values of the same concrete type. If two values have the same concrete type and their keys are equal, then it must also be the case that The default complex implementation, returns the value of the complex instance's Source: javascript/web/pentaho/type/complex.js, line 241 Inherited From: pentaho.type.Complex#key |
kind: |
---|
Gets the kind of this filter. The values of the standard, concrete filter kinds are available in the Source: javascript/web/pentaho/type/filter/abstract.js, line 71 Overrides: pentaho.type.filter.Abstract#kind |
type: |
---|
Gets the type of this instance. Source: javascript/web/pentaho/type/value.js, line 262 Overrides: pentaho.type.filter.Abstract#type |
Methods Details
_buildContentKey() : string Abstract Protected | ||||
---|---|---|---|---|
Builds the content key. The return value is automatically augmented with the kind of filter information. Source: javascript/web/pentaho/type/filter/abstract.js, line 140 Overrides: pentaho.type.filter.Abstract#_buildContentKey
|
_clone(clone) Protected | ||||||
---|---|---|---|---|---|---|
Initializes a clone of this complex value. Source: javascript/web/pentaho/type/complex.js, line 195 Inherited From: pentaho.type.Complex#_clone
|
_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 194 Inherited From: pentaho.type.Value#_configure
|
_contains(elem) : boolean Abstract Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Actual implementation that determines if an element is selected by this filter. This method assumes that the filter is valid. Source: javascript/web/pentaho/type/filter/abstract.js, line 172 Overrides: pentaho.type.filter.Abstract#_contains
See also: pentaho.type.filter.Abstract#contains |
_createChangeset(transaction) : pentaho.type.changes.Changeset Abstract Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a changeset with this container as owner and returns it. Source: javascript/web/pentaho/type/ContainerMixin.js, line 203 Inherited From: pentaho.type.ContainerMixin#_createChangeset
|
_emit(event) : pentaho.lang.Event Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Emits an unstructured event and returns it, unless it was canceled. When this method is called, the listeners of existing registrations are notified synchronously, by priority order and then registration order, until either the event is canceled or all of the listeners have been notified. It is safe to register or unregister to/from an event type while it is being emitted. However, changes are only taken into account in subsequent emissions. If a listener function throws an error, the event processing is interrupted. No more registrations are processed and the error is passed to the caller. Source: javascript/web/pentaho/lang/EventSource.js, line 261 Inherited From: pentaho.lang.EventSource#_emit
See also: pentaho.lang.EventSource#_emitSafe , pentaho.lang.EventSource#_emitGeneric |
_emitGeneric(event, type, phase, keyArgs) : object Protected | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Emits an event given an arbitrary payload object, its type and phase. Returns the event payload object, unless the event is canceled. Source: javascript/web/pentaho/lang/EventSource.js, line 313 Inherited From: pentaho.lang.EventSource#_emitGeneric
|
_emitSafe(event) : pentaho.lang.Event Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Variation of the If an event listener throws an error, the following event listeners are still processed. Source: javascript/web/pentaho/lang/EventSource.js, line 283 Inherited From: pentaho.lang.EventSource#_emitSafe
See also: pentaho.lang.EventSource#_emit , pentaho.lang.EventSource#_emitGeneric |
_hasListeners(type, phase) : boolean Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Determines if there are any registrations for a given event type and phase. This method can be used to avoid creating expensive event objects for event type and phase pairs that don't have registrations. Source: javascript/web/pentaho/lang/EventSource.js, line 189 Inherited From: pentaho.lang.EventSource#_hasListeners
Example if(this._hasListeners("select", "will")) { var event = new Event("select", this); if(this._emit(event)) { // Select Will phase } } |
_hasObservers(type) : boolean Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if there are any registrations for a given event type, for at least one of its phases. This method can be used to avoid creating expensive event objects for event types that currently have no registrations. Source: javascript/web/pentaho/lang/EventSource.js, line 232 Inherited From: pentaho.lang.EventSource#_hasObservers
Example if(this._hasObservers("select")) { var event = new Event("select"); if(this._emitGeneric(event, "select", "will")) { // Select Will this._emitGeneric(event, "select", "did"); } } |
_initValue(value, propType) : pentaho.type.Value Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Allows further initializing the value of a property. This method is called from within the base constructor. It is absolutely mandatory to return a value that is an instance of the type of value of the property. If the value should remain "empty", return Source: javascript/web/pentaho/type/complex.js, line 147 Inherited From: pentaho.type.Complex#_initValue
|
_onChangeDid(changeset) Protected | ||||||
---|---|---|---|---|---|---|
Called after a changeset has been committed. The default implementation emits the "did:change" event for the given changeset, if there are any listeners. When overriding, be sure to call the base implementation. Source: javascript/web/pentaho/type/ContainerMixin.js, line 253 Inherited From: pentaho.type.ContainerMixin#_onChangeDid
|
_onChangeRejected(changeset, reason) Protected | |||||||||
---|---|---|---|---|---|---|---|---|---|
Called after a changeset has been rejected. The default implementation emits the "rejected:change" event for the given changeset, if there are any listeners. When overriding, be sure to call the base implementation. Source: javascript/web/pentaho/type/ContainerMixin.js, line 273 Inherited From: pentaho.type.ContainerMixin#_onChangeRejected
|
_onChangeWill(changeset) : pentaho.lang.UserError | undefined Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Called before a changeset is committed. The default implementation emits the "will:change" event for the given changeset, if there are any listeners. When overriding, be sure to call the base implementation. Source: javascript/web/pentaho/type/ContainerMixin.js, line 233 Inherited From: pentaho.type.ContainerMixin#_onChangeWill
|
_visitDefault(transformer) : pentaho.type.filter.Abstract | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a filter that is the default transformed version of this filter. This implementation simply returns Source: javascript/web/pentaho/type/filter/abstract.js, line 222 Inherited From: pentaho.type.filter.Abstract#_visitDefault
See also: pentaho.type.filter.Tree#_visitDefault |
and(filters) : pentaho.type.filter.Abstract | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a filter that is the conjunction (intersection) between this filter and a variable number of other filters. Source: javascript/web/pentaho/type/filter/abstract.js, line 259 Inherited From: pentaho.type.filter.Abstract#and
|
andNot(exclude) : pentaho.type.filter.Abstract | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a filter that is the "difference" between this filter and a variable number of other filters. This operation is implemented in such a way as to not cause the term explosion that is likely to occur when trying to convert the result with a naive implementation to DNF:
This implementation works first by converting both this filter and the Source: javascript/web/pentaho/type/filter/abstract.js, line 290 Inherited From: pentaho.type.filter.Abstract#andNot
See also: pentaho.type.filter.Abstract#toDnf |
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 168 Inherited From: pentaho.type.Value#assertValid
|
at(name, index, sloppy) : pentaho.type.Element | Nully | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets one If the specified property is not defined and This method allows use of the same syntax for getting a single element from the value of a property, whether it is a list or an element property. If the property is an element property whose value is Source: javascript/web/pentaho/type/complex.js, line 577 Inherited From: pentaho.type.Complex#at
See also: pentaho.type.Property.Type#isList , pentaho.type.Complex#path , pentaho.type.Complex#atv , pentaho.type.Complex#atf , pentaho.type.Complex#count , pentaho.type.Complex#first |
atf(name, index, sloppy) : string | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the string representation of one element of the value of a property, given the property and the index of the element. This method reads the value of the property/index by calling When the latter returns a For a Source: javascript/web/pentaho/type/complex.js, line 647 Inherited From: pentaho.type.Complex#atf
See also: pentaho.type.Complex#at , pentaho.type.Complex#atv |
atv(name, index, sloppy) : any | pentaho.type.Complex | Nully | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the primitive value of one element of the value of a property, given the property and the index of the element. This method reads the value of the property/index by calling When the latter does not return a For a Source: javascript/web/pentaho/type/complex.js, line 617 Inherited From: pentaho.type.Complex#atv
See also: pentaho.type.Complex#at , pentaho.type.Complex#atf |
clone() : pentaho.type.Complex | ||||
---|---|---|---|---|
Creates a shallow clone of this complex value. All property values are shared with the clone. Source: javascript/web/pentaho/type/complex.js, line 183 Inherited From: pentaho.type.Complex#clone
|
configure(config) : pentaho.type.Value | ||
---|---|---|
Configures this value with a given configuration. Source: javascript/web/pentaho/type/value.js, line 180 Inherited From: pentaho.type.Value#configure |
Name | Default Value | Summary |
---|---|---|
config : any | The configuration. |
Name | Description |
---|---|
pentaho.type.Value | This instance. |
contains(elem) : boolean | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Determines if an element is selected by this filter. When the filter is not valid, an error is thrown. Otherwise, this method delegates to the Source: javascript/web/pentaho/type/filter/abstract.js, line 166 Inherited From: pentaho.type.filter.Abstract#contains
|
count(name, sloppy) : number | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the number of values of a given property. When the specified property is a list property, its When the specified property is not a list property, Source: javascript/web/pentaho/type/complex.js, line 541 Inherited From: pentaho.type.Complex#count
|
countRange(name) : pentaho.IRange | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the current valid count range of values of a given property. Source: javascript/web/pentaho/type/complex.js, line 694 Inherited From: pentaho.type.Complex#countRange
|
equals(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a given value, of the same type, represents the same entity. The given value must be of the same concrete type (or the result is undefined). To test equality for any two arbitrary values, in a robust way, use If two values are equal, they must have an equal The default implementation returns Source: javascript/web/pentaho/type/value.js, line 122 Inherited From: pentaho.type.Value#equals
|
extend(source, keyArgs) : Object | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Extend an object with the properties of another. Methods that are overridden are accessible through This object is extended, but its class doesn't change. Can be applied to non- Source: javascript/web/pentaho/lang/Base.js, line 808 Inherited From: pentaho.lang.Base#extend
|
first(name, sloppy) : pentaho.type.Element | Nully | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the first element of the value of a property. This method returns the result of calling Source: javascript/web/pentaho/type/complex.js, line 480 Inherited From: pentaho.type.Complex#first
See also: pentaho.type.Complex#firstv , pentaho.type.Complex#firstf |
firstf(name, sloppy) : string | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the string representation of the first element of the value of a property. This method returns the result of calling Source: javascript/web/pentaho/type/complex.js, line 520 Inherited From: pentaho.type.Complex#firstf
See also: pentaho.type.Complex#first , pentaho.type.Complex#firstv |
firstv(name, sloppy) : any | pentaho.type.Complex | Nully | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the primitive value of the first element of the value of a property. This method returns the result of calling Source: javascript/web/pentaho/type/complex.js, line 500 Inherited From: pentaho.type.Complex#firstv
See also: pentaho.type.Complex#first , pentaho.type.Complex#firstf |
get(name, sloppy) : pentaho.type.Value | Nully | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the value of a property. If the specified property is not defined and A list property always has a non-null value, possibly an empty list, but never Source: javascript/web/pentaho/type/complex.js, line 267 Inherited From: pentaho.type.Complex#get
See also: pentaho.type.Complex#getv , pentaho.type.Complex#getf , pentaho.type.Complex#at , pentaho.type.Complex#first |
getf(name, sloppy) : string | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the string representation of the value of a property. This method reads the value of the property by calling When the latter returns a For a Source: javascript/web/pentaho/type/complex.js, line 337 Inherited From: pentaho.type.Complex#getf
See also: pentaho.type.Complex#get , pentaho.type.Complex#getv |
getv(name, sloppy) : any | pentaho.type.Complex | pentaho.type.List | Nully | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the primitive value of the value of a property. This method reads the value of the property by calling When the latter does not return a For a Source: javascript/web/pentaho/type/complex.js, line 308 Inherited From: pentaho.type.Complex#getv
See also: pentaho.type.Complex#get , pentaho.type.Complex#getf |
isApplicable(name) : boolean | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given property is currently applicable. Source: javascript/web/pentaho/type/complex.js, line 664 Inherited From: pentaho.type.Complex#isApplicable
|
isEnabled(name) : boolean | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given property is currently enabled. Source: javascript/web/pentaho/type/complex.js, line 679 Inherited From: pentaho.type.Complex#isEnabled
|
isRequired(name) : boolean | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given property is currently required. A property is currently required if its current Source: javascript/web/pentaho/type/complex.js, line 712 Inherited From: pentaho.type.Complex#isRequired
|
negate() : pentaho.type.filter.Abstract | ||||
---|---|---|---|---|
Creates a filter that is the negation of this filter. Source: javascript/web/pentaho/type/filter/abstract.js, line 231 Overrides: pentaho.type.filter.Abstract#negate
|
off(typeOrHandle, observer) | ||
---|---|---|
Removes one registration given its handle, or all registrations of a given event type (or types) and observer (or listener function). To remove an event registration, it is sufficient to call the It is safe to unregister from an event type while it is being emitted. However, any registrations removed during the current emission will still execute. Specifying an event registration handle that has already been disposed of has no effect. Specifying an event type and observer (or listener function) that have no registrations has no effect. Source: doc-js/pentaho/lang/IEventSource.jsdoc, line 131 Inherited From: pentaho.lang.EventSource#off |
Name | Default Value | Summary |
---|---|---|
typeOrHandle : nonEmptyString | Array.< | pentaho.lang.IEventRegistrationHandle | The type or types of events, or an event registration handle to dispose of. When a string, it can be a comma-separated list of event types. | |
observer : pentaho.lang.IEventObserver | pentaho.lang.EventListener | pentaho.lang.EventListenerAsync | The event observer (or listener function). Required when |
See also: pentaho.lang.IEventSource#on
on(type, observer, keyArgs) : pentaho.lang.IEventRegistrationHandle | ||||||||
---|---|---|---|---|---|---|---|---|
Registers an observer (or listener function) for an event(s) of a given type(s). Optionally, a listening priority may be specified to adjust the order by which an observer is notified, relative to other listeners. Note that if an observer is registered more than once to the same event type, a new registration is created each time and its listeners will be called once per registration. It is safe to register for an event type while it is being emitted. However, new registrations are only taken into account in subsequent emissions. When This method is compatible with the dojo/on API. Source: doc-js/pentaho/lang/IEventSource.jsdoc, line 90 Inherited From: pentaho.lang.EventSource#on |
Name | Default Value | Summary | ||||||
---|---|---|---|---|---|---|---|---|
type : nonEmptyString | Array.< | The type or types of events. When a string, it can be a comma-separated list of event types. | |||||||
observer : pentaho.lang.IEventObserver | pentaho.lang.EventListener | pentaho.lang.EventListenerAsync | The event observer (or listener function). | |||||||
keyArgs : object Optional | Keyword arguments.
|
Name | Description |
---|---|
pentaho.lang.IEventRegistrationHandle | An event registration handle that can be used for later removal. |
See also: pentaho.lang.IEventSource#off
or(filters) : pentaho.type.filter.Abstract | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a filter that is the disjunction (union) between this filter and a variable number of other filters. Source: javascript/web/pentaho/type/filter/abstract.js, line 242 Inherited From: pentaho.type.filter.Abstract#or
|
path(steps, sloppy) : pentaho.type.Value | Nully | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the value of a property/index/key path based on the current complex. When called with no arguments, or with an empty When a step, on a complex value, is not a defined property and Value
This method supports two signatures. When the first argument is an array, it is the
Otherwise, the method behaves as if Source: javascript/web/pentaho/type/complex.js, line 388 Inherited From: pentaho.type.Complex#path
|
set(name, valueSpec) | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sets the value of a property. Source: javascript/web/pentaho/type/complex.js, line 419 Inherited From: pentaho.type.Complex#set
Fires: event:will:change , event:did:change , event:rejected:change
|
toDnf() : pentaho.type.filter.True | pentaho.type.filter.False | pentaho.type.filter.Or | ||||
---|---|---|---|---|
Converts a copy of this filter into Disjunctive Normal Form and returns it. A filter in DNF is one of:
DNF is particularly useful for representing filters because, excluding its degenerate cases, it is the natural form of a filter that selects a set of rows, such as: (country = "us" and productLine = "cars") or (country = "pt" and productLine = "jets") Generally, DNF conversion is computationally expensive, and, for some types of filters, can not terminate in a reasonable amount of time. One such type of filter is that which results from a difference operation, such as The result of this operation is cached. Source: javascript/web/pentaho/type/filter/abstract.js, line 406 Inherited From: pentaho.type.filter.Abstract#toDnf
See also: https://en.wikipedia.org/wiki/Disjunctive_normal_form |
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 206 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 200 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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this instance. Source: javascript/web/pentaho/type/instance.js, line 186 Inherited From: pentaho.type.Instance#toSpecInContext
See also: pentaho.type.Instance#toSpec |
validate() : Array.< | ||||
---|---|---|---|---|
Determines if this complex value is a valid instance of its type. The default implementation validates each property's value against the property's You can use the error utilities in Source: javascript/web/pentaho/type/complex.js, line 736 Inherited From: pentaho.type.Complex#validate
See also: pentaho.type.Value#isValid |
visit(transformer) : pentaho.type.filter.Abstract | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a filter that is a transformed version of this filter. This implementation calls Source: javascript/web/pentaho/type/filter/abstract.js, line 203 Inherited From: pentaho.type.filter.Abstract#visit
|