Interface ProvideSetComparisonInfo

public interface ProvideSetComparisonInfo
{
  // Fields
  static final int EXCLUDE;
  static final int INCLUDE;

  // Methods
  Object combineSetRules (Object o1, Object o2);
  int compareSetRules (Object o1, Object o2);
  Object getSetRule (int rule);
  String getStringForSetRule (Object o);
  Object intersectSetRules (Object o1, Object o2);
  boolean isEmptySetRule (Object o);
}

This interface provides set rules for comparisons. A set rule is an opaque value that defines a group of members from one or more sets. The rules can be manipulated using the operators on this interface. Rules are manipulated as Objects. Clients of this interface should not attempt to interpret the value of any objects returned from the methods.

Methods

combineSetRules

Object combineSetRules (Object o1, Object o2);

Computes the union of two objects retrieved from getSetRule or objects derived through other methods on this interface.

Return Value:

Returns a new set rule representing the union of the two rules, o1 and o2.

Parameter	Description
o1	The first set rule.
o2	The second set rule.

compareSetRules

int compareSetRules (Object o1, Object o2);

Compares two objects retrieved from getSetRule or objects derived through other methods on this interface.

Return Value:

Returns a SetComparison.compareSet return code.

Parameter	Description
o1	The first set rule to compare.
o2	The second set rule to compare.

getSetRule

Object getSetRule (int rule);

Obtains an object representing the specified rule that can be used internally by SetComparer.

Return Value:

Returns the object specifying the rule. The object is treated as an opaque value and is provided to the other operators on this interface to obtain further information.

Parameter	Description
rule	The rule, which can be either INCLUDE or EXCLUDE.

getStringForSetRule

String getStringForSetRule (Object o);

Retrieves a string representation of a given rule.

Return Value:

Returns the String representing the rule.

Parameter	Description
o	The given rule.

intersectSetRules

Object intersectSetRules (Object o1, Object o2);

Computes the intersection of two objects retrieved from getSetRule or objects derived through other methods on this interface.

Return Value:

Returns a new set rule representing the intersection of the two rules, o1 and o2.

Parameter	Description
o1	The first set rule.
o2	The second set rule.

isEmptySetRule

boolean isEmptySetRule (Object o);

Determines if the given set rule is empty.

Return Value:

Returns true if the object is empty; otherwise, returns false.

Parameter	Description
o	The given set rule.

Fields

EXCLUDE

Indicates the set rule specifying members that are excluded from the set.

INCLUDE

Indicates the set rule specifying members that are included in the set.