Package com.machconsulting.utils

Class CapRules

java.lang.Object

com.machconsulting.utils.CapRules

public class CapRules
extends java.lang.Object

CapRules

Author:

Mike Hansen
This class is for capitalizing sentences correctly and proper names where known.

Constructor Summary

Constructors

Constructor	Description
CapRules()

Method Summary

Modifier and Type	Method	Description
void	addCustomNames(java.lang.String[] customNames)	Add customNames to modify capitalization rules to default set.
java.lang.String[]	getCustomNames()	Get list of custom capitalization names...
boolean	getNIVARules()	Capitalization title rules: True if NIVA rules.
boolean	isDebug()
java.lang.String[]	parseString(java.lang.String in)	This method takes a String and parses the String into all its parts preserving spaces and separating punctuation from words...
java.lang.String	sentenceCap(java.lang.String sentence)	This is the main program for fixing capitalization in a sentence
void	setCustomNames(java.lang.String[] customNames)	Set customNames to replace default capitalization rules set.
void	setDebug(boolean debug)	Turn on debugging as needed to see more of what happens internally...
void	setNIVARules(boolean niva)	Switches from default Chicago capitalization rules in titles to NIVA rules.
java.lang.String	stringWordSub(java.lang.String in, java.lang.String find, java.lang.String sub)	This will take in an "in" String, find Strings and replace them with subs.
java.lang.String	titleCap(java.lang.String title)	This is the main program for fixing capitalization in a title

Methods inherited from class java.lang.Object

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

Constructor Detail

CapRules

public CapRules()

Method Detail

sentenceCap

public java.lang.String sentenceCap(java.lang.String sentence)

This is the main program for fixing capitalization in a sentence

Parameters:

sentence - to be fixed

Returns:

sentence with capitalization done

titleCap

public java.lang.String titleCap(java.lang.String title)

This is the main program for fixing capitalization in a title

Parameters:

title - to be fixed

Returns:

title with capitalization done

getCustomNames

public java.lang.String[] getCustomNames()

Get list of custom capitalization names... return customNames[]

getNIVARules

public boolean getNIVARules()

Capitalization title rules: True if NIVA rules. False if of default Chicago rules.capitalization rules. This basically means that long prepositions will be capitalized in titles as per newer NIVA rules if true.

Returns:

boolean

isDebug

public boolean isDebug()

parseString

public java.lang.String[] parseString(java.lang.String in)

This method takes a String and parses the String into all its parts preserving spaces and separating punctuation from words...

Parameters:

in -

Returns:

String[] parts

stringWordSub

public java.lang.String stringWordSub(java.lang.String in,
                                      java.lang.String find,
                                      java.lang.String sub)

This will take in an "in" String, find Strings and replace them with subs. This takes into account spaces around the finds....

Parameters:

in - - String coming in

find - - String to find...

sub - - String to substitute for those found...

Returns:

out - String modified...

addCustomNames

public void addCustomNames(java.lang.String[] customNames)

Add customNames to modify capitalization rules to default set.

Parameters:

customNames -

setCustomNames

public void setCustomNames(java.lang.String[] customNames)

Set customNames to replace default capitalization rules set.

Parameters:

customNames -

setDebug

public void setDebug(boolean debug)

Turn on debugging as needed to see more of what happens internally...

Parameters:

debug -

setNIVARules

public void setNIVARules(boolean niva)

Switches from default Chicago capitalization rules in titles to NIVA rules. This basically means that long prepositions will be capitalized in titles as per newer NIVA rules.

Parameters:

niva -