Package org.opennms.netmgt.xml.event

Class Correlation

  • All Implemented Interfaces:
    java.io.Serializable
    public class Correlation
extends java.lang.Object
implements java.io.Serializable
    The event correlation information
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Correlation()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addCuei​(int index, java.lang.String vCuei)  
      void addCuei​(java.lang.String vCuei)  
      static Correlation copyFrom​(ICorrelation source)  
      java.util.Enumeration<java.lang.String> enumerateCuei()
      Method enumerateCuei.
      java.lang.String getCmax()
      Returns the value of field 'cmax'.
      java.lang.String getCmin()
      Returns the value of field 'cmin'.
      java.lang.String getCtime()
      Returns the value of field 'ctime'.
      java.lang.String[] getCuei()
      Method getCuei.Returns the contents of the collection in an Array.
      java.lang.String getCuei​(int index)
      Method getCuei.
      java.util.List<java.lang.String> getCueiCollection()
      Method getCueiCollection.Returns a reference to '_cueiList'.
      int getCueiCount()
      Method getCueiCount.
      java.lang.String getPath()
      Returns the value of field 'path'.
      java.lang.String getState()
      Returns the value of field 'state'.
      java.util.Iterator<java.lang.String> iterateCuei()
      Method iterateCuei.
      void removeAllCuei()  
      boolean removeCuei​(java.lang.String vCuei)
      Method removeCuei.
      java.lang.String removeCueiAt​(int index)
      Method removeCueiAt.
      void setCmax​(java.lang.String cmax)
      Sets the value of field 'cmax'.
      void setCmin​(java.lang.String cmin)
      Sets the value of field 'cmin'.
      void setCtime​(java.lang.String ctime)
      Sets the value of field 'ctime'.
      void setCuei​(int index, java.lang.String vCuei)  
      void setCuei​(java.lang.String[] vCueiArray)  
      void setCuei​(java.util.List<java.lang.String> vCueiList)
      Sets the value of '_cueiList' by copying the given Vector.
      void setCueiCollection​(java.util.List<java.lang.String> cueiList)
      Deprecated. 
      void setPath​(java.lang.String path)
      Sets the value of field 'path'.
      void setState​(java.lang.String state)
      Sets the value of field 'state'.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Correlation

        public Correlation()

    • Method Detail

      • addCuei

        public void addCuei​(java.lang.String vCuei)
             throws java.lang.IndexOutOfBoundsException
        Parameters:
        vCuei -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • addCuei

        public void addCuei​(int index,
                    java.lang.String vCuei)
             throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vCuei -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • enumerateCuei

        public java.util.Enumeration<java.lang.String> enumerateCuei()
        Method enumerateCuei.
        Returns:
        an Enumeration over all possible elements of this collection

      • getCmax

        public java.lang.String getCmax()
        Returns the value of field 'cmax'. The field 'cmax' has the following description: The maximum count for this event
        Returns:
        the value of field 'Cmax'.

      • getCmin

        public java.lang.String getCmin()
        Returns the value of field 'cmin'. The field 'cmin' has the following description: The minimum count for this event
        Returns:
        the value of field 'Cmin'.

      • getCtime

        public java.lang.String getCtime()
        Returns the value of field 'ctime'. The field 'ctime' has the following description: The correlation time for this event
        Returns:
        the value of field 'Ctime'.

      • getCuei

        public java.lang.String getCuei​(int index)
                         throws java.lang.IndexOutOfBoundsException
        Method getCuei.
        Parameters:
        index -
        Returns:
        the value of the java.lang.String at the given index
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • getCuei

        public java.lang.String[] getCuei()
        Method getCuei.Returns the contents of the collection in an Array.

        Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

        Returns:
        this collection as an Array

      • getCueiCollection

        public java.util.List<java.lang.String> getCueiCollection()
        Method getCueiCollection.Returns a reference to '_cueiList'. No type checking is performed on any modifications to the Vector.
        Returns:
        a reference to the Vector backing this class

      • getCueiCount

        public int getCueiCount()
        Method getCueiCount.
        Returns:
        the size of this collection

      • getPath

        public java.lang.String getPath()
        Returns the value of field 'path'.
        Returns:
        the value of field 'Path'.

      • getState

        public java.lang.String getState()
        Returns the value of field 'state'. The field 'state' has the following description: The state determines if event is correlated
        Returns:
        the value of field 'State'.

      • iterateCuei

        public java.util.Iterator<java.lang.String> iterateCuei()
        Method iterateCuei.
        Returns:
        an Iterator over all possible elements in this collection

      • removeAllCuei

        public void removeAllCuei()

      • removeCuei

        public boolean removeCuei​(java.lang.String vCuei)
        Method removeCuei.
        Parameters:
        vCuei -
        Returns:
        true if the object was removed from the collection.

      • removeCueiAt

        public java.lang.String removeCueiAt​(int index)
        Method removeCueiAt.
        Parameters:
        index -
        Returns:
        the element removed from the collection

      • setCmax

        public void setCmax​(java.lang.String cmax)
        Sets the value of field 'cmax'. The field 'cmax' has the following description: The maximum count for this event
        Parameters:
        cmax - the value of field 'cmax'.

      • setCmin

        public void setCmin​(java.lang.String cmin)
        Sets the value of field 'cmin'. The field 'cmin' has the following description: The minimum count for this event
        Parameters:
        cmin - the value of field 'cmin'.

      • setCtime

        public void setCtime​(java.lang.String ctime)
        Sets the value of field 'ctime'. The field 'ctime' has the following description: The correlation time for this event
        Parameters:
        ctime - the value of field 'ctime'.

      • setCuei

        public void setCuei​(int index,
                    java.lang.String vCuei)
             throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vCuei -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • setCuei

        public void setCuei​(java.lang.String[] vCueiArray)
        Parameters:
        vCueiArray -

      • setCuei

        public void setCuei​(java.util.List<java.lang.String> vCueiList)
        Sets the value of '_cueiList' by copying the given Vector. All elements will be checked for type safety.
        Parameters:
        vCueiList - the Vector to copy.

      • setCueiCollection

        public void setCueiCollection​(java.util.List<java.lang.String> cueiList)
        Deprecated.
        Sets the value of '_cueiList' by setting it to the given Vector. No type checking is performed.
        Parameters:
        cueiList - the Vector to set.

      • setPath

        public void setPath​(java.lang.String path)
        Sets the value of field 'path'.
        Parameters:
        path - the value of field 'path'.

      • setState

        public void setState​(java.lang.String state)
        Sets the value of field 'state'. The field 'state' has the following description: The state determines if event is correlated
        Parameters:
        state - the value of field 'state'.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object