Package com.planet_ink.coffee_mud.Libraries

Class DirtyLanguage

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.DirtyLanguage

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, LanguageLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class DirtyLanguage
extends StdLibrary
implements LanguageLibrary

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	country
protected java.util.Locale	currentLocale
protected java.lang.String	language

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

isDebugging, name, serviceClient, tickStatus

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
DirtyLanguage()

Method Summary

Modifier and Type	Method	Description
void	addAutoIgnoredString(java.lang.String str, DVector fileData, DVector fileIndexes, java.lang.String sectionName)
protected java.lang.String	basicParser(java.lang.String str, java.lang.String section, boolean nullIfLonger, boolean isParser)
void	clear()	Clears the cache of both the translator and the parser, allowing it all to be reloaded from the properties files on the filesystem.
java.lang.String	commandWordTranslation(java.lang.String str)	This unique translator is mostly run at boot time to translate the cached command words of commands, abilities, and similar things to the localized term.
java.lang.String	failedItemParser(java.lang.String item)	When a command or some other process is requesting access to a room or inventory item by name, and the entry from the user fails to find the item, this filter will be called to provide a "second chance" item name.
protected java.lang.String	filterString(java.lang.String str)
java.lang.String	filterTranslation(java.lang.String item)	The filter translation is an output translation that only handles pronoun tags, like S-NAME, T-YOUPOSS, etc.
java.lang.String	finalTranslation(java.lang.String item)	After an output string has gone through all the other processes, if there are any other translations to be done, this will handle it.
java.lang.String	fullSessionTranslation(java.lang.String str, java.lang.String... xs)	This is the main output and variable translator.
protected DVector	getLanguageParser(java.lang.String parser)
protected java.lang.String	getLanguageParserKey()
protected DVector	getLanguageTranslator(java.lang.String parser)
protected java.lang.String	getLanguageTranslatorKey()
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	insertExpansion(java.util.List<java.lang.String> MORE_CMDS, java.lang.String str, int m, int strLen, boolean nothingDone)
java.lang.String	L(java.lang.String str, java.lang.String... xs)	Localize an internal string -- shortcut.
protected java.util.Hashtable<java.lang.String,DVector>	loadFileSections(java.lang.String filename)
java.util.List<java.util.List<java.lang.String>>	preCommandParser(java.util.List<java.lang.String> commands)	Accepts user-entered pre-parsed command list, and generates a list containing one or more translated full command lists.
java.lang.String	preItemParser(java.lang.String item)	When a command or some other process is requesting access to a room or inventory item by name, or sometimes and exit, then this parser is called with the user input to translate things into a final search string.
void	propertiesLoaded()	This method is called whenever system properties are altered by the user.
java.lang.String	rawInputParser(java.lang.String words)	During login or other input that does not involve commands, this input parser can translate input.
java.lang.String	replaceWithDefinitions(DVector global, DVector local, java.lang.String str)
java.lang.String	sessionTranslation(java.lang.String item)	A translator for static internal string, such as those found on interfaces.
java.lang.String[]	sessionTranslation(java.lang.String[] str)	A translator for static internal string arrays, such as those found on interfaces.
void	setLocale(java.lang.String lang, java.lang.String state)	Initializes the localization library by setting the language and state code, thus pointing the mud at which translation properties files to use.
protected java.lang.String	unFilterString(java.lang.String str)

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, name, newInstance, setThreadStatus, shutdown, tick

Field Detail

language

protected java.lang.String language

country

protected java.lang.String country

currentLocale

protected java.util.Locale currentLocale

Constructor Detail

DirtyLanguage

public DirtyLanguage()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdLibrary

Returns:

the name of this class

setLocale

public void setLocale(java.lang.String lang,
                      java.lang.String state)

Description copied from interface: LanguageLibrary

Initializes the localization library by setting the language and state code, thus pointing the mud at which translation properties files to use.

Specified by:

setLocale in interface LanguageLibrary

Parameters:

lang - the language code, default en

state - the state code, default TX

propertiesLoaded

public void propertiesLoaded()

Description copied from interface: CMLibrary

This method is called whenever system properties are altered by the user. This allows the library to react to any important properties they monitor.

Specified by:

propertiesLoaded in interface CMLibrary

Overrides:

propertiesLoaded in class StdLibrary

replaceWithDefinitions

public java.lang.String replaceWithDefinitions(DVector global,
                                               DVector local,
                                               java.lang.String str)

filterString

protected java.lang.String filterString(java.lang.String str)

unFilterString

protected java.lang.String unFilterString(java.lang.String str)

loadFileSections

protected java.util.Hashtable<java.lang.String,DVector> loadFileSections(java.lang.String filename)

getLanguageTranslatorKey

protected final java.lang.String getLanguageTranslatorKey()

getLanguageParserKey

protected final java.lang.String getLanguageParserKey()

getLanguageParser

protected DVector getLanguageParser(java.lang.String parser)

getLanguageTranslator

protected DVector getLanguageTranslator(java.lang.String parser)

clear

public void clear()

Description copied from interface: LanguageLibrary

Clears the cache of both the translator and the parser, allowing it all to be reloaded from the properties files on the filesystem.

Specified by:

clear in interface LanguageLibrary

