kb.hierarchy

Class TypeMatchingRuleSet

Object

kb.hierarchy.TypeMatchingRuleSet

public class TypeMatchingRuleSet
extends Object

Encapsulates a set of constraints on type matching in the hierarchy. Currently allows type matching to ignore case, ignore spaces and ignore special characters. These are all orthogonal to each other; i.e., separate tests are made. Custom rules can also be added to the set.

Author:

Harry S. Delugach (delugach@uah.edu)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypeMatchingRuleSet.CharacterRule Allows the character rules to say what they do.

Field Summary

Fields

Modifier and Type	Field and Description
static TypeMatchingRuleSet	ignoreCaseSpacesSpecial A convenience set that ignores case, spaces and special characters.
private ArrayList<TypeMatchRule>	rules

Constructor Summary

Constructors

Constructor and Description
TypeMatchingRuleSet(TypeMatchingRuleSet.CharacterRule... ruleList) Create a set of rules according to the rules in the list.

Method Summary

Modifier and Type	Method and Description
void	addRule(TypeMatchRule rule) Add a rule to this set.
boolean	contains(TypeMatchRule rule) Determine whether a particular rule is in the set.
ArrayList<TypeMatchRule>	getRules() Get the list of rules currently in the set
void	removeRule(TypeMatchRule rule) Remove a particular rule from the set.
String	toString() Creates a human-readable version of the rule set.
String	transformByRules(TypeHierarchy h, String value) Use the hierarchy's set of rules to transform the string.

Methods inherited from class Object

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

Field Detail

rules

private ArrayList<TypeMatchRule> rules

ignoreCaseSpacesSpecial

public static TypeMatchingRuleSet ignoreCaseSpacesSpecial

A convenience set that ignores case, spaces and special characters. Useful when setting up defaults.

Constructor Detail

TypeMatchingRuleSet

public TypeMatchingRuleSet(TypeMatchingRuleSet.CharacterRule... ruleList)

Create a set of rules according to the rules in the list. This constructor will only create a set of character rules. Custom rules must be added by themselves.

Parameters:

ruleList - a sequence of character rule values (may be empty)

See Also:

TypeMatchingRules#addRule(kb.hierarchy.TypeMatchRule)

Method Detail

getRules

public ArrayList<TypeMatchRule> getRules()

Get the list of rules currently in the set

contains

public boolean contains(TypeMatchRule rule)

Determine whether a particular rule is in the set. Probably only useful for the character rules.

removeRule

public void removeRule(TypeMatchRule rule)

Remove a particular rule from the set. Probably only useful for the character rules.

addRule

public void addRule(TypeMatchRule rule)

Add a rule to this set. If the rule is already present, then does nothing.

Parameters:

rule -

transformByRules

public String transformByRules(TypeHierarchy h,
                               String value)

Use the hierarchy's set of rules to transform the string. Ignore top and bottom -- they aren't meant to be ever transformed.

toString

public String toString()

Creates a human-readable version of the rule set.

Overrides:

toString in class Object

Returns:

a human readable version of this set