craft

Class TermMapping

Object

craft.TermMapping

public class TermMapping
extends Object

Stores the strings needed to map some terms to useful alternate terms. So far only English is supported (volunteers welcome!).

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Properties	alternatives
(package private) Properties	plurals
(package private) Properties	prefixes
(package private) Properties	suffixes
(package private) Properties	types

Constructor Summary

Constructors

Constructor and Description
TermMapping(String language)

Method Summary

Modifier and Type	Method and Description
String	alt(String key) Looks up alternative words for purposes of creating natural language.
String	alt(String key, int cardinality) Looks up alternative words for purposes of creating natural language.
String	cardinalize(String s, int cardinality) Handles singular/plural issues for terms.
String	prefix(String relationlabel, boolean isActor) Determines a word or phrase to precede a given relation.
private void	putCombination(String original, String prefix, String alternative, String suffix)
private void	setupAlternatives()
private void	setupCombinations() For relations, these allow more natural sounding phrases to be constructed.
private void	setupEN()
private void	setupPlurals()
private void	setupPrefixes()
private void	setupSuffixes()
private void	setupTypes()
String	suffix(String relationlabel, boolean isActor) Determines a word or phrase to follow a given relation.
String	type(String type) Determines an alternative type label for certain labels.

Methods inherited from class Object

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

Field Detail

alternatives

Properties alternatives

prefixes

Properties prefixes

suffixes

Properties suffixes

plurals

Properties plurals

types

Properties types

Constructor Detail

TermMapping

public TermMapping(String language)

Parameters:

language - an ISO abbreviation for the language desired. So far, only "en" is supported. Volunteers are welcome for other languages.

Method Detail

alt

public String alt(String key,
                  int cardinality)

Looks up alternative words for purposes of creating natural language.

Parameters:

key - some term whose alternative form is sought.

cardinality - the quantity of the term being considered, especially useful for distinguishing singular from plural.

Returns:

alternative form if there is one; otherwise the key itself is returned.

alt

public String alt(String key)

Looks up alternative words for purposes of creating natural language. Assumes cardinality of 1.

Parameters:

key - some term whose alternative form is sought.

Returns:

alternative form if there is one; otherwise the key itself is returned.

suffix

public String suffix(String relationlabel,
                     boolean isActor)

Determines a word or phrase to follow a given relation. For example, for the relation "parent" might produce the word "of". For convenience, blank padding is provided for the returned word/phrase.

Parameters:

relationlabel - some relation whose appropriate suffix term is sought.

Returns:

blank-padded suffix for that relation.

prefix

public String prefix(String relationlabel,
                     boolean isActor)

Determines a word or phrase to precede a given relation. For example, for the relation "parent" might produce the word "is the". For convenience, blank padding is provided for the returned word/phrase.

Parameters:

relationlabel - some relation whose appropriate suffix term is sought.

Returns:

blank-padded suffix for that relation.

type

public String type(String type)

Determines an alternative type label for certain labels. For example, for the label "T" might produce the word "THING".

Parameters:

type - some label whose appropriate type label is sought.

Returns:

label for the type.

cardinalize

public String cardinalize(String s,
                          int cardinality)

Handles singular/plural issues for terms.

Parameters:

s - the term to be examined

cardinality - the number of things to which the term applies. Normally a 1 means singular, a number greater than one means plural.

setupEN

private void setupEN()

putCombination

private void putCombination(String original,
                            String prefix,
                            String alternative,
                            String suffix)

setupAlternatives

private void setupAlternatives()

setupSuffixes

private void setupSuffixes()

setupPrefixes

private void setupPrefixes()

setupPlurals

private void setupPlurals()

setupTypes

private void setupTypes()

setupCombinations

private void setupCombinations()

For relations, these allow more natural sounding phrases to be constructed.