Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKOpCode

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKOpCode

public class DKOpCode
extends java.lang.Object

DKOpCode is a static helper class to define constants related to comparison and logical operators. This class is used by DKQTerm, DKSearchCriteria, DKSearchNode, etc.


Field Summary
static short AND
           
static short BETWEEN
           
static short CONTAINS_TEXT
           
static short CONTAINS_TEXT_IN_CONTENT
           
static short EQ
           
static short GEQ
           
static short GT
           
static short IN
           
static short LEQ
           
static short LIKE
           
static short LT
           
static short NEQ
           
static short NOT
           
static short NOTBETWEEN
           
static short NOTIN
           
static short NOTLIKE
           
static short OR
           
static short UNDEFINED
           
 
Constructor Summary
DKOpCode()
           
 
Method Summary
static boolean isMultiValueOp(short opCode)
          Returns true if the given opCode requires multiple values, for example: IN, BETWEEN, etc
static java.lang.String[] opStrings()
          Gets the string representation of all defined operators
static short toOpCode(java.lang.String opString)
          Convert the given operator string to its op-code representation.
static java.lang.String toString(short opCode)
          Convert the given opCode to its string representation.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNDEFINED

public static final short UNDEFINED

EQ

public static final short EQ

NEQ

public static final short NEQ

GT

public static final short GT

LT

public static final short LT

LIKE

public static final short LIKE

NOTLIKE

public static final short NOTLIKE

BETWEEN

public static final short BETWEEN

IN

public static final short IN

NOTIN

public static final short NOTIN

GEQ

public static final short GEQ

LEQ

public static final short LEQ

NOTBETWEEN

public static final short NOTBETWEEN

AND

public static final short AND

OR

public static final short OR

NOT

public static final short NOT

CONTAINS_TEXT

public static final short CONTAINS_TEXT

CONTAINS_TEXT_IN_CONTENT

public static final short CONTAINS_TEXT_IN_CONTENT
Constructor Detail

DKOpCode

public DKOpCode()
Method Detail

opStrings

public static java.lang.String[] opStrings()
Gets the string representation of all defined operators
Returns:
array of operator string

toString

public static java.lang.String toString(short opCode)
Convert the given opCode to its string representation.
Returns:
the string representation of the operator with a preceeding and a trailing blank for readability.
Throws:
java.lang.IndexOutOfBoundsException - if the opCode is invalid

toOpCode

public static short toOpCode(java.lang.String opString)
Convert the given operator string to its op-code representation.
Parameters:
opString - the string representation of the operator with a preceeding and a trailing blank.
Returns:
a short op-code, or -1 if not found
Throws:
java.lang.IndexOutOfBoundsException - if the op-string is invalid

isMultiValueOp

public static boolean isMultiValueOp(short opCode)
Returns true if the given opCode requires multiple values, for example: IN, BETWEEN, etc

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.