intradoc.data
Class ComparisonField

java.lang.Object
  |
  +--intradoc.data.ComparisonField

public class ComparisonField

extends java.lang.Object

This object holds the elements of a where clause with one operand being substituted at execution time by data supplied by the calling thread. This object is used to build up queries using an explicit description instead of an SQL syntax. This is useful for performing queries against other data sources besides databases.

Field Summary

static short	COMPARE_EQUALS
static short	COMPARE_GREATER_THAN
static short	COMPARE_GT_OR_EQ
static short	COMPARE_LESS_THAN
static short	COMPARE_LIKE
static short	COMPARE_LT_OR_EQ
static short	COMPARE_NO_ACTION
static short	COMPARE_NOT_EQUALS
java.lang.String	m_alias Name of parameterized argument supplied as the other operand in the comparison.
java.lang.String	m_name Name of field which is having a comparison evaluated against it.
int	m_type Type of comparison to perform.

Constructor Summary

ComparisonField()
Default constructor.

Method Summary

java.lang.String

getArgName() Gets name of alias used for performing argument substitution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPARE_NO_ACTION

public static final short COMPARE_NO_ACTION

See Also:

Constant Field Values

COMPARE_EQUALS

public static final short COMPARE_EQUALS

See Also:

Constant Field Values

COMPARE_LESS_THAN

public static final short COMPARE_LESS_THAN

See Also:

Constant Field Values

COMPARE_GREATER_THAN

public static final short COMPARE_GREATER_THAN

See Also:

Constant Field Values

COMPARE_NOT_EQUALS

public static final short COMPARE_NOT_EQUALS

See Also:

Constant Field Values

COMPARE_GT_OR_EQ

public static final short COMPARE_GT_OR_EQ

See Also:

Constant Field Values

COMPARE_LT_OR_EQ

public static final short COMPARE_LT_OR_EQ

See Also:

Constant Field Values

COMPARE_LIKE

public static final short COMPARE_LIKE

See Also:

Constant Field Values

m_name

public java.lang.String m_name

Name of field which is having a comparison evaluated against it.

m_alias

public java.lang.String m_alias

Name of parameterized argument supplied as the other operand in the comparison. Note: if a field is referenced twice in one where clause statement then the name of the comparison arguments must be different for each field. (Ex: dInDate < *dInDateArg1* and dIndate > *dInDateArg2*. dInDateArg1 and dInDateArg2 would be the aliases for the two ComparisonField objects used to build up this where clause.)

m_type

public int m_type

Type of comparison to perform. Value is one of the constants defined by this class.

Constructor Detail

ComparisonField

public ComparisonField()

Default constructor.

Method Detail

getArgName

public java.lang.String getArgName()

Gets name of alias used for performing argument substitution. Note: if no alias is supplied then alias defaults to "a" + m_name.

Returns:

Name of argument used for performing runtime substitution.