|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.baseprogramming.lang.WordReference
public class WordReference
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 |
---|
public WordReference(java.lang.String key)
key-API
- key for www.wordreference.comMethod Detail |
---|
public boolean isAutoSave()
public void setAutoSave(boolean bool)
bool
- public java.lang.String getLocalLibrary()
public void setLocalLibrary(java.lang.String path)
path
- public boolean getUseLocalLibrary()
public void setUseLocalLibrary(boolean bool)
bool
- public java.lang.String getScheme()
public void setScheme(java.lang.String protocol)
protocol
- public java.lang.String getApiKey()
public void setApiKey(java.lang.String key)
key
- public java.lang.String getUrl()
public void setUrl(java.lang.String url)
url
- public java.lang.String getVersion()
public void setVersion(java.lang.String version)
version
- public java.lang.String getSourceLanguage()
public void setSourceLanguage(java.util.Locale local)
public void setSourceLanguage(java.lang.String lang)
public java.lang.String getTargetLanguage()
public void setTargetLanguage(java.util.Locale local)
public void setTargetLanguage(java.lang.String lang)
public java.util.List<Translation> translate(java.lang.String term) throws java.io.IOException, WordReferenceException
term
-
java.io.IOException
WordReferenceException
public java.util.List<Translation> translate(java.lang.String term, java.lang.String dictionary) throws java.io.IOException, WordReferenceException
termtermterm
- dictionary
-
java.io.IOException
WordReferenceException
public java.util.List<Synonym> getSynonyms(java.lang.String term) throws java.io.FileNotFoundException, WordReferenceException, java.net.MalformedURLException, java.io.IOException
term
-
java.io.FileNotFoundException
java.net.MalformedURLException
java.io.IOException
WordReferenceException
public java.util.List<TermSense> getSynonymsBySense(java.lang.String term) throws java.io.FileNotFoundException, WordReferenceException, java.net.MalformedURLException, java.io.IOException
term
-
java.io.FileNotFoundException
java.net.MalformedURLException
java.io.IOException
WordReferenceException
public ThesaurusTerm searchThesaurus(java.lang.String term) throws java.io.FileNotFoundException, WordReferenceException, java.net.MalformedURLException, java.io.IOException
term
-
java.io.FileNotFoundException
java.net.MalformedURLException
java.io.IOException
WordReferenceException
public PacketTypes getFirstPacketType()
public WordReferencePacket getFirstPacket()
public Translation getTranslation()
public Translation getTranslation(int index)
index
-
public Translation getTranslation(java.lang.String packet) throws java.lang.IllegalAccessException
packet
-
java.lang.IllegalAccessException
public Translation getTranslation(java.lang.String packetname, int index) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
packetname
- index
-
java.lang.IllegalArgumentException
java.lang.IndexOutOfBoundsException
public Translation getTranslation(java.lang.String packetname, TranslationCategories category) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
packetname
- category
-
java.lang.IllegalArgumentException
java.lang.IndexOutOfBoundsException
public Translation getTranslation(java.lang.String packetname, TranslationCategories category, int index) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
packetname
- category
- index
-
java.lang.IllegalArgumentException
java.lang.IndexOutOfBoundsException
public java.util.List<Translation> getAllTranslations() throws java.lang.IllegalStateException, java.lang.IllegalAccessException
java.lang.IllegalStateException
java.lang.IllegalAccessException
public java.util.List<TranslationPacket> getTermPackets() throws java.lang.IllegalStateException, java.lang.IllegalAccessException
java.lang.IllegalStateException
java.lang.IllegalAccessException
public java.util.List<Translation> getTranslationCompounds() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public java.util.Set<java.lang.String> getPacketNames()
public java.util.Set<java.lang.String> getTranslationCategoryNames()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |