Package org.apache.uima.collection.impl.metadata.cpe

Class CpeConfigurationImpl

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        The Constant serialVersionUID.
        See Also:
        Constant Field Values

      • startAt

        private java.lang.String startAt
        The start at.

      • num2Process

        private long num2Process
        The num 2 process.

      • timerImpl

        private java.lang.String timerImpl
        The timer impl.

      • deployAs

        private java.lang.String deployAs
        The deploy as.

      • outputQueue

        private OutputQueue outputQueue
        The output queue.

      • XMLIZATION_INFO

        private static final XmlizationInfo XMLIZATION_INFO
        The Constant XMLIZATION_INFO.

    • Constructor Detail

      • CpeConfigurationImpl

        public CpeConfigurationImpl()
        Instantiates a new cpe configuration impl.

    • Method Detail

      • setDeployment

        public void setDeployment​(java.lang.String aDeploy)
                   throws CpeDescriptorException
        Description copied from interface: CpeConfiguration
        Sets CPE deployment mode as "immediate", "vinceService", "interactive". The CPE does not directly use this information, instead it is up to the application using the CPE to ingest this and handle it as appropriate. This element is used by an application that uses the CPE. The CPE is an embeddable component, part of a larger application.
        • "immediate" mode: this is the way the CPE is typically run. In this mode the application is initializing the CPE and starts in without user interaction. The CPE runs to completion in this case.
        • "interactive" mode: The application interacts with the CPE via an API to stop, pause, or resume the CPE.
        • "vinciService" mode: used to indicate control of CPE in terms of stop, pause, resume, and query for performance info, from a remote console.
        Specified by:
        setDeployment in interface CpeConfiguration
        Parameters:
        aDeploy - - deployment mode of the CPE
        Throws:
        CpeDescriptorException - tbd

      • getNumToProcess

        public int getNumToProcess()
        Description copied from interface: CpeConfiguration
        Returns number of entities to process
        Specified by:
        getNumToProcess in interface CpeConfiguration
        Returns:
        - number of entities to process (-1 - for ALL)

      • setStartingEntityId

        public void setStartingEntityId​(java.lang.String aStartAt)
        Description copied from interface: CpeConfiguration
        Sets id of the first entity the CPE will beging processing. Usefull when starting the CPE from a known point.
        Specified by:
        setStartingEntityId in interface CpeConfiguration
        Parameters:
        aStartAt - - id of first entity

      • getStartingEntityId

        public java.lang.String getStartingEntityId()
        Description copied from interface: CpeConfiguration
        Returns id of the first entity the CPE will beging processing. Usefull when starting the CPE from a known point.
        Specified by:
        getStartingEntityId in interface CpeConfiguration
        Returns:
        - id of first entity

      • setCpeTimer

        public void setCpeTimer​(CpeTimer aTimer)
        Description copied from interface: CpeConfiguration
        Sets the timer class implementing UimeTimer interface. This timer will be used to time CPE events. By default, the CPE uses System.currentTimeMillis() to obtain time.
        Specified by:
        setCpeTimer in interface CpeConfiguration
        Parameters:
        aTimer - - timer class

      • getCpeTimer

        public CpeTimer getCpeTimer()
        Description copied from interface: CpeConfiguration
        Returns the timer class implementing UimeTimer interface. This timer will be used to time CPE events. By default, the CPE uses System.currentTimeMillis() to obtain time.
        Specified by:
        getCpeTimer in interface CpeConfiguration
        Returns:
        - timer class

      • getDeployAs

        public java.lang.String getDeployAs()
        Gets the deploy as.
        Returns:
        the deploy as

      • getNum2Process

        public long getNum2Process()
        Gets the num 2 process.
        Returns:
        the num 2 process

      • getStartAt

        public java.lang.String getStartAt()
        Gets the start at.
        Returns:
        the start at

      • setDeployAs

        public void setDeployAs​(java.lang.String string)
        Sets the deploy as.
        Parameters:
        string - the new deploy as

      • setNumToProcess

        public void setNumToProcess​(long l)
        Sets the num to process.
        Parameters:
        l - the new num to process

      • setStartAt

        public void setStartAt​(java.lang.String aStartAt)
        Sets the start at.
        Parameters:
        aStartAt - the new start at

      • setTimerImpl

        public void setTimerImpl​(java.lang.String string)
        Sets the timer impl.
        Parameters:
        string - the new timer impl

      • setOutputQueue

        public void setOutputQueue​(OutputQueue queue)
        Sets the output queue.
        Parameters:
        queue - the new output queue

      • getXmlizationInfo

        protected XmlizationInfo getXmlizationInfo()
        Description copied from class: MetaDataObject_impl
        To be implemented by subclasses to return information describing how to represent this object in XML.
        Specified by:
        getXmlizationInfo in class MetaDataObject_impl
        Returns:
        information defining this object's XML representation