edu.illinois.cs.cogcomp.pipeline.server

Class ServerClientAnnotator

java.lang.Object

edu.illinois.cs.cogcomp.annotation.Annotator

edu.illinois.cs.cogcomp.pipeline.server.ServerClientAnnotator

public class ServerClientAnnotator
extends Annotator

Client to make calls to the remote pipeline server

Author:

khashab2

Field Summary

Fields inherited from class edu.illinois.cs.cogcomp.annotation.Annotator

config, isInitialized, requiredViews, viewName

Constructor Summary

Constructors

Constructor and Description
ServerClientAnnotator()
ServerClientAnnotator(String viewName)
ServerClientAnnotator(String viewName, String[] requiredViews)
ServerClientAnnotator(String viewName, String url, String port, String[] viewsToAdd)

Method Summary

Modifier and Type	Method and Description
void	addView(TextAnnotation ta) create and add the view named by getViewName() to the TextAnnotation argument.
void	addView(TextAnnotation ta, boolean overwrite)
TextAnnotation	annotate(String str)
TextAnnotation	annotate(String str, boolean overwrite)
void	close() MapDB requires the database to be closed at the end of operations.
void	initialize(ResourceManager rm) Derived classes use this to load memory- or time-consuming resources.
static void	main(String[] args)
void	setUrl(String url, String port)
void	setViews(String... viewsToAdd)
void	setViewsAll(String[] viewsToAdd)
void	useCaching()
void	useCaching(String dbFile)

Methods inherited from class edu.illinois.cs.cogcomp.annotation.Annotator

doInitialize, getRequiredViews, getTagValues, getView, getViewName, isInitialized, isSentenceLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerClientAnnotator

public ServerClientAnnotator()

ServerClientAnnotator

public ServerClientAnnotator(String viewName)

ServerClientAnnotator

public ServerClientAnnotator(String viewName,
                             String url,
                             String port,
                             String[] viewsToAdd)

ServerClientAnnotator

public ServerClientAnnotator(String viewName,
                             String[] requiredViews)
                      throws Exception

Throws:

Exception

Method Detail

setViewsAll

public void setViewsAll(String[] viewsToAdd)

setViews

public void setViews(String... viewsToAdd)

setUrl

public void setUrl(String url,
                   String port)

useCaching

public void useCaching()

useCaching

public void useCaching(String dbFile)

close

public void close()

MapDB requires the database to be closed at the end of operations. This is usually handled by the closeOnJvmShutdown() snippet in the initializer, but this method needs to be called if multiple instances of the TextAnnotationMapDBHandler are used.

initialize

public void initialize(ResourceManager rm)

Description copied from class: Annotator

Derived classes use this to load memory- or time-consuming resources. Don't try to log from this method unless your Logger is static. Generated code puts non-static Logger initialization in the constructor, so if lazyInitialize is 'false' you'll get a null pointer exception trying to write to Logger in initialize().

Specified by:

initialize in class Annotator

Parameters:

rm - configuration parameters

annotate

public TextAnnotation annotate(String str)
                        throws Exception

Throws:

Exception

annotate

public TextAnnotation annotate(String str,
                               boolean overwrite)
                        throws Exception

Parameters:

overwrite - if true, it would overwrite the values on cache

Throws:

Exception

addView

public void addView(TextAnnotation ta)

Description copied from class: Annotator

create and add the view named by getViewName() to the TextAnnotation argument.

Specified by:

addView in class Annotator

Parameters:

ta - the TextAnnotation to modify.

addView

public void addView(TextAnnotation ta,
                    boolean overwrite)

main

public static void main(String[] args)