Class CPMUtils

java.lang.Object
org.apache.uima.collection.impl.cpm.utils.CPMUtils
public class CPMUtils extends Object
The Class CPMUtils.

  • Field Details

    • CPM_LOG_RESOURCE_BUNDLE

      public static final String CPM_LOG_RESOURCE_BUNDLE
      The Constant CPM_LOG_RESOURCE_BUNDLE.
      See Also:

    • timer

      private static UimaTimer timer
      The timer.

  • Constructor Details

    • CPMUtils

      public CPMUtils()

  • Method Details

    • getKeys2Drop

      public static String[] getKeys2Drop(String aKeyDropMapFile) throws 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:
      ResourceConfigurationException - -

    • setTimer

      public static void setTimer(UimaTimer aTimer)
      Sets the timer.
      Parameters:
      aTimer - the new timer

    • getTimer

      public static 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 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(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(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

    • extractText

      private static String extractText(Node aNode) throws Exception
      Finds a node with a given path and returns its textual value.
      Parameters:
      aNode - the a node
      Returns:
      textual value of a node indicated in the XPath path
      Throws:
      Exception - the exception

    • getConfigurableFeature

      private static ConfigurableFeature getConfigurableFeature(Node entityNode) throws ConfigurationException
      Gets the configurable feature.
      Parameters:
      entityNode - the entity node
      Returns:
      a configurable feature
      Throws:
      ConfigurationException - -

    • getTextValue

      private static String getTextValue(NodeList aList)
      Returns text associated with TEXT_NODE element.
      Parameters:
      aList - - list of elements
      Returns:
      - Text

    • getFeatures

      private static ArrayList getFeatures(Node attributesNode) throws ConfigurationException
      Gets the features.
      Parameters:
      attributesNode - the attributes node
      Returns:
      a list of features
      Throws:
      ConfigurationException - -

    • findDeployDirectory

      public static File findDeployDirectory(String aServiceName) throws Exception
      Find deploy directory.
      Parameters:
      aServiceName - the a service name
      Returns:
      the deploy directory
      Throws:
      Exception - -

    • getDirectories

      private static File[] getDirectories() throws Exception
      Gets the directories.
      Returns:
      an array of directories
      Throws:
      Exception - -

    • getFeatureAsInt

      public static int getFeatureAsInt(CAS aCas, 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(CAS aCas, 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(CAS aCas)
      Extract metadata associated with chunk from a given CAS.
      Parameters:
      aCas - - Cas to extract chunk metadata from
      Returns:
      - chunk metadata