org.apache.uima.collection.impl.cpm.vinci

Class Vinci

java.lang.Object

org.apache.uima.collection.impl.cpm.vinci.Vinci

public class Vinci
extends Object

The Class Vinci.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Vinci.AFFactory A factory for creating AF objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VNS_HOST The Constant VNS_HOST.
static String	VNS_PORT The Constant VNS_PORT.

Constructor Summary

Constructors

Constructor and Description
Vinci()

Method Summary

Modifier and Type	Method and Description
static String	extractKEYSAsString(org.apache.vinci.transport.document.AFrame frame) Extract KEYS as string.
static String	getContentFromDATACas(org.apache.uima.cas_data.CasData aCas) Gets the content from DATA cas.
static String	getFeatureValueByType(org.apache.uima.cas_data.CasData aCAS, String featureName) Gets the feature value by type.
static org.apache.vinci.transport.document.AFrame	produceAFrame(String cmd, String content) Produce A frame.
static org.apache.vinci.transport.document.AFrame	replyWithAnalysis(org.apache.vinci.transport.BaseClient conn, org.apache.vinci.transport.VinciFrame requestFrame) Package the VinciFrame containing result of the requested operation into a Vinci Data frame.
static org.apache.vinci.transport.document.AFrame	replyWithAnalysis(org.apache.vinci.transport.VinciClient conn, org.apache.vinci.transport.VinciFrame requestFrame) Package the VinciFrame containing result of the requested operation into a Vinci Data frame.
org.apache.vinci.transport.VinciFrame	replyWithError(String errorMsg) Creates and populates an error frame.
static String	stripVinciFrame(org.apache.vinci.transport.VinciFrame aFrame) Returns a content from a given VinciFrame.

Methods inherited from class java.lang.Object

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

Field Detail

VNS_HOST

public static final String VNS_HOST

The Constant VNS_HOST.

See Also:

Constant Field Values

VNS_PORT

public static final String VNS_PORT

The Constant VNS_PORT.

See Also:

Constant Field Values

Constructor Detail

Vinci

public Vinci()

Method Detail

replyWithError

public org.apache.vinci.transport.VinciFrame replyWithError(String errorMsg)

Creates and populates an error frame.

Parameters:

errorMsg - - error message to place in the error frame

Returns:

VinciFrame instance containing error

replyWithAnalysis

public static org.apache.vinci.transport.document.AFrame replyWithAnalysis(org.apache.vinci.transport.BaseClient conn,
                                                                           org.apache.vinci.transport.VinciFrame requestFrame)
                                                                    throws Exception

Package the VinciFrame containing result of the requested operation into a Vinci Data frame.

Parameters:

conn - the connection

requestFrame - VinciFrame containing result of thsi service operation

Returns:

VinciFrame VinciData frame.

Throws:

Exception - -

replyWithAnalysis

public static org.apache.vinci.transport.document.AFrame replyWithAnalysis(org.apache.vinci.transport.VinciClient conn,
                                                                           org.apache.vinci.transport.VinciFrame requestFrame)
                                                                    throws Exception

Package the VinciFrame containing result of the requested operation into a Vinci Data frame.

Parameters:

conn - the connection

requestFrame - VinciFrame containing result of thsi service operation

Returns:

VinciFrame VinciData frame.

Throws:

Exception - the exception

produceAFrame

public static org.apache.vinci.transport.document.AFrame produceAFrame(String cmd,
                                                                       String content)

Produce A frame.

Parameters:

cmd - the cmd

content - the content

Returns:

the a frame

extractKEYSAsString

public static String extractKEYSAsString(org.apache.vinci.transport.document.AFrame frame)

Extract KEYS as string.

Parameters:

frame - the frame

Returns:

the string

getFeatureValueByType

public static String getFeatureValueByType(org.apache.uima.cas_data.CasData aCAS,
                                           String featureName)

Gets the feature value by type.

Parameters:

aCAS - the a CAS

featureName - the feature name

Returns:

the feature value by type

getContentFromDATACas

public static String getContentFromDATACas(org.apache.uima.cas_data.CasData aCas)

Gets the content from DATA cas.

Parameters:

aCas - the a cas

Returns:

the content from DATA cas

stripVinciFrame

public static String stripVinciFrame(org.apache.vinci.transport.VinciFrame aFrame)

Returns a content from a given VinciFrame.

Parameters:

aFrame - the a frame

Returns:

the string