edu.illinois.cs.cogcomp.curator

Class CuratorClient

java.lang.Object

edu.illinois.cs.cogcomp.curator.CuratorClient

@AvoidUsing(reason="This is no longer the recommended way of calling Curator",
            alternative="CuratorAnnotatorService")
public class CuratorClient
extends Object

UPDATE: While CuratorClient will still be able to provide TextAnnotations and Views, the canonical way to access the Curator is now through the CuratorAnnotatorService (which creates a AnnotatorService object). A client for using the Curator to get TextAnnotations.

The general use case involves the following:

1. Create a new CuratorClient

    {
        @code
        // Assuming we're starting from raw text
        ResourceManager rm = new CuratorConfigurator().getDefaultConfig();
        CuratorClient curator = new CuratorClient(rm);
    }
    

2. Create a new TextAnnotation

    {
        @code
        TextAnnotation ta = client.getTextAnnotation(text);
    }
    

3. Add views to the TextAnnotation using the required view's name (supported views can be found in ViewNames.

         client.addTextAnnotationView(ta, ViewNames.POS);
    

Author:

Christos Christodoulopoulos, Mark Sammons

Constructor Summary

Constructors

Constructor and Description
CuratorClient(ResourceManager rm) Create a new curator client pointing to the specified host and port.

Method Summary

Modifier and Type	Method and Description
TextAnnotation	getTextAnnotation(String corpusId, String textId, String text) Creates a new TextAnnotation for the specified text belonging to the corpusId with id textId.
View	getTextAnnotationView(TextAnnotation ta, String viewName)

Methods inherited from class java.lang.Object

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

Constructor Detail

CuratorClient

public CuratorClient(ResourceManager rm)

Create a new curator client pointing to the specified host and port. The client that this constructor creates will use the names in ViewNames for the various annotators when calling the curator.

Parameters:

rm - The ResourceManager containing the properties for Curator

Method Detail

getTextAnnotation

public TextAnnotation getTextAnnotation(String corpusId,
                                        String textId,
                                        String text)
                                 throws edu.illinois.cs.cogcomp.thrift.base.ServiceUnavailableException,
                                        edu.illinois.cs.cogcomp.thrift.base.AnnotationFailedException,
                                        org.apache.thrift.TException,
                                        SocketException

Creates a new TextAnnotation for the specified text belonging to the corpusId with id textId. This method calls the Curator to get the tokenization and the sentences unless the CuratorClient's respectTokenization field is set to true, in which case it generates sentence and label views based on newlines and whitespace characters. (NB: tabs will be treated as tokens!) Consecutive whitespace characters will not generate empty tokens, but the token offsets and sentence offsets will count all whitespace characters.

Note: The Record returned by this method will not have any views except the Sentence and Token view. To get other views from the Curator, call the appropriate CuratorClient functions (e.g TODO).

Parameters:

corpusId - Identifier for the corpus

textId - Identifier for the text

text - The raw text

Returns:

A TextAnnotation with ViewNames.TOKENS and ViewNames.SENTENCE views.

Throws:

edu.illinois.cs.cogcomp.thrift.base.ServiceUnavailableException

edu.illinois.cs.cogcomp.thrift.base.AnnotationFailedException

org.apache.thrift.TException

SocketException

getTextAnnotationView

public View getTextAnnotationView(TextAnnotation ta,
                                  String viewName)
                           throws org.apache.thrift.TException,
                                  edu.illinois.cs.cogcomp.thrift.base.AnnotationFailedException,
                                  edu.illinois.cs.cogcomp.thrift.base.ServiceUnavailableException,
                                  SocketException

Throws:

org.apache.thrift.TException

edu.illinois.cs.cogcomp.thrift.base.AnnotationFailedException

edu.illinois.cs.cogcomp.thrift.base.ServiceUnavailableException

SocketException