org.treetank.service.xml.xpath.comparators

Enum CompKind

java.lang.Object

java.lang.Enum<CompKind>

org.treetank.service.xml.xpath.comparators.CompKind

All Implemented Interfaces:

Serializable, Comparable<CompKind>

public enum CompKind
extends Enum<CompKind>

CompKind

Enumeration for all comparison kinds.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQ comparison type 'equal'.
FO node comparison type.
GE value comparison type 'greater or equal than'.
GT comparison type 'greater than'.
IS node comparison type .
LE comparison type 'less or equal than'.
LT comparison type 'less than'.
NE comparison type 'not equal'.
PRE node comparison type .

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	compare(String mOperand1, String mOperand2, Type mType) Compares the two input values.
static CompKind	fromString(String paramName) Public method to easy retrieve the Function-Class for a name.
static CompKind	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompKind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EQ

public static final CompKind EQ

comparison type 'equal'.

NE

public static final CompKind NE

comparison type 'not equal'.

LT

public static final CompKind LT

comparison type 'less than'.

LE

public static final CompKind LE

comparison type 'less or equal than'.

GT

public static final CompKind GT

comparison type 'greater than'.

GE

public static final CompKind GE

value comparison type 'greater or equal than'.

FO

public static final CompKind FO

node comparison type.

PRE

public static final CompKind PRE

node comparison type .

IS

public static final CompKind IS

node comparison type .

Method Detail

values

public static CompKind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CompKind c : CompKind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CompKind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

compare

public abstract boolean compare(String mOperand1,
              String mOperand2,
              Type mType)
                         throws TTXPathException

Compares the two input values.

Parameters:

mOperand1 - string value of first comparison operand

mOperand2 - string value of second comparison operand

mType - comparison type

Returns:

result of the boolean comparison

Throws:

TTXPathException - if anything weird happens while comparison.

fromString

public static CompKind fromString(String paramName)

Public method to easy retrieve the Function-Class for a name.

Parameters:

paramName - the name of the function to be retrieved.

Returns:

the Function