org.opennms.netmgt.config.translator
Class EventTranslationSpec

java.lang.Object
  org.opennms.netmgt.config.translator.EventTranslationSpec

All Implemented Interfaces:

Serializable

public class EventTranslationSpec
extends Object
implements Serializable

This defines the allowable translations for a given event uei

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

EventTranslationSpec()

Method Summary

boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Mappings	getMappings() Returns the value of field 'mappings'.
String	getUei() Returns the value of field 'uei'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setMappings(Mappings mappings) Sets the value of field 'mappings'.
void	setUei(String uei) Sets the value of field 'uei'.
static EventTranslationSpec	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventTranslationSpec

public EventTranslationSpec()

Method Detail

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getMappings

public Mappings getMappings()

Returns the value of field 'mappings'. The field 'mappings' has the following description: The list of event mappings for this event. The first mapping that matches the event is used to translate the event into a new event.

Returns:

the value of field 'Mappings'.

getUei

public String getUei()

Returns the value of field 'uei'.

Returns:

the value of field 'Uei'.

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

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

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

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

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setMappings

public void setMappings(Mappings mappings)

Sets the value of field 'mappings'. The field 'mappings' has the following description: The list of event mappings for this event. The first mapping that matches the event is used to translate the event into a new event.

Parameters:

mappings - the value of field 'mappings'.

setUei

public void setUei(String uei)

Sets the value of field 'uei'.

Parameters:

uei - the value of field 'uei'.

unmarshal

public static EventTranslationSpec unmarshal(Reader reader)
                                      throws org.exolab.castor.xml.MarshalException,
                                             org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.translator.EventTranslationSpec

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

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

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema