Class JoinComparison
- java.lang.Object
-
- com.filenet.api.constants.JoinComparison
-
- All Implemented Interfaces:
- java.io.Serializable
public class JoinComparison extends java.lang.Object implements java.io.Serializable
Specifies the operation to use when comparing the constituents of a SQL join operation (the constituents of the ON clause in a SQL statement). This class is used bySearchSQL.setFromClauseAdditionalJoin
to construct a join.- See Also:
SearchSQL
,JoinOperator
, SQL Syntax Reference, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static JoinComparison
EQUAL
A constant representing a JoinComparison instance of type EQUAL.static int
EQUAL_AS_INT
An integer associated with the EQUAL instance of this class.static JoinComparison
GREATER_THAN
A constant representing a JoinComparison instance of type GREATER_THAN.static int
GREATER_THAN_AS_INT
An integer associated with the GREATER_THAN instance of this class.static JoinComparison
GREATER_THAN_EQUAL_TO
A constant representing a JoinComparison instance of type GREATER_THAN_EQUAL_TO.static int
GREATER_THAN_EQUAL_TO_AS_INT
An integer associated with the GREATER_THAN_EQUAL_TO instance of this class.static JoinComparison
LESS_THAN
A constant representing a JoinComparison instance of type LESS_THAN.static int
LESS_THAN_AS_INT
An integer associated with the LESS_THAN instance of this class.static JoinComparison
LESS_THAN_EQUAL_TO
A constant representing a JoinComparison instance of type LESS_THAN_EQUAL_TO.static int
LESS_THAN_EQUAL_TO_AS_INT
An integer associated with the LESS_THAN_EQUAL_TO instance of this class.static JoinComparison
NOT_EQUAL
A constant representing a JoinComparison instance of type NOT_EQUAL.static int
NOT_EQUAL_AS_INT
An integer associated with the NOT_EQUAL instance of this class.
-
Method Summary
Methods Modifier and Type Method and Description static JoinComparison
getInstanceFromInt(int value)
Gets an instance of this class using its associated integer value (the *_AS_INT fields).java.lang.String
getOperator()
Gets the standard string representation of the comparison operator used by this instance.int
getValue()
Returns an integer value associated with a specific instance of this class.java.lang.String
toString()
Returns a String representation of this instance.
-
-
-
Field Detail
-
NOT_EQUAL_AS_INT
public static final int NOT_EQUAL_AS_INT
An integer associated with the NOT_EQUAL instance of this class.Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
- See Also:
- Constant Field Values
-
NOT_EQUAL
public static final JoinComparison NOT_EQUAL
A constant representing a JoinComparison instance of type NOT_EQUAL. This specifies that the constituents of the join are not equal.- See Also:
getValue()
,getInstanceFromInt(int)
-
EQUAL_AS_INT
public static final int EQUAL_AS_INT
An integer associated with the EQUAL instance of this class.Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
- See Also:
- Constant Field Values
-
EQUAL
public static final JoinComparison EQUAL
A constant representing a JoinComparison instance of type EQUAL. This specifies that the constituents of the join are equal.- See Also:
getValue()
,getInstanceFromInt(int)
-
LESS_THAN_AS_INT
public static final int LESS_THAN_AS_INT
An integer associated with the LESS_THAN instance of this class.Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
- See Also:
- Constant Field Values
-
LESS_THAN
public static final JoinComparison LESS_THAN
A constant representing a JoinComparison instance of type LESS_THAN. This specifies that the initial constituent of the join is less than the other constituent.- See Also:
getValue()
,getInstanceFromInt(int)
-
GREATER_THAN_AS_INT
public static final int GREATER_THAN_AS_INT
An integer associated with the GREATER_THAN instance of this class.Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
- See Also:
- Constant Field Values
-
GREATER_THAN
public static final JoinComparison GREATER_THAN
A constant representing a JoinComparison instance of type GREATER_THAN. This specifies that the initial constituent of the join is greater than the other constituent.- See Also:
getValue()
,getInstanceFromInt(int)
-
LESS_THAN_EQUAL_TO_AS_INT
public static final int LESS_THAN_EQUAL_TO_AS_INT
An integer associated with the LESS_THAN_EQUAL_TO instance of this class.Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
- See Also:
- Constant Field Values
-
LESS_THAN_EQUAL_TO
public static final JoinComparison LESS_THAN_EQUAL_TO
A constant representing a JoinComparison instance of type LESS_THAN_EQUAL_TO. This specifies that the initial constituent of the join is less than or equal to the other constituent.- See Also:
getValue()
,getInstanceFromInt(int)
-
GREATER_THAN_EQUAL_TO_AS_INT
public static final int GREATER_THAN_EQUAL_TO_AS_INT
An integer associated with the GREATER_THAN_EQUAL_TO instance of this class.Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
- See Also:
- Constant Field Values
-
GREATER_THAN_EQUAL_TO
public static final JoinComparison GREATER_THAN_EQUAL_TO
A constant representing a JoinComparison instance of type GREATER_THAN_EQUAL_TO. This specifies that the initial constituent of the join is greater than or equal to the other constituent.- See Also:
getValue()
,getInstanceFromInt(int)
-
-
Method Detail
-
getValue
public int getValue()
Returns an integer value associated with a specific instance of this class.- Returns:
- An integer representing a specific instance of this class.
-
getInstanceFromInt
public static JoinComparison getInstanceFromInt(int value)
Gets an instance of this class using its associated integer value (the *_AS_INT fields).- Parameters:
value
- An integer representing a particular static instance of this class.- Returns:
- The JoinComparison instance referenced.
- Throws:
EngineRuntimeException
- Thrown when the parameter is null or invalid.
-
getOperator
public java.lang.String getOperator()
Gets the standard string representation of the comparison operator used by this instance. The operators returned will be one of the following (shown with their corresponding field):- "=" (
EQUAL_AS_INT
) - "<>" (
NOT_EQUAL_AS_INT
) - "<" (
LESS_THAN_AS_INT
) - ">" (
GREATER_THAN_AS_INT
) - "<=" (
LESS_THAN_EQUAL_TO_AS_INT
) - ">=" (
GREATER_THAN_EQUAL_TO_AS_INT
)
- Returns:
- A String representation of the join comparison operator.
- "=" (
-
toString
public java.lang.String toString()
Returns a String representation of this instance.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A String representing the instance.
-
-