insertExpansion

public boolean insertExpansion(java.util.List<java.lang.String> MORE_CMDS,
                               java.lang.String str,
                               int m,
                               int strLen,
                               boolean nothingDone)

preCommandParser

public java.util.List<java.util.List<java.lang.String>> preCommandParser(java.util.List<java.lang.String> commands)

Description copied from interface: LanguageLibrary

Accepts user-entered pre-parsed command list, and generates a list containing one or more translated full command lists. This is called whenever the user enters a command at the main prompt.

Specified by:

preCommandParser in interface LanguageLibrary

Parameters:

commands - the pre-parsed command list

Returns:

a list with the translated command list

basicParser

protected java.lang.String basicParser(java.lang.String str,
                                       java.lang.String section,
                                       boolean nullIfLonger,
                                       boolean isParser)

addAutoIgnoredString

public void addAutoIgnoredString(java.lang.String str,
                                 DVector fileData,
                                 DVector fileIndexes,
                                 java.lang.String sectionName)

preItemParser

public java.lang.String preItemParser(java.lang.String item)

Description copied from interface: LanguageLibrary

When a command or some other process is requesting access to a room or inventory item by name, or sometimes and exit, then this parser is called with the user input to translate things into a final search string.

Specified by:

preItemParser in interface LanguageLibrary

Parameters:

item - the user entered item name

Returns:

null to use the users word, or the new translated string

failedItemParser

public java.lang.String failedItemParser(java.lang.String item)

Description copied from interface: LanguageLibrary

When a command or some other process is requesting access to a room or inventory item by name, and the entry from the user fails to find the item, this filter will be called to provide a "second chance" item name. Or null to skip the second chance.

Specified by:

failedItemParser in interface LanguageLibrary

Parameters:

item - the user entered item name

Returns:

null, or a substitute item name to try

rawInputParser

public java.lang.String rawInputParser(java.lang.String words)

Description copied from interface: LanguageLibrary

During login or other input that does not involve commands, this input parser can translate input.

Specified by:

rawInputParser in interface LanguageLibrary

Parameters:

words - the input

Returns:

the new input

filterTranslation

public java.lang.String filterTranslation(java.lang.String item)

Description copied from interface: LanguageLibrary

The filter translation is an output translation that only handles pronoun tags, like S-NAME, T-YOUPOSS, etc. After the engine generates the proper english replacement (usually a mob or object name), then this filter is given a pass as it to localize the output.

Specified by:

filterTranslation in interface LanguageLibrary

Parameters:

item - ONLY the replacement from a tag

Returns:

null, or the localized replacement string

sessionTranslation

public java.lang.String sessionTranslation(java.lang.String item)

Description copied from interface: LanguageLibrary

A translator for static internal string, such as those found on interfaces. How this manages to set the locale before a lot of those strings get loaded by Java is probably a problem.

Specified by:

sessionTranslation in interface LanguageLibrary

Parameters:

item - the static string

Returns:

the translated static string

finalTranslation

public java.lang.String finalTranslation(java.lang.String item)

Description copied from interface: LanguageLibrary

After an output string has gone through all the other processes, if there are any other translations to be done, this will handle it. This is called immediately before an entire block of text is sent to the user.

Specified by:

finalTranslation in interface LanguageLibrary

Parameters:

item - the string to send to the user

Returns:

null, or a new string to send to the user

fullSessionTranslation

public java.lang.String fullSessionTranslation(java.lang.String str,
                                               java.lang.String... xs)

Description copied from interface: LanguageLibrary

This is the main output and variable translator. Most internal system strings go through this method for localization. This also handles the @x1 @x2, ... variable replacements.

Specified by:

fullSessionTranslation in interface LanguageLibrary

Parameters:

str - the variable-laden english system string

xs - variable values, NOT translated

Returns:

the full translated and variable-replaced string

sessionTranslation

public java.lang.String[] sessionTranslation(java.lang.String[] str)

Description copied from interface: LanguageLibrary

A translator for static internal string arrays, such as those found on interfaces. How this manages to set the locale before a lot of those classes get loaded by Java is probably a problem.

Specified by:

sessionTranslation in interface LanguageLibrary

Parameters:

str - the static string array

Returns:

the translated static string array

commandWordTranslation

public java.lang.String commandWordTranslation(java.lang.String str)

Description copied from interface: LanguageLibrary

This unique translator is mostly run at boot time to translate the cached command words of commands, abilities, and similar things to the localized term. Most input translators take a localized term to generate an english word the system can process, whereas this does the reverse: translate english into the localized language so that the user can match that term directly.

Specified by:

commandWordTranslation in interface LanguageLibrary

Parameters:

str - a single command word

Returns:

the given word, or the translated word

L

public java.lang.String L(java.lang.String str,
                          java.lang.String... xs)

Description copied from interface: CMLibrary

Localize an internal string -- shortcut. Same as calling:

Specified by:

L in interface CMLibrary

Overrides:

L in class StdLibrary

Parameters:

str - the string to translate

xs - the array of variables to replace

Returns:

the translated string, with all variables in place

See Also:

Call with the string to translate, which may contain variables of the form @x1, @x2, etc. The array in xs is then used to replace the variables AFTER the string is translated.