public interface MetaMapApi
MetaMapApi api = new MetaMapApiImpl(); if (theOptions.size() > 0) { api.setOptions(theOptions); } ListresultList = api.processCitationsFromString(terms); for (Result result: resultList) { if (result != null) { ... inspect result ... } }
MetaMap options available in the api:
-@ --WSD <hostname> : Which WSD server to use. -8 --dynamic_variant_generation : dynamic variant generation -A --strict_model : use strict model -C --relaxed_model : use relaxed model -D --all_derivational_variants : all derivational variants -J --restrict_to_sts <semtypelist> : restrict to semantic types -K --ignore_stop_phrases : ignore stop phrases. -R --restrict_to_sources <sourcelist> : restrict to sources -S --tagger <sourcelist> : Which tagger to use. -V --mm_data_version <name> : version of MetaMap data to use. -X --truncate_candidates_mappings : truncate candidates mapping -Y --prefer_multiple_concepts : prefer multiple concepts -Z --mm_data_year <name> : year of MetaMap data to use. -a --all_acros_abbrs : allow Acronym/Abbreviation variants -b --compute_all_mappings : compute/display all mappings -d --no_derivational_variants : no derivational variants -e --exclude_sources <sourcelist> : exclude semantic types -g --allow_concept_gaps : allow concept gaps -i --ignore_word_order : ignore word order -k --exclude_sts <semtypelist> : exclude semantic types -l --allow_large_n : allow Large N -o --allow_overmatches : allow overmatches -r --threshold <integer> : Threshold for displaying candidates. -y --word_sense_disambiguation : use WSD -z --term_processing : use term processing
If the function setOptions is used to set options arguments to be applied to processCitationsFromString(String), processCitationsFromReader(Reader), and processCitationsFromFile(String) the state of set options remains in force until the function resetOptions is called.
Use the functions processCitationsFromString(String,String), processCitationsFromReader(String, Reader), and processCitationsFromFile(String, String) to set the options for one request. Created: Wed Apr 29 14:09:20 2009
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SERVER_HOST
default hostname of MetaMap server
|
static int |
DEFAULT_SERVER_PORT
default port of MetaMap server
|
static int |
DEFAULT_TIMEOUT
Default time out for api session
|
Modifier and Type | Method and Description |
---|---|
void |
disconnect()
disconnect from server.
|
String |
getOptions()
Get the server's current option settings.
|
se.sics.prologbeans.PrologSession |
getSession()
Return Prolog session associated with this instance of the API.
|
void |
invokeSetOptions(String optionListString)
Deprecated.
|
List<Result> |
processCitationsFromFile(String inputFilename)
Process a ASCII text file of one or more documents - unicode (utf8) is not supported
|
List<Result> |
processCitationsFromFile(String optionString,
String inputFilename)
Process a ASCII text file of one or more documents - unicode (utf8) is not supported
|
List<Result> |
processCitationsFromReader(Reader inputReader)
Process a ASCII text stream reader of one or more documents - unicode (utf8) is not supported
|
List<Result> |
processCitationsFromReader(String optionString,
Reader inputReader)
Process a ASCII text stream reader of one or more documents - unicode (utf8) is not supported
|
List<Result> |
processCitationsFromString(String aString)
process a string containing one or more documents - unicode (utf8) is not supported
|
List<Result> |
processCitationsFromString(String optionString,
String aString)
process a string containing one or more documents - unicode (utf8) is not supported
|
void |
resetOptions()
Reset options to defaults
|
void |
setHost(String hostname)
Use MetaMap server on specified host
|
void |
setOptions(List<String> options)
Set MetaMap server options.
|
void |
setOptions(String optionString)
Set MetaMap server options using a string of form:
|
void |
setOptions(String[] options) |
void |
setPort(int port)
Use MetaMap server on specified port
|
void |
setTimeout(int timeout)
Set time for api prolog session.
|
void |
unsetOptions(List<String> options)
Deprecated.
|
void |
unsetOptions(String optionString)
Deprecated.
|
static final int DEFAULT_TIMEOUT
static final String DEFAULT_SERVER_HOST
static final int DEFAULT_SERVER_PORT
String getOptions()
void setOptions(String optionString)
"-option1 optional-argument1 -option2 optional-argument2"examples:
"-yD" or "-y -D" or "-J SNOMEDCT" or "--restrict_to_sources SNOMEDCT"
Set MetaMap server options. State of options are preserved in subsequent invocations of processCitationsFromString(String), processCitationsFromReader(Reader), and processCitationsFromFile(String).
optionString
- a string of MetaMap optionsvoid setOptions(String[] options)
options
- options stringvoid setOptions(List<String> options)
list of the form:
["-y", "-D"] or ["-yD"]
options
- a list of optionsvoid invokeSetOptions(String optionListString)
This method sends preprocessed options to MetaMap server. The parameter optionListString is in the form of:
"[" + "'" + option + "'" + "," + + "'" + option + "'" + ... "]"E.G.:
optionListString = "['-y','-D','-i']";or:
optionListString = "['-yDi']";sets options -y -D and -i.
optionListString
- a string of MetaMap optionsvoid unsetOptions(String optionString)
string is of the form:
"-option1 optional-argument1 -option2 optional-argument2"E.G.:
"-yD" or "-y -D" or
This is deprecated, use resetOptions instead.
optionString
- a string of MetaMap optionsvoid unsetOptions(List<String> options)
The list is a list of strings of the form:
["-y", "-D"] or ["-yD"]
This is deprecated, use resetOptions instead.
options
- a list of optionsvoid resetOptions()
List<Result> processCitationsFromString(String aString)
aString
- a file of documentsList<Result> processCitationsFromString(String optionString, String aString)
using string of form:
"-y -D" or "-yD"
optionString
- options stringaString
- a string containing documents to be processed.List<Result> processCitationsFromReader(Reader inputReader)
inputReader
- a reader stream of documentsList<Result> processCitationsFromReader(String optionString, Reader inputReader)
using string of form:
"-y -D" or "-yD"
optionString
- options stringinputReader
- a reader stream of documentsList<Result> processCitationsFromFile(String inputFilename)
inputFilename
- the filename of a file of documentsList<Result> processCitationsFromFile(String optionString, String inputFilename)
using string of form:
"-y -D" or "-yD"
optionString
- options stringinputFilename
- the filename of a file of documentsse.sics.prologbeans.PrologSession getSession()
void setTimeout(int timeout)
timeout
- time in milliseconds to wait for prolog server before timing out.void setPort(int port)
port
- of MetaMap server to use.void setHost(String hostname)
hostname
- hostname of non-local metamap servervoid disconnect()
Copyright © 2016. All rights reserved.