org.thegalactic.rule

Class Rule

java.lang.Object

org.thegalactic.rule.Rule

All Implemented Interfaces:

Comparable<Rule>

Direct Known Subclasses:

AssociationRule

public class Rule
extends Object
implements Comparable<Rule>

This class gives a representation for an implicational rule.

A rule is composed of a premise and a conclusion that are comparable sets, i.e. sets of elements that can be sorted by the lectic order defined by class ComparableSet.

This class implements class Comparable aiming at sorting rules by providing the compareTo(org.thegalactic.rule.Rule) method.

Comparison between this component and those in parameter is realised by sorting their premises (lecticaly order), or their conclusion in case of equality of the premises.

The coherence of the lectically sort between rules isn’t ensured in case of modification of the rule. Therefore, it is strongly advised to replace each modified rule by a new one.

Constructor Summary

Constructors

Constructor and Description
Rule() Constructs a new empty Rule with a empty premise and an empty conclusion.
Rule(SortedSet<Comparable> premise, SortedSet<Comparable> conclusion) Constructs a new Rule with the premise and the conclusion given in parameters.

Method Summary

Modifier and Type	Method and Description
boolean	addAllToConclusion(Collection<Comparable> a) Adds the specified collection of indexed elements to the conclusion of this component.
boolean	addAllToPremise(Collection<Comparable> a) Adds the specified collection of indexed elements to the premise of this component.
boolean	addToConclusion(Comparable a) Adds the specified element to the conclusion of this component.
boolean	addToPremise(Comparable a) Adds the specified comparable to the premise of this component.
int	compareTo(Rule rule) Compares this component with the specified one by comparing their premises, or their conclusion in case of equality of the premises.
boolean	equals(Object object) Compares this component with the specified one.
ComparableSet	getConclusion() Returns a copy of the conclusion of the Rule.
ComparableSet	getPremise() Returns a copy of the premise of the Rule.
int	hashCode() Returns the hash code of this component.
boolean	removeAllFromConclusion(Collection<Comparable> a) Removes the specified collection of indexed elements from the conclusion of this component.
boolean	removeAllFromPremise(Collection<Comparable> a) Removes the specified collection of indexed elements from the premise of this component.
boolean	removeFromConclusion(Object a) Removes the specified comparable from the conclusion of this component.
boolean	removeFromPremise(Comparable a) Removes the specified comparable from the premise of this component.
String	toString() Returns a String representation of this component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Rule

public Rule()

Constructs a new empty Rule with a empty premise and an empty conclusion.

Rule

public Rule(SortedSet<Comparable> premise,
            SortedSet<Comparable> conclusion)

Constructs a new Rule with the premise and the conclusion given in parameters.

Parameters:

premise - a set of indexed elements

conclusion - a set of indexed elements

Method Detail

getPremise

public final ComparableSet getPremise()

Returns a copy of the premise of the Rule.

Returns:

premises of this component

getConclusion

public final ComparableSet getConclusion()

Returns a copy of the conclusion of the Rule.

Returns:

conclusions of this component

addToPremise

public final boolean addToPremise(Comparable a)

Adds the specified comparable to the premise of this component.

Parameters:

a - Comparable to add to this component’s premises.

Returns:

true if addition is successfull.

removeFromPremise

public final boolean removeFromPremise(Comparable a)

Removes the specified comparable from the premise of this component.

Parameters:

a - Comparable to remove to this component’s premises.

Returns:

true if addition is successfull.

addToConclusion

public final boolean addToConclusion(Comparable a)

Adds the specified element to the conclusion of this component.

Parameters:

a - Comparable to add to this component’s conclusions.

Returns:

true if addition is successfull.

removeFromConclusion

public final boolean removeFromConclusion(Object a)

Removes the specified comparable from the conclusion of this component.

Parameters:

a - Comparable to remove to this component’s conclusions.

Returns:

true if addition is successfull.

addAllToPremise

public final boolean addAllToPremise(Collection<Comparable> a)

Adds the specified collection of indexed elements to the premise of this component.

Parameters:

a - Collection of comparables to add to this component’s premises.

Returns:

true if addition is successfull.

removeAllFromPremise

public final boolean removeAllFromPremise(Collection<Comparable> a)

Removes the specified collection of indexed elements from the premise of this component.

Parameters:

a - Collection of comparables to remove to this component’s premises.

Returns:

true if addition is successfull.

addAllToConclusion

public final boolean addAllToConclusion(Collection<Comparable> a)

Adds the specified collection of indexed elements to the conclusion of this component.

Parameters:

a - Collection of comparables to add to this component’s conclusions.

Returns:

true if addition is successfull.

removeAllFromConclusion

public final boolean removeAllFromConclusion(Collection<Comparable> a)

Removes the specified collection of indexed elements from the conclusion of this component.

Parameters:

a - Collection of comparables to remove to this component’s conclusions.

Returns:

true if addition is successfull.

toString

public String toString()

Returns a String representation of this component.

The following format is used:

[elements of the premise separated by a space] -> [elements of the conclusion separated by a space]

a StringTokenizer is used to delete spaces in the string description of each element of premise and conclusion

Overrides:

toString in class Object

Returns:

a string made of premises followed by -> and the conclusions.

hashCode

public int hashCode()

Returns the hash code of this component.

Overrides:

hashCode in class Object

Returns:

hash code of this component

equals

public boolean equals(Object object)

Compares this component with the specified one.

Overrides:

equals in class Object

Parameters:

object - object to compare to this component.

Returns:

true or false as this componant is equals to the specified object.

compareTo

public final int compareTo(Rule rule)

Compares this component with the specified one by comparing their premises, or their conclusion in case of equality of the premises.

Specified by:

compareTo in interface Comparable<Rule>

Parameters:

rule - object to compare to this component.

Returns:

a negative integer, zero, or a positive integer as this component is less than, equal to, or greater than the specified object.