Class CPMUtils


  • public class CPMUtils
    extends java.lang.Object
    • Constructor Summary

      Constructors 
      Constructor Description
      CPMUtils()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String convertToAbsolutePath​(java.lang.String aSystemVar, java.lang.String aExpr, java.lang.String aPathToConvert)  
      static void dumpEvents​(ProcessTrace aPTr)
      Dumps all events in the process trace object
      static long extractTime​(ProcessTrace aPT, java.lang.String eventName)
      Returns the total duration of a given event
      static java.io.File findDeployDirectory​(java.lang.String aServiceName)  
      static ChunkMetadata getChunkMetadata​(CAS aCas)
      Extract metadata associated with chunk from a given CAS.
      static int getFeatureAsInt​(CAS aCas, Feature aFeature, java.lang.String aName)  
      static java.lang.String getFeatureAsString​(CAS aCas, Feature aFeature, java.lang.String aName)
      Returns a value associated with a given feature
      static java.lang.String[] getKeys2Drop​(java.lang.String aKeyDropMapFile)
      Currently, this returns initialized array of Strings.
      static UimaTimer getTimer()  
      static UimaTimer getTimer​(java.lang.String aTimerClass)
      Return timer to measure performace of the cpm.
      static java.lang.String scrubThePath​(java.lang.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​(UimaTimer aTimer)  
      • 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 java.lang.String CPM_LOG_RESOURCE_BUNDLE
        See Also:
        Constant Field Values
    • Constructor Detail

      • CPMUtils

        public CPMUtils()
    • Method Detail

      • getKeys2Drop

        public static java.lang.String[] getKeys2Drop​(java.lang.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)
        Parameters:
        aTimer -
      • getTimer

        public static UimaTimer getTimer()
        Returns:
        the timer
      • convertToAbsolutePath

        public static java.lang.String convertToAbsolutePath​(java.lang.String aSystemVar,
                                                             java.lang.String aExpr,
                                                             java.lang.String aPathToConvert)
        Parameters:
        aSystemVar -
        aExpr -
        aPathToConvert -
        Returns:
        absolute path
      • getTimer

        public static UimaTimer getTimer​(java.lang.String aTimerClass)
                                  throws java.lang.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.
        Returns:
        - customer timer or JavaTimer (default)
        Throws:
        java.lang.Exception - -
      • extractTime

        public static long extractTime​(ProcessTrace aPT,
                                       java.lang.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 java.lang.String scrubThePath​(java.lang.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.
      • findDeployDirectory

        public static java.io.File findDeployDirectory​(java.lang.String aServiceName)
                                                throws java.lang.Exception
        Parameters:
        aServiceName -
        Returns:
        the deploy directory
        Throws:
        java.lang.Exception - -
      • getFeatureAsInt

        public static int getFeatureAsInt​(CAS aCas,
                                          Feature aFeature,
                                          java.lang.String aName)
                                   throws java.lang.Exception
        Throws:
        java.lang.Exception
      • getFeatureAsString

        public static java.lang.String getFeatureAsString​(CAS aCas,
                                                          Feature aFeature,
                                                          java.lang.String aName)
                                                   throws java.lang.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:
        java.lang.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