org.opennms.netmgt.xml.event
Class Correlation

java.lang.Object
  org.opennms.netmgt.xml.event.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

Correlation()

Method Summary

void	addCuei(int index, java.lang.String vCuei) Method addCuei
void	addCuei(java.lang.String vCuei) Method addCuei
void	clearCuei() Method clearCuei
java.util.Enumeration	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
java.lang.String	getCuei(int index) Method getCuei
java.util.ArrayList	getCueiCollection() Method getCueiCollection Returns a reference to 'cuei'.
int	getCueiCount() Method getCueiCount
java.lang.String	getPath() Returns the value of field 'path'.
java.lang.String	getState() Returns the value of field 'state'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
boolean	removeCuei(java.lang.String vCuei) Method removeCuei
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(java.util.ArrayList cueiCollection) Method setCuei Sets the value of 'cuei' by copying the given ArrayList.
void	setCuei(int index, java.lang.String vCuei) Method setCuei
void	setCuei(java.lang.String[] cueiArray) Method setCuei
void	setCueiCollection(java.util.ArrayList cueiCollection) Method setCueiCollection Sets the value of 'cuei' by setting it to the given ArrayList.
void	setPath(java.lang.String path) Sets the value of field 'path'.
void	setState(java.lang.String state) Sets the value of field 'state'.
static java.lang.Object	unmarshal(java.io.Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Correlation

public Correlation()

Method Detail

addCuei

public void addCuei(java.lang.String vCuei)
             throws java.lang.IndexOutOfBoundsException

Method addCuei

Parameters:

vCuei -

Throws:

java.lang.IndexOutOfBoundsException

addCuei

public void addCuei(int index,
                    java.lang.String vCuei)
             throws java.lang.IndexOutOfBoundsException

Method addCuei

Parameters:

index -

vCuei -

Throws:

java.lang.IndexOutOfBoundsException

clearCuei

public void clearCuei()

Method clearCuei

enumerateCuei

public java.util.Enumeration enumerateCuei()

Method enumerateCuei

Returns:

Enumeration

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:

String

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:

String

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:

String

getCuei

public java.lang.String getCuei(int index)
                         throws java.lang.IndexOutOfBoundsException

Method getCuei

Parameters:

index -

Returns:

String

Throws:

java.lang.IndexOutOfBoundsException

getCuei

public java.lang.String[] getCuei()

Method getCuei

Returns:

String

getCueiCollection

public java.util.ArrayList getCueiCollection()

Method getCueiCollection Returns a reference to 'cuei'. No type checking is performed on any modications to the Collection.

Returns:

ArrayList

getCueiCount

public int getCueiCount()

Method getCueiCount

Returns:

int

getPath

public java.lang.String getPath()

Returns the value of field 'path'.

Returns:

String

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:

String

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeCuei

public boolean removeCuei(java.lang.String vCuei)

Method removeCuei

Parameters:

vCuei -

Returns:

boolean

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

Method setCuei

Parameters:

index -

vCuei -

Throws:

java.lang.IndexOutOfBoundsException

setCuei

public void setCuei(java.lang.String[] cueiArray)

Method setCuei

Parameters:

cueiArray -

setCuei

public void setCuei(java.util.ArrayList cueiCollection)

Method setCuei Sets the value of 'cuei' by copying the given ArrayList.

Parameters:

cueiCollection - the Vector to copy.

setCueiCollection

public void setCueiCollection(java.util.ArrayList cueiCollection)

Method setCueiCollection Sets the value of 'cuei' by setting it to the given ArrayList. No type checking is performed.

Parameters:

cueiCollection - the ArrayList to copy.

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'.

unmarshal

public static java.lang.Object unmarshal(java.io.Reader reader)
                                  throws org.exolab.castor.xml.MarshalException,
                                         org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

Returns:

Object

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException