com.adobe.icc.vo.Statement - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	com.adobe.icc.vo
Class	public class Statement
Inheritance	Statement Object
Implements	IEventDispatcher

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Defines a statement used in a filtering operation on the server.

Statements should be formed as ({attributeName} {operator} {attributeValue}).

Example 1: For, specifying (state = 1), set:

attributeName = "state"
operator = OP_EQUALS
attributeValue = 1

For, specifiying 'name' begins that 'abc', i.e, name = 'abc, set:

attributeName = "name"
operator = OP_STARTS_WITH
attributeValue = "abc"

Statements can also be chained together using the innerStatement and joinOperator properties. This allows one to build compound statements.

Example 2: Consider the statement ((name = 'abc) OR name = 'yz'), i.e., either 'name' begins with 'abc' or ends with 'xyz'. For this, set:

attributeName = "name"
operator = OP_STARTS_WITH
attributeValue = "abc"

Then make a new Statement object and set:

attributeName = "name"
operator = OP_ENDS_WITH
attributeValue = "xyz"

Finally, set the xyz statement as the innerStatement of the abc statement and set abc statement's joinOperator = JOIN_OR.

Example 3: Searching for modules that either do use a Data Dictionary or use a specific Data Dictionary.

In this case, we take advantage of the fact that statements can search on nested properties. The path to the property is the same as that which you would normally use to get at the property on the corresponding Value Object: If a DataModule object does not use a Data Dictionary, its dataDictionaryRefs property will be null. If it uses one, however, its DataDictionaryRefs property will set to the ID of the Data Dictionary used by the module.

The first statement will therefore check for a null dataDictionaryRefs property and the second (nested statement) will check for an existing dataDictionaryRefs property set to a given Data Dictionary ID string (note that the server will take care of looking at the first item within the dataDictionaryRefs list even if there are no items):

attributeName = "dataDictionaryRefs"
operator = OP_IS_NULL
attributeValue = null
joinOperator = JOIN_OR
innerStatement =
- attributeName = "dataDictionaryRefs"
- operator = OP_EQUALS
- attributeValue = {dataDictionaryId}

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		attributeName : String Name of the attribute for the LHS of the statement.	Statement
		attributeValue : Object Value for the RHS of the statement.	Statement
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		innerStatement : Statement Inner statement for this statement.	Statement
		joinOperator : String Inner statement join operator.	Statement
		operator : String Operator for this statement.	Statement
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Statement(attribute:String = null, operator:String = null, value:Object = null) Constructs a new Statement object, given optional parameters to a simple statement, for convenience.	Statement
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	Statement
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	Statement
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	Statement
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	Statement
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	Statement

Public Constants

	Constant		Defined By
		JOIN_AND : String = "AND" [static] Specifies an AND join.	Statement
		JOIN_AND_NOT : String = "AND_NOT" [static] Specifies an AND NOT join.	Statement
		JOIN_OR : String = "OR" [static] Specifies an OR join.	Statement
		JOIN_OR_NOT : String = "OR_NOT" [static] Specifies an OR NOT join.	Statement
		OP_CONTAINS : String = "CONTAINS" [static] Specifies the contains operator.	Statement
		OP_ENDS_WITH : String = "ENDS_WITH" [static] Specifies the ends with operator.	Statement
		OP_EQUALS : String = "EQUALS" [static] Specifies the equals operator.	Statement
		OP_GREATER_EQUALS : String = "GREATER_THAN_EQUALS" [static] Specifies the greater than or equal to operator.	Statement
		OP_GREATER_THAN : String = "GREATER_THAN" [static] Specifies the greater than operator.	Statement
		OP_IS_NULL : String = "IS_NULL" [static] Specifies the null operator.	Statement
		OP_LESS_EQUALS : String = "LESS_THAN_EQUALS" [static] Specifies the equal to operator.	Statement
		OP_LESS_THAN : String = "LESS_THAN" [static] Specifies the less than operator.	Statement
		OP_NOT_EQUALS : String = "NOT_EQUALS" [static] Specifies the not equal operator.	Statement
		OP_STARTS_WITH : String = "STARTS_WITH" [static] Specifies the starts with operator.	Statement

Property Detail

attributeName

property

attributeName:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Name of the attribute for the LHS of the statement. Must be same as the name of the property in the corresponding object type.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get attributeName():String
public function set attributeName(value:String):void

attributeValue

property

attributeValue:Object

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Value for the RHS of the statement.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get attributeValue():Object
public function set attributeValue(value:Object):void

innerStatement

property

innerStatement:Statement

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Inner statement for this statement. This will allow joining two statements together, using the JoinOperator. This statement is then treated as: (this {JoinOperator} innerStatement), where 'this' refers to this Statement object and 'innerStatement' refers to the innerStatement property in this object.

WARNING: This property cannot be more than one level deep. Deeper nesting (from the top statement) will be ignored and the server will not throw an exception (the deeper nesting will be silently ignored).

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get innerStatement():Statement
public function set innerStatement(value:Statement):void

joinOperator

property

joinOperator:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Inner statement join operator. Must be one of the JOINconstant values.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get joinOperator():String
public function set joinOperator(value:String):void

operator

property

operator:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Operator for this statement. Must be one of the OPconstant values.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get operator():String
public function set operator(value:String):void

Constructor Detail

Statement

()

Constructor

public function Statement(attribute:String = null, operator:String = null, value:Object = null)

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Constructs a new Statement object, given optional parameters to a simple statement, for convenience.

Parameters

	`attribute:String` (default = `null`) — The name of the attribute that this statement is created for.

	`operator:String` (default = `null`) — The operator to use between the attribute and value.

	`value:Object` (default = `null`) — The value of the attribute.

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

event:Event — The event object dispatched into the event flow.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

willTrigger

()

method

public function willTrigger(type:String):Boolean

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Constant Detail

JOIN_AND

Constant

public static const JOIN_AND:String = "AND"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies an AND join.

JOIN_AND_NOT

Constant

public static const JOIN_AND_NOT:String = "AND_NOT"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies an AND NOT join.

JOIN_OR

Constant

public static const JOIN_OR:String = "OR"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies an OR join.

JOIN_OR_NOT

Constant

public static const JOIN_OR_NOT:String = "OR_NOT"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies an OR NOT join.

OP_CONTAINS

Constant

public static const OP_CONTAINS:String = "CONTAINS"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the contains operator.

OP_ENDS_WITH

Constant

public static const OP_ENDS_WITH:String = "ENDS_WITH"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the ends with operator.

OP_EQUALS

Constant

public static const OP_EQUALS:String = "EQUALS"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the equals operator. That is, "=".

OP_GREATER_EQUALS

Constant

public static const OP_GREATER_EQUALS:String = "GREATER_THAN_EQUALS"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the greater than or equal to operator.

OP_GREATER_THAN

Constant

public static const OP_GREATER_THAN:String = "GREATER_THAN"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the greater than operator.

OP_IS_NULL

Constant

public static const OP_IS_NULL:String = "IS_NULL"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the null operator.

OP_LESS_EQUALS

Constant

public static const OP_LESS_EQUALS:String = "LESS_THAN_EQUALS"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the equal to operator.

OP_LESS_THAN

Constant

public static const OP_LESS_THAN:String = "LESS_THAN"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the less than operator.

OP_NOT_EQUALS

Constant

public static const OP_NOT_EQUALS:String = "NOT_EQUALS"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the not equal operator.

OP_STARTS_WITH

Constant

public static const OP_STARTS_WITH:String = "STARTS_WITH"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the starts with operator.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

attributeName

attributeValue

innerStatement

joinOperator

operator

Statement

addEventListener

dispatchEvent

hasEventListener

removeEventListener

willTrigger

JOIN_AND

JOIN_AND_NOT

JOIN_OR

JOIN_OR_NOT

OP_CONTAINS

OP_ENDS_WITH

OP_EQUALS

OP_GREATER_EQUALS

OP_GREATER_THAN

OP_IS_NULL

OP_LESS_EQUALS

OP_LESS_THAN

OP_NOT_EQUALS

OP_STARTS_WITH