com.ibm.retail.AEF.automation
Class PropertyContainsAtIndexCondition

java.lang.Object
  |
  +--com.ibm.retail.AEF.automation.AbstractCondition
        |
        +--com.ibm.retail.AEF.automation.AbstractPropertyCondition
              |
              +--com.ibm.retail.AEF.automation.PropertyContainsAtIndexCondition
All Implemented Interfaces:
AEFPropertyChangeListener, Condition, com.ibm.retail.AEF.automation.PropertyCondition, java.rmi.Remote

public class PropertyContainsAtIndexCondition
extends AbstractPropertyCondition

PropertyContainsAtIndexCondition listens to a POSDataProvider property and indicates whether the property contains the specified value at the specified index. The property being monitored is first converted to a String if it is not already a string data type. If the property is detected to contain the value, the lock associated with this condition is notified, which will free a thread blocking on the lock.


Field Summary
protected  int offset
           
 
Fields inherited from class com.ibm.retail.AEF.automation.AbstractPropertyCondition
category, name, nextOnly, value
 
Fields inherited from class com.ibm.retail.AEF.automation.AbstractCondition
counterLock, dataProvider, eligible, id, idCounter, index, listeners, lock, manager, session
 
Constructor Summary
PropertyContainsAtIndexCondition(com.ibm.retail.AEF.automation.PropertyNotContainsAtIndexCondition condition)
          Constructs the condition which is the opposite of a PropertyNotContainsAtIndexCondtion.
PropertyContainsAtIndexCondition(java.lang.String cat, java.lang.String name, java.lang.String value, int index)
          Constructs the condition
PropertyContainsAtIndexCondition(java.lang.String cat, java.lang.String name, java.lang.String value, int index, boolean nextValueOnly)
          Constructs the condition
 
Method Summary
(package private) static java.lang.String copyright()
           
 boolean evaluate(java.lang.Object newVal)
          Evaluates the condition given a value object.
 java.lang.String explain()
          Returns a string explaining this condition.
 int getTargetOffset()
          Returns the target value offset which the target value must ocurr within the property.
 java.lang.String getTargetValue()
          Returns the target value which this condition is looking for within the property.
 com.ibm.retail.AEF.automation.Condition makeOpposite()
          Makes a new condition which is the logical opposite of this condition.
 void propertyChanged(com.ibm.retail.AEF.event.AEFPropertyChangeEvent evt)
          A AEF POSDataProvider property was updated
 
Methods inherited from class com.ibm.retail.AEF.automation.AbstractPropertyCondition
currentValues, evaluate, getCategory, getNextOnly, getPropertyName, parseDouble, setEligible
 
Methods inherited from class com.ibm.retail.AEF.automation.AbstractCondition
addEvaluateListener, getID, getIndex, getNextID, getPOSDataProvider, getSession, getTerminalNumber, isEligible, notifyEvaluateConditionListeners, removeEvaluateListener, setConditionLock, setID, setIndex, setLockManager, setPOSDataProvider, setSession
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.retail.AEF.automation.Condition
addEvaluateListener, getID, getIndex, getPOSDataProvider, getSession, getTerminalNumber, isEligible, removeEvaluateListener, setConditionLock, setID, setIndex, setLockManager, setPOSDataProvider, setSession
 

Field Detail

offset

protected int offset
Constructor Detail

PropertyContainsAtIndexCondition

public PropertyContainsAtIndexCondition(java.lang.String cat,
                                        java.lang.String name,
                                        java.lang.String value,
                                        int index,
                                        boolean nextValueOnly)
Constructs the condition

Parameters:
cat - The category name of the property to be monitored.
name - The property name to be monitored.
value - The property value is compared to see if it contains this string.
index - The zero based index within the property where the value must be observed for the condition to be true.
nextValueOnly - Set to true to compare only the next value of the property. If false, all values of the property change will be compared.

PropertyContainsAtIndexCondition

public PropertyContainsAtIndexCondition(java.lang.String cat,
                                        java.lang.String name,
                                        java.lang.String value,
                                        int index)
Constructs the condition

Parameters:
cat - The category name of the property to be monitored.
name - The property name to be monitored.
value - The property value is compared to see if it contains this string.
index - The zero based index within the property where the value must be observed for the condition to be true.

PropertyContainsAtIndexCondition

public PropertyContainsAtIndexCondition(com.ibm.retail.AEF.automation.PropertyNotContainsAtIndexCondition condition)
Constructs the condition which is the opposite of a PropertyNotContainsAtIndexCondtion.

Parameters:
condition - The PropertyNotContainsAtIndexCondition to construct the opposite of.
Method Detail

copyright

static java.lang.String copyright()

makeOpposite

public com.ibm.retail.AEF.automation.Condition makeOpposite()
Makes a new condition which is the logical opposite of this condition.

Returns:
Condition

propertyChanged

public void propertyChanged(com.ibm.retail.AEF.event.AEFPropertyChangeEvent evt)
                     throws java.rmi.RemoteException
A AEF POSDataProvider property was updated

Parameters:
evt - contains details of the event
Throws:
java.rmi.RemoteException - if remote access fails

evaluate

public boolean evaluate(java.lang.Object newVal)
Evaluates the condition given a value object.

Overrides:
evaluate in class AbstractPropertyCondition
Parameters:
newVal - The Object value.
Returns:
boolean True if the condition evaluates to true.

getTargetValue

public java.lang.String getTargetValue()
Returns the target value which this condition is looking for within the property.

Returns:
String

getTargetOffset

public int getTargetOffset()
Returns the target value offset which the target value must ocurr within the property.

Returns:
int

explain

public java.lang.String explain()
Returns a string explaining this condition.

Returns:
String


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004