org.apache.uima.collection.impl.cpm.utils

Class CPMUtils

java.lang.Object

org.apache.uima.collection.impl.cpm.utils.CPMUtils

public class CPMUtils
extends Object

The Class CPMUtils.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CPM_LOG_RESOURCE_BUNDLE The Constant CPM_LOG_RESOURCE_BUNDLE.

Constructor Summary

Constructors

Constructor and Description
CPMUtils()

Method Summary

Modifier and Type	Method and Description
static String	convertToAbsolutePath(String aSystemVar, String aExpr, String aPathToConvert) Convert to absolute path.
static void	dumpEvents(org.apache.uima.util.ProcessTrace aPTr) Dumps all events in the process trace object.
static long	extractTime(org.apache.uima.util.ProcessTrace aPT, String eventName) Returns the total duration of a given event.
static File	findDeployDirectory(String aServiceName) Find deploy directory.
static ChunkMetadata	getChunkMetadata(org.apache.uima.cas.CAS aCas) Extract metadata associated with chunk from a given CAS.
static int	getFeatureAsInt(org.apache.uima.cas.CAS aCas, org.apache.uima.cas.Feature aFeature, String aName) Gets the feature as int.
static String	getFeatureAsString(org.apache.uima.cas.CAS aCas, org.apache.uima.cas.Feature aFeature, String aName) Returns a value associated with a given feature.
static String[]	getKeys2Drop(String aKeyDropMapFile) Currently, this returns initialized array of Strings.
static org.apache.uima.util.UimaTimer	getTimer() Gets the timer.
static org.apache.uima.util.UimaTimer	getTimer(String aTimerClass) Return timer to measure performace of the cpm.
static String	scrubThePath(String value) Finds an occurance of the ##CPM_HOME in a value parameter and returns it with an expanded form (ie.c:/cpm/...) based on the env variable CPM_HOME.
static void	setTimer(org.apache.uima.util.UimaTimer aTimer) Sets the timer.

Methods inherited from class java.lang.Object

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

Field Detail

CPM_LOG_RESOURCE_BUNDLE

public static final String CPM_LOG_RESOURCE_BUNDLE

The Constant CPM_LOG_RESOURCE_BUNDLE.

See Also:

Constant Field Values

Constructor Detail

CPMUtils

public CPMUtils()

Method Detail

getKeys2Drop

public static String[] getKeys2Drop(String aKeyDropMapFile)
                             throws org.apache.uima.resource.ResourceConfigurationException

Currently, this returns initialized array of Strings.

Parameters:

aKeyDropMapFile - - a file containing a list of features that should be removed from CAS being sent to Cas Processor. Currently not used.

Returns:

- Array of empty Strings

Throws:

org.apache.uima.resource.ResourceConfigurationException - -

setTimer

public static void setTimer(org.apache.uima.util.UimaTimer aTimer)

Sets the timer.

Parameters:

aTimer - the new timer

getTimer

public static org.apache.uima.util.UimaTimer getTimer()

Gets the timer.

Returns:

the timer

convertToAbsolutePath

public static String convertToAbsolutePath(String aSystemVar,
                                           String aExpr,
                                           String aPathToConvert)

Convert to absolute path.

Parameters:

aSystemVar - the a system var

aExpr - the a expr

aPathToConvert - the a path to convert

Returns:

absolute path

getTimer

public static org.apache.uima.util.UimaTimer getTimer(String aTimerClass)
                                               throws Exception

Return timer to measure performace of the cpm. The timer can optionally be configured in the CPE descriptor. If none defined, the method returns default timer.

Parameters:

aTimerClass - the a timer class

Returns:

- customer timer or JavaTimer (default)

Throws:

Exception - -

extractTime

public static long extractTime(org.apache.uima.util.ProcessTrace aPT,
                               String eventName)

Returns the total duration of a given event.

Parameters:

aPT - - Event container

eventName - - name of the event for which the time is needed

Returns:

- total duration of an event

dumpEvents

public static void dumpEvents(org.apache.uima.util.ProcessTrace aPTr)

Dumps all events in the process trace object.

Parameters:

aPTr - - event container

scrubThePath

public static String scrubThePath(String value)

Finds an occurance of the ##CPM_HOME in a value parameter and returns it with an expanded form (ie.c:/cpm/...) based on the env variable CPM_HOME.

Parameters:

value - the value

Returns:

the string

findDeployDirectory

public static File findDeployDirectory(String aServiceName)
                                throws Exception

Find deploy directory.

Parameters:

aServiceName - the a service name

Returns:

the deploy directory

Throws:

Exception - -

getFeatureAsInt

public static int getFeatureAsInt(org.apache.uima.cas.CAS aCas,
                                  org.apache.uima.cas.Feature aFeature,
                                  String aName)
                           throws Exception

Gets the feature as int.

Parameters:

aCas - the a cas

aFeature - the a feature

aName - the a name

Returns:

the feature as int

Throws:

Exception - the exception

getFeatureAsString

public static String getFeatureAsString(org.apache.uima.cas.CAS aCas,
                                        org.apache.uima.cas.Feature aFeature,
                                        String aName)
                                 throws Exception

Returns a value associated with a given feature.

Parameters:

aCas - - Cas containing data to extract

aFeature - - feature to locate in the CAS

aName - - name of the feature

Returns:

- value as String

Throws:

Exception - the exception

getChunkMetadata

public static ChunkMetadata getChunkMetadata(org.apache.uima.cas.CAS aCas)

Extract metadata associated with chunk from a given CAS.

Parameters:

aCas - - Cas to extract chunk metadata from

Returns:

- chunk metadata