org.opennms.netmgt.config.monitoringLocations
Class LocationDef

java.lang.Object
  org.opennms.netmgt.config.monitoringLocations.LocationDef

All Implemented Interfaces:

Serializable

public class LocationDef
extends Object
implements Serializable

This element contains the name of the location, the name of the monitoring area (used to aggregate locations, example: Area San Francisco, location name "SFO" which becomes SFO-1 or SFO-BuildingA, etc.) Critical link here is that the polling package name is used to link a polling configuration found in the polling-configuration.xml file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

LocationDef()

Method Summary

String	getLocationName() Returns the value of field 'locationName'.
String	getMonitoringArea() Returns the value of field 'monitoringArea'.
String	getPollingPackageName() Returns the value of field 'pollingPackageName'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setLocationName(String locationName) Sets the value of field 'locationName'.
void	setMonitoringArea(String monitoringArea) Sets the value of field 'monitoringArea'.
void	setPollingPackageName(String pollingPackageName) Sets the value of field 'pollingPackageName'.
static LocationDef	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationDef

public LocationDef()

Method Detail

getLocationName

public String getLocationName()

Returns the value of field 'locationName'.

Returns:

the value of field 'LocationName'.

getMonitoringArea

public String getMonitoringArea()

Returns the value of field 'monitoringArea'.

Returns:

the value of field 'MonitoringArea'.

getPollingPackageName

public String getPollingPackageName()

Returns the value of field 'pollingPackageName'.

Returns:

the value of field 'PollingPackageName'.

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

setLocationName

public void setLocationName(String locationName)

Sets the value of field 'locationName'.

Parameters:

locationName - the value of field 'locationName'.

setMonitoringArea

public void setMonitoringArea(String monitoringArea)

Sets the value of field 'monitoringArea'.

Parameters:

monitoringArea - the value of field 'monitoringArea'.

setPollingPackageName

public void setPollingPackageName(String pollingPackageName)

Sets the value of field 'pollingPackageName'.

Parameters:

pollingPackageName - the value of field 'pollingPackageName'.

unmarshal

public static LocationDef 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.monitoringLocations.LocationDef

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