Field Detail

• FEATURE_KEY

  static final int FEATURE_KEY

  See Also:

  Constant Field Values

• TYPE_ORDER_KEY

  static final int TYPE_ORDER_KEY

  See Also:

  Constant Field Values

• STANDARD_COMPARE

  static final int STANDARD_COMPARE

  Compare key1 of fs1 with key2 of fs2 so that the order of fs1 and fs2 is the same as that of key1 and key2 in the standard order for that kind of key. For integer and float values, this is the standard linear order, and for strings it is lexicographic order.

  See Also:

  Constant Field Values

• REVERSE_STANDARD_COMPARE

  static final int REVERSE_STANDARD_COMPARE

  Compare key1 of fs1 with key2 of fs2 so that the order of fs1 and fs2 is the reverse as that of key1 and key2 (with respect to the standard order of that key).

  See Also:

  Constant Field Values

Method Detail

• setType

  void setType(Type type)

  Set the type of this comparator. Note that you can use this method more than once, in case you need to generate indices that are identical except for the type.

  Parameters:

  type - The type of the index.

• getType

  Type getType()

  Get the type of this comparator.

  Returns:

  The type of the comparator.

• addKey

  int addKey(Feature feat,
           int compareKey)

  Add a new key.

  Parameters:

  feat - The key feature.

  compareKey - The way to compare the key values.

  Returns:

  The number of the key.

• addKey

  int addKey(LinearTypeOrder typeOrder,
           int compareKey)

• getNumberOfKeys

  int getNumberOfKeys()

  Return the number of keys.

  Returns:

  the number of keys.

• getKeyType

  int getKeyType(int key)

• getKeyFeature

  Feature getKeyFeature(int key)

  Get the feature for this key.

  Parameters:

  key - The number of the key.

  Returns:

  The corresponding feature, if it exists; null, else.

• getKeyComparator

  int getKeyComparator(int key)

  Get the comparator for this key.

  Parameters:

  key - The number of the key.

  Returns:

  The corresponding comparator, if it exists; -1, else.

• equals

  boolean equals(java.lang.Object o)

  Test for equality against another FSIndexComparator true iff the comparators have the same keys and comparators.

  Overrides:

  equals in class java.lang.Object

• isValid

  boolean isValid()

  Validate that this comparator is valid with respect to the type system. Note that all types and features used to define this comparator must come from the same type system. Note that this method only returns true or false. It doesn't tell you what's actually wrong. Maybe we need to change that?

  Returns:

  true iff all key features are appropriate for the type of this comparator.