org.opennms.netmgt.config.rrd
Class Graph

java.lang.Object
  org.opennms.netmgt.config.rrd.Graph

All Implemented Interfaces:

Serializable

public class Graph
extends Object
implements Serializable

Class Graph.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Graph()

Method Summary

void	addGraph_element(Graph_element vGraph_element)
void	addGraph_element(int index, Graph_element vGraph_element)
Enumeration<Graph_element>	enumerateGraph_element() Method enumerateGraph_element.
Graph_element[]	getGraph_element() Method getGraph_element.Returns the contents of the collection in an Array.
Graph_element	getGraph_element(int index) Method getGraph_element.
List<Graph_element>	getGraph_elementCollection() Method getGraph_elementCollection.Returns a reference to '_graph_elementList'.
int	getGraph_elementCount() Method getGraph_elementCount.
boolean	isValid() Method isValid.
Iterator<Graph_element>	iterateGraph_element() Method iterateGraph_element.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllGraph_element()
boolean	removeGraph_element(Graph_element vGraph_element) Method removeGraph_element.
Graph_element	removeGraph_elementAt(int index) Method removeGraph_elementAt.
void	setGraph_element(Graph_element[] vGraph_elementArray)
void	setGraph_element(int index, Graph_element vGraph_element)
void	setGraph_element(List<Graph_element> vGraph_elementList) Sets the value of '_graph_elementList' by copying the given Vector.
void	setGraph_elementCollection(List<Graph_element> graph_elementList) Deprecated.
static Graph	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

Graph

public Graph()

Method Detail

addGraph_element

public void addGraph_element(Graph_element vGraph_element)
                      throws IndexOutOfBoundsException

Parameters:

vGraph_element -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addGraph_element

public void addGraph_element(int index,
                             Graph_element vGraph_element)
                      throws IndexOutOfBoundsException

Parameters:

index -

vGraph_element -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateGraph_element

public Enumeration<Graph_element> enumerateGraph_element()

Method enumerateGraph_element.

Returns:

an Enumeration over all possible elements of this collection

getGraph_element

public Graph_element getGraph_element(int index)
                               throws IndexOutOfBoundsException

Method getGraph_element.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.rrd.Graph_element at the given inde

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getGraph_element

public Graph_element[] getGraph_element()

Method getGraph_element.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

getGraph_elementCollection

public List<Graph_element> getGraph_elementCollection()

Method getGraph_elementCollection.Returns a reference to '_graph_elementList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getGraph_elementCount

public int getGraph_elementCount()

Method getGraph_elementCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateGraph_element

public Iterator<Graph_element> iterateGraph_element()

Method iterateGraph_element.

Returns:

an Iterator over all possible elements in this collection

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

removeAllGraph_element

public void removeAllGraph_element()

removeGraph_element

public boolean removeGraph_element(Graph_element vGraph_element)

Method removeGraph_element.

Parameters:

vGraph_element -

Returns:

true if the object was removed from the collection.

removeGraph_elementAt

public Graph_element removeGraph_elementAt(int index)

Method removeGraph_elementAt.

Parameters:

index -

Returns:

the element removed from the collection

setGraph_element

public void setGraph_element(int index,
                             Graph_element vGraph_element)
                      throws IndexOutOfBoundsException

Parameters:

index -

vGraph_element -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setGraph_element

public void setGraph_element(Graph_element[] vGraph_elementArray)

Parameters:

vGraph_elementArray -

setGraph_element

public void setGraph_element(List<Graph_element> vGraph_elementList)

Sets the value of '_graph_elementList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vGraph_elementList - the Vector to copy.

setGraph_elementCollection

public void setGraph_elementCollection(List<Graph_element> graph_elementList)

Deprecated.

Sets the value of '_graph_elementList' by setting it to the given Vector. No type checking is performed.

Parameters:

graph_elementList - the Vector to set.

unmarshal

public static Graph 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.rrd.Graph

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