com.baseprogramming.lang
Class WordReference

java.lang.Object
  extended by com.baseprogramming.lang.WordReference

public class WordReference
extends java.lang.Object

Obtain translation or synonyms (English only as of 10/24/2011) from www.wordreference.com. To store results locally (for future use) provide a Local library path. If a Local Library path is provided, this location is searched first, before going to the web to get new results.


Constructor Summary
WordReference(java.lang.String key)
          Create instance.
 
Method Summary
 java.util.List<Translation> getAllTranslations()
          Return a list of translations from ALL 'term*' packets.
 java.lang.String getApiKey()
          Get current API key
 WordReferencePacket getFirstPacket()
           
 PacketTypes getFirstPacketType()
          Get the Packet type of the first packet found (null if list is empty)
 java.lang.String getLocalLibrary()
          Get Local Library path
 java.util.Set<java.lang.String> getPacketNames()
          Get packet names
 java.lang.String getScheme()
          Get scheme
 java.lang.String getSourceLanguage()
           
 java.util.List<Synonym> getSynonyms(java.lang.String term)
          Get all synonyms for this term(not separated by sense).
 java.util.List<TermSense> getSynonymsBySense(java.lang.String term)
          Get the list of Term Senses for ThesaurusTerm generated for this term
 java.lang.String getTargetLanguage()
           
 java.util.List<TranslationPacket> getTermPackets()
           
 Translation getTranslation()
          Get the first translation in the Principals category of term0
 Translation getTranslation(int index)
          Get the category with given index in the PrincipalTranslations category of term0
 Translation getTranslation(java.lang.String packet)
          Returns the first PrincipalTranslations in this packet
 Translation getTranslation(java.lang.String packetname, int index)
          get the PrincipalTranslations in this packet name with given index
 Translation getTranslation(java.lang.String packetname, TranslationCategories category)
          Get a translation @ index 0 of this category in this packet
 Translation getTranslation(java.lang.String packetname, TranslationCategories category, int index)
          Get a translation from this packet, category, and index
 java.util.Set<java.lang.String> getTranslationCategoryNames()
          Get the category names for the first packet
 java.util.List<Translation> getTranslationCompounds()
          Get translation compounds
 java.lang.String getUrl()
          Get URL.
 boolean getUseLocalLibrary()
          Get current UseLocalLibrary flag.
 java.lang.String getVersion()
          Get current version setting.
 boolean isAutoSave()
          Get current auto save flag
 ThesaurusTerm searchThesaurus(java.lang.String term)
          Search the Thesaurus and return the Thesaurus Term generated.
 void setApiKey(java.lang.String key)
          Set www.wordreference.com API key
 void setAutoSave(boolean bool)
          Set AutoSave Flag.
 void setLocalLibrary(java.lang.String path)
          Set Local Library path.
 void setScheme(java.lang.String protocol)
          Set scheme.
 void setSourceLanguage(java.util.Locale local)
           
 void setSourceLanguage(java.lang.String lang)
           
 void setTargetLanguage(java.util.Locale local)
           
 void setTargetLanguage(java.lang.String lang)
           
 void setUrl(java.lang.String url)
          Set URL.
 void setUseLocalLibrary(boolean bool)
          Set UseLocalLibrary path.
 void setVersion(java.lang.String version)
          Set version.
 java.util.List<Translation> translate(java.lang.String term)
          Translate term term using the current dictionary settings (Source Local and Target Local
 java.util.List<Translation> translate(java.lang.String term, java.lang.String dictionary)
          Translate termtermterm (term) with given dictionary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WordReference

public WordReference(java.lang.String key)
Create instance.

Parameters:
key-API - key for www.wordreference.com
Method Detail

isAutoSave

public boolean isAutoSave()
Get current auto save flag

Returns:
boolean

setAutoSave

public void setAutoSave(boolean bool)
Set AutoSave Flag. See www.wordreference.com API terms of service before storing data locally

Parameters:
bool -

getLocalLibrary

public java.lang.String getLocalLibrary()
Get Local Library path

Returns:
String

setLocalLibrary

public void setLocalLibrary(java.lang.String path)
Set Local Library path. See www.wordreference.com API terms of service before storing data locally

Parameters:
path -

getUseLocalLibrary

public boolean getUseLocalLibrary()
Get current UseLocalLibrary flag.

Returns:
boolean

setUseLocalLibrary

public void setUseLocalLibrary(boolean bool)
Set UseLocalLibrary path. See www.wordreference.com API terms of service before storing data locally

Parameters:
bool -

getScheme

public java.lang.String getScheme()
Get scheme

Returns:
String

setScheme

public void setScheme(java.lang.String protocol)
Set scheme. Default is http

Parameters:
protocol -

getApiKey

public java.lang.String getApiKey()
Get current API key

Returns:
String

setApiKey

public void setApiKey(java.lang.String key)
Set www.wordreference.com API key

Parameters:
key -

getUrl

public java.lang.String getUrl()
Get URL. Default is api.wordreference.com. Unlikely to change

Returns:
String

setUrl

public void setUrl(java.lang.String url)
Set URL. Default is api.wordreference.com. Unlikely to change

Parameters:
url -

getVersion

public java.lang.String getVersion()
Get current version setting.

Returns:
String

setVersion

public void setVersion(java.lang.String version)
Set version. Generally it is best to omit to allow api to choose latest version.

Parameters:
version -

getSourceLanguage

public java.lang.String getSourceLanguage()

setSourceLanguage

public void setSourceLanguage(java.util.Locale local)

setSourceLanguage

public void setSourceLanguage(java.lang.String lang)

getTargetLanguage

public java.lang.String getTargetLanguage()

setTargetLanguage

public void setTargetLanguage(java.util.Locale local)

setTargetLanguage

public void setTargetLanguage(java.lang.String lang)

translate

public java.util.List<Translation> translate(java.lang.String term)
                                      throws java.io.IOException,
                                             WordReferenceException
Translate term term using the current dictionary settings (Source Local and Target Local

Parameters:
term -
Returns:
Translation(FirstTranslation of Element 0 of PrincipalTranslations of term0)
Throws:
java.io.IOException
WordReferenceException

translate

public java.util.List<Translation> translate(java.lang.String term,
                                             java.lang.String dictionary)
                                      throws java.io.IOException,
                                             WordReferenceException
Translate termtermterm (term) with given dictionary

Parameters:
termtermterm -
dictionary -
Returns:
A List of all translation entries found
Throws:
java.io.IOException
WordReferenceException

getSynonyms

public java.util.List<Synonym> getSynonyms(java.lang.String term)
                                    throws java.io.FileNotFoundException,
                                           WordReferenceException,
                                           java.net.MalformedURLException,
                                           java.io.IOException
Get all synonyms for this term(not separated by sense).

Parameters:
term -
Returns:
Throws:
java.io.FileNotFoundException
java.net.MalformedURLException
java.io.IOException
WordReferenceException

getSynonymsBySense

public java.util.List<TermSense> getSynonymsBySense(java.lang.String term)
                                             throws java.io.FileNotFoundException,
                                                    WordReferenceException,
                                                    java.net.MalformedURLException,
                                                    java.io.IOException
Get the list of Term Senses for ThesaurusTerm generated for this term

Parameters:
term -
Returns:
List
Throws:
java.io.FileNotFoundException
java.net.MalformedURLException
java.io.IOException
WordReferenceException

searchThesaurus

public ThesaurusTerm searchThesaurus(java.lang.String term)
                              throws java.io.FileNotFoundException,
                                     WordReferenceException,
                                     java.net.MalformedURLException,
                                     java.io.IOException
Search the Thesaurus and return the Thesaurus Term generated.

Parameters:
term -
Returns:
ThesaurusTerm
Throws:
java.io.FileNotFoundException
java.net.MalformedURLException
java.io.IOException
WordReferenceException

getFirstPacketType

public PacketTypes getFirstPacketType()
Get the Packet type of the first packet found (null if list is empty)

Returns:

getFirstPacket

public WordReferencePacket getFirstPacket()

getTranslation

public Translation getTranslation()
Get the first translation in the Principals category of term0

Returns:
translation

getTranslation

public Translation getTranslation(int index)
Get the category with given index in the PrincipalTranslations category of term0

Parameters:
index -
Returns:

getTranslation

public Translation getTranslation(java.lang.String packet)
                           throws java.lang.IllegalAccessException
Returns the first PrincipalTranslations in this packet

Parameters:
packet -
Returns:
Throws:
java.lang.IllegalAccessException

getTranslation

public Translation getTranslation(java.lang.String packetname,
                                  int index)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.IndexOutOfBoundsException
get the PrincipalTranslations in this packet name with given index

Parameters:
packetname -
index -
Returns:
Throws:
java.lang.IllegalArgumentException
java.lang.IndexOutOfBoundsException

getTranslation

public Translation getTranslation(java.lang.String packetname,
                                  TranslationCategories category)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.IndexOutOfBoundsException
Get a translation @ index 0 of this category in this packet

Parameters:
packetname -
category -
Returns:
Throws:
java.lang.IllegalArgumentException
java.lang.IndexOutOfBoundsException

getTranslation

public Translation getTranslation(java.lang.String packetname,
                                  TranslationCategories category,
                                  int index)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.IndexOutOfBoundsException
Get a translation from this packet, category, and index

Parameters:
packetname -
category -
index -
Returns:
Throws:
java.lang.IllegalArgumentException
java.lang.IndexOutOfBoundsException

getAllTranslations

public java.util.List<Translation> getAllTranslations()
                                               throws java.lang.IllegalStateException,
                                                      java.lang.IllegalAccessException
Return a list of translations from ALL 'term*' packets. the packet list must be one of DICTIONARY type packet, lest an exception be thrown

Returns:
Throws:
java.lang.IllegalStateException
java.lang.IllegalAccessException

getTermPackets

public java.util.List<TranslationPacket> getTermPackets()
                                                 throws java.lang.IllegalStateException,
                                                        java.lang.IllegalAccessException
Throws:
java.lang.IllegalStateException
java.lang.IllegalAccessException

getTranslationCompounds

public java.util.List<Translation> getTranslationCompounds()
                                                    throws java.lang.IllegalStateException
Get translation compounds

Returns:
Throws:
java.lang.IllegalStateException

getPacketNames

public java.util.Set<java.lang.String> getPacketNames()
Get packet names

Returns:

getTranslationCategoryNames

public java.util.Set<java.lang.String> getTranslationCategoryNames()
Get the category names for the first packet

Returns: