com.sap.tc.cmi.sorting

Class CMIComparisonRule

java.lang.Object
  com.sap.tc.cmi.sorting.CMIComparisonRule

All Implemented Interfaces:

Serializable

public final class CMIComparisonRule
extends Object
implements Serializable

Enumeration of the comparison rules that are available for sorting.

As of today, only the default comparison rule MODEL_DEFINED is supported.

In the future there might be support for other comparison rules, like

• binary (chars ar compared by their binary representation)
• lexical (lexical sort order, only defined for fields of type String)
• lexical-ignore-case (same as above, but ignoring case)
• number (by value, defined for fields with numeric types)
• day-of-week (sort strings according to the list Mo, Tu, We, ...
• month-of-year ... ...

Note: The set of enumeration values might be enhanced in the future and it might be possible in the future to define model specific comparison rules. So applications must not rely on the current set of comparison rules and always deal with unknown comparison rules.

Since:

NW Paris MS2

See Also:

Serialized Form

Type Classification:

This class is part of the Common Model Interface, so applications may reference it or call any method of this type, but they must not subclass it.

Field Summary

static CMIComparisonRule

MODEL_DEFINED Sort order is defined by the model implementation.

Method Summary

String	name() Returns the name of this comparison rule.
String	toString() Returns a String representation of the comparison rule.
static CMIComparisonRule	valueOf(String name) Returns the comparison rule with the given name.

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_DEFINED

public static final CMIComparisonRule MODEL_DEFINED

Sort order is defined by the model implementation.

Method Detail

name

public String name()

Returns the name of this comparison rule. The returned value is the only one for which valueOf(String) will return this instance of CMIComparisonRule. So applications that want to somehow persist comparison rules should persist the returned value.

toString

public String toString()

Returns a String representation of the comparison rule. This must not necessarily be the same as name() and it is especially not guaranteed that the returned value is accepted in a call to valueOf(String).

Overrides:

toString in class Object

valueOf

public static CMIComparisonRule valueOf(String name)

Returns the comparison rule with the given name.

Throws:

IllegalArgumentException - if the name does not match a comparison rule

Access Rights

This class can be accessed from:

SC	DC
[sap.com] FRAMEWORK	[sap.com] tc/cmi
[sap.com] FRAMEWORK	[sap.com] tc/cm/ejb/api