Package org.apache.uima.collection.metadata

Interface CpeCasProcessor

    • Method Detail

      • getName

        java.lang.String getName()
        Returns CasProcessor's name
        Returns:
        - name

      • getSOFA

        java.lang.String getSOFA()

      • setDescriptor

        @Deprecated
void setDescriptor​(java.lang.String aDescriptor)
            throws CpeDescriptorException
        Deprecated.
        Doesn't support the new import syntax. Use setCpeComponentDescriptor() instead.
        Sets CasProcessor descriptor path.
        Parameters:
        aDescriptor - - descriptor path
        Throws:
        CpeDescriptorException - tbd

      • getDescriptor

        @Deprecated
java.lang.String getDescriptor()
        Deprecated.
        Doesn't support the new import syntax. Use getCpeComponentDescriptor().findAbsoluteUrl() instead.
        Returns CasProcessor descriptor.
        Returns:
        descriptor

      • getDeployment

        java.lang.String getDeployment()
        Returns CasProcessor deployment type. Three types are currently supported:
        • integrated
        • remote
        • local
        Returns:
        - deployment mode

      • setCasProcessorFilter

        void setCasProcessorFilter​(java.lang.String aFilterExpression)
                    throws CpeDescriptorException
        Sets CasProcessor filter expression used by the CPE to route CASs. A CasProcessor can be configured in the CPE Descriptor to use filtering using an SQL-like WHERE clause: where featurespec [ and featurespec2 ...]. The featurespec can be one of these four forms and meanings:
        • Feature Process CAS if the Feature is present (e.g. where Person)
        • Feature! Process CAS if the Feature is not present (e.g. where Person!)
        • Feature=value Process CAS if the Feature has this value( e.g. where Person=Bush)
        • Feature!=value Process CAS if the Feature does not have this value (e.g. where Person!=Bush)
        The featurespecs are implicitly connected with and operators and precedence rules are currently not supported.
        Parameters:
        aFilterExpression - - filter
        Throws:
        CpeDescriptorException - tbd

      • getCasProcessorFilter

        java.lang.String getCasProcessorFilter()
        Returns CasProcessor filter expression. A CasProcessor can be configured in the CPE Descriptor to use filtering using an SQL-like WHERE clause: where featurespec [ and featurespec2 ...]. The featurespec can be one of these four forms and meanings:
        • Feature Process CAS if the Feature is present (e.g. where Person)
        • Feature! Process CAS if the Feature is not present (e.g. where Person!)
        • Feature=value Process CAS if the Feature has this value( e.g. where Person=Bush)
        • Feature!=value Process CAS if the Feature does not have this value (e.g. where Person!=Bush)
        The featurespecs are implicitly connected with and operators and precedence rules are currently not supported.
        Returns:
        - filter expression

      • setBatchSize

        void setBatchSize​(int aBatchSize)
        Sets CasProcessor's batch size.
        Parameters:
        aBatchSize - - size of CasProcessor batch

      • getBatchSize

        int getBatchSize()
        Returns CasProcessor batch size
        Returns:
        - batch size

      • setMaxErrorCount

        void setMaxErrorCount​(int aErrorCount)
        Sets the max number of errors tolerated by the CPE. If the the threshold is exceeded the CPE will take an action based on defined strategy. Max Error is defined in terms of a quotient, like 3/1000. Where 3 is the actual max error tolerance and 1000 is a sample size. So the above is interpreted as 3 errors per thousand entities processed.
        Parameters:
        aErrorCount - - max error threshold

      • getMaxErrorCount

        int getMaxErrorCount()
        Returns the max number of errors tolerated by the CPE. If the the threshold is exceeded the CPE will take an action based on defined strategy. Max Error is defined in terms of a quotient, like 3/1000. Where 3 is the actual max error tolerance and 1000 is a sample size. So the above is interpreted as 3 errors per thousand entities processed.
        Returns:
        - max error threshold

      • setMaxErrorSampleSize

        void setMaxErrorSampleSize​(int aErrorSampleSize)
        Sets the sample size. Max Error is defined in terms of a quotient, like 3/1000. Where 3 is the actual max error tolerance and 1000 is a sample size. So the above is interpreted as 3 errors per thousand entities processed.
        Parameters:
        aErrorSampleSize - the sample size

      • getMaxErrorSampleSize

        int getMaxErrorSampleSize()
        Returns sample size. Max Error is defined in terms of a quotient, like 3/1000. Where 3 is the actual max error tolerance and 1000 is a sample size. So the above is interpreted as 3 errors per thousand entities processed.
        Returns:
        - sample size

      • setActionOnMaxError

        void setActionOnMaxError​(java.lang.String aAction)
        Sets a strategy for dealing with exceeding error thresholds. The three supported strategies are:
        • terminate - termines the CPE
        • continue - continue despite the error
        • disable - disable CasProcessor
        Parameters:
        aAction - - action to take

      • getActionOnMaxError

        java.lang.String getActionOnMaxError()
        Returns strategy for dealing with exceeding error thresholds. The three supported strategies are:
        • terminate - termines the CPE
        • continue - continue despite the error
        • disable - disable CasProcessor
        Returns:
        - action to take

      • setMaxRestartCount

        void setMaxRestartCount​(int aErrorCount)
        Sets max tolerated restarts threshold for CasProcessor
        Parameters:
        aErrorCount - - max restart count

      • getMaxRestartCount

        int getMaxRestartCount()
        Returns max restarts threshold fro CasProcessor
        Returns:
        - max restart count

      • setActionOnMaxRestart

        void setActionOnMaxRestart​(java.lang.String aAction)
        Sets strategy for dealing with exceeding error thresholds. The three supported strategies are:
        • terminate - termines the CPE
        • continue - continue despite the error
        • disable - disable CasProcessor
        Parameters:
        aAction - - action to take

      • getActionOnMaxRestart

        java.lang.String getActionOnMaxRestart()
        Returns strategy for dealing with exceeding error thresholds. The three supported strategies are:
        • terminate - termines the CPE
        • continue - continue despite the error
        • disable - disable CasProcessor
        Returns:
        the action to take when the error threshold is exceeded

      • setTimeout

        void setTimeout​(int aTimeoutValue)
        Sets the timeout value. The amount of time the CPE will wait for response from CasProcessor
        Parameters:
        aTimeoutValue - - timeout value

      • getTimeout

        int getTimeout()
        Returns the timeout value. The amount of time the CPE will wait for response from CasProcessor
        Returns:
        - timeout value

      • addDeployParam

        void addDeployParam​(java.lang.String aParamName,
                    java.lang.String aParamValue)
             throws CpeDescriptorException
        Adds deployment parameter used by the CPE when launching CasProcessor
        Parameters:
        aParamName - - param name
        aParamValue - - param value
        Throws:
        CpeDescriptorException - tbd

      • setSofaNameMappings

        void setSofaNameMappings​(CpeSofaMappings mappings)
        Parameters:
        mappings - -

      • setIsParallelizable

        void setIsParallelizable​(boolean isP)

      • getIsParallelizable

        boolean getIsParallelizable()