public class MetaMapApiImpl extends Object implements MetaMapApi
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:59:15 2009
Modifier and Type | Field and Description |
---|---|
protected boolean |
connected |
private String |
currentOptionListString |
private se.sics.prologbeans.PrologSession |
session |
DEFAULT_SERVER_HOST, DEFAULT_SERVER_PORT, DEFAULT_TIMEOUT
Constructor and Description |
---|
MetaMapApiImpl()
Instantiate api using the default timeout.
|
MetaMapApiImpl(int timeout)
Instantiate api using specified timeout.
|
MetaMapApiImpl(String serverHostname)
Instantiate api using MetaMap server specified by hostname
|
MetaMapApiImpl(String serverHostname,
int port)
Instantiate api using MetaMap server specified by hostname
|
MetaMapApiImpl(String serverHostname,
int port,
int timeout)
Instantiate api using MetaMap server specified by hostname with specified timeout.
|
Modifier and Type | Method and Description |
---|---|
String |
createOptionListString(String optionString) |
String |
createOptionListString(String[] options) |
void |
disconnect()
Disconnect from Prolog server.
|
protected void |
finalize() |
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
|
private List<Result> |
processCitationsFromStringWithNoOptions(String aString) |
private List<Result> |
processCitationsFromStringWithOptionListString(String optionListString,
String aString) |
void |
resetOptions()
Reset options to defaults
|
void |
saveOptions(String optionListString)
Save MetaMap server options.
|
void |
setHost(String hostname)
Use MetaMap server on specified host
|
void |
setOptions(List<String> options)
Set options using list of form:
|
void |
setOptions(String optionString)
Set MetaMap server options using a string of form:
|
void |
setOptions(String[] options)
Set MetaMap server options using array of form:
|
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.
|
private se.sics.prologbeans.PrologSession session
protected boolean connected
private String currentOptionListString
public MetaMapApiImpl()
public MetaMapApiImpl(int timeout)
timeout
- time in milliseconds to wait for prolog server before timing out.public MetaMapApiImpl(String serverHostname)
serverHostname
- hostname of metamap serverpublic MetaMapApiImpl(String serverHostname, int port)
serverHostname
- hostname of metamap serverport
- port of metamap serverpublic MetaMapApiImpl(String serverHostname, int port, int timeout)
serverHostname
- hostname of metamap serverport
- port metamap servertimeout
- time in milliseconds to wait for prolog server before timing out.public se.sics.prologbeans.PrologSession getSession()
getSession
in interface MetaMapApi
public void setTimeout(int timeout)
setTimeout
in interface MetaMapApi
timeout
- time in milliseconds to wait for prolog server before timing out.public void setPort(int port)
setPort
in interface MetaMapApi
port
- of MetaMap server to use.public void setHost(String hostname)
setHost
in interface MetaMapApi
hostname
- hostname of non-local metamap serverpublic String getOptions()
getOptions
in interface MetaMapApi
public String createOptionListString(String optionString)
optionString
- a string of MetaMap optionspublic void setOptions(String optionString)
"-option1 optional-argument1 -option2 optional-argument2"examples:
"-yD" or "-y -D" or "-J SNOMEDCT" or "--restrict_to_sources SNOMEDCT"
setOptions
in interface MetaMapApi
optionString
- a string of MetaMap optionspublic void setOptions(String[] options)
["-y", "-D"] or ["-yD"]
setOptions
in interface MetaMapApi
options
- an array of optionspublic void setOptions(List<String> options)
["-y", "-D"] or ["-yD"]
setOptions
in interface MetaMapApi
options
- a list of optionspublic void saveOptions(String optionListString)
"[" + "'" + option + "'" + "," + + "'" + option + "'" + ... "]"E.G.:
optionListString = "['-y','-D','-i']";or:
optionListString = "['-yDi']";sets options -y -D and -i.
optionListString
- a string of MetaMap options@Deprecated public void 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.
invokeSetOptions
in interface MetaMapApi
optionListString
- a string of MetaMap options@Deprecated public void unsetOptions(String optionString)
"-option1 optional-argument1 -option2 optional-argument2"E.G.:
"-yD" or "-y -D" or
unsetOptions
in interface MetaMapApi
optionString
- a string of MetaMap options@Deprecated public void unsetOptions(List<String> options)
["-y", "-D"] or ["-yD"]
unsetOptions
in interface MetaMapApi
options
- a list of optionspublic void resetOptions()
resetOptions
in interface MetaMapApi
private List<Result> processCitationsFromStringWithNoOptions(String aString)
public List<Result> processCitationsFromString(String aString)
processCitationsFromString
in interface MetaMapApi
aString
- a file of documentsprivate List<Result> processCitationsFromStringWithOptionListString(String optionListString, String aString)
public List<Result> processCitationsFromString(String optionString, String aString)
MetaMapApi
using string of form:
"-y -D" or "-yD"
processCitationsFromString
in interface MetaMapApi
optionString
- options stringaString
- a string containing documents to be processed.public List<Result> processCitationsFromReader(Reader inputReader)
processCitationsFromReader
in interface MetaMapApi
inputReader
- a reader stream of documentspublic List<Result> processCitationsFromReader(String optionString, Reader inputReader)
MetaMapApi
using string of form:
"-y -D" or "-yD"
processCitationsFromReader
in interface MetaMapApi
optionString
- options stringinputReader
- a reader stream of documentspublic List<Result> processCitationsFromFile(String inputFilename)
processCitationsFromFile
in interface MetaMapApi
inputFilename
- the filename of a file of documentspublic List<Result> processCitationsFromFile(String optionString, String inputFilename)
MetaMapApi
using string of form:
"-y -D" or "-yD"
processCitationsFromFile
in interface MetaMapApi
optionString
- options stringinputFilename
- the filename of a file of documentspublic void disconnect()
disconnect
in interface MetaMapApi
Copyright © 2016. All rights reserved.