org.opennms.netmgt.config.rrd

Class Datasources

java.lang.Object

org.opennms.netmgt.config.rrd.Datasources

All Implemented Interfaces:

Serializable

public class Datasources
extends Object
implements Serializable

Class Datasources.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Datasources()

Method Summary

Modifier and Type	Method and Description
void	addDef(Def vDef)
void	addDef(int index, Def vDef)
void	addExport_data(Export_data vExport_data)
void	addExport_data(int index, Export_data vExport_data)
Enumeration<Def>	enumerateDef() Method enumerateDef.
Enumeration<Export_data>	enumerateExport_data() Method enumerateExport_data.
Def[]	getDef() Method getDef.Returns the contents of the collection in an Array.
Def	getDef(int index) Method getDef.
List<Def>	getDefCollection() Method getDefCollection.Returns a reference to '_defList'.
int	getDefCount() Method getDefCount.
Export_data[]	getExport_data() Method getExport_data.Returns the contents of the collection in an Array.
Export_data	getExport_data(int index) Method getExport_data.
List<Export_data>	getExport_dataCollection() Method getExport_dataCollection.Returns a reference to '_export_dataList'.
int	getExport_dataCount() Method getExport_dataCount.
boolean	isValid() Method isValid.
Iterator<Def>	iterateDef() Method iterateDef.
Iterator<Export_data>	iterateExport_data() Method iterateExport_data.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllDef()
void	removeAllExport_data()
boolean	removeDef(Def vDef) Method removeDef.
Def	removeDefAt(int index) Method removeDefAt.
boolean	removeExport_data(Export_data vExport_data) Method removeExport_data.
Export_data	removeExport_dataAt(int index) Method removeExport_dataAt.
void	setDef(Def[] vDefArray)
void	setDef(int index, Def vDef)
void	setDef(List<Def> vDefList) Sets the value of '_defList' by copying the given Vector.
void	setDefCollection(List<Def> defList) Deprecated.
void	setExport_data(Export_data[] vExport_dataArray)
void	setExport_data(int index, Export_data vExport_data)
void	setExport_data(List<Export_data> vExport_dataList) Sets the value of '_export_dataList' by copying the given Vector.
void	setExport_dataCollection(List<Export_data> export_dataList) Deprecated.
static Datasources	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

Datasources

public Datasources()

Method Detail

addDef

public void addDef(Def vDef)
            throws IndexOutOfBoundsException

Parameters:

vDef -

Throws:

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

addDef

public void addDef(int index,
                   Def vDef)
            throws IndexOutOfBoundsException

Parameters:

index -

vDef -

Throws:

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

addExport_data

public void addExport_data(Export_data vExport_data)
                    throws IndexOutOfBoundsException

Parameters:

vExport_data -

Throws:

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

addExport_data

public void addExport_data(int index,
                           Export_data vExport_data)
                    throws IndexOutOfBoundsException

Parameters:

index -

vExport_data -

Throws:

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

enumerateDef

public Enumeration<Def> enumerateDef()

Method enumerateDef.

Returns:

an Enumeration over all possible elements of this collection

enumerateExport_data

public Enumeration<Export_data> enumerateExport_data()

Method enumerateExport_data.

Returns:

an Enumeration over all possible elements of this collection

getDef

public Def getDef(int index)
           throws IndexOutOfBoundsException

Method getDef.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.rrd.Def at the given index

Throws:

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

getDef

public Def[] getDef()

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

getDefCollection

public List<Def> getDefCollection()

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

Returns:

a reference to the Vector backing this class

getDefCount

public int getDefCount()

Method getDefCount.

Returns:

the size of this collection

getExport_data

public Export_data getExport_data(int index)
                           throws IndexOutOfBoundsException

Method getExport_data.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.rrd.Export_data at the given index

Throws:

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

getExport_data

public Export_data[] getExport_data()

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

getExport_dataCollection

public List<Export_data> getExport_dataCollection()

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

Returns:

a reference to the Vector backing this class

getExport_dataCount

public int getExport_dataCount()

Method getExport_dataCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateDef

public Iterator<Def> iterateDef()

Method iterateDef.

Returns:

an Iterator over all possible elements in this collection

iterateExport_data

public Iterator<Export_data> iterateExport_data()

Method iterateExport_data.

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

removeAllDef

public void removeAllDef()

removeAllExport_data

public void removeAllExport_data()

removeDef

public boolean removeDef(Def vDef)

Method removeDef.

Parameters:

vDef -

Returns:

true if the object was removed from the collection.

removeDefAt

public Def removeDefAt(int index)

Method removeDefAt.

Parameters:

index -

Returns:

the element removed from the collection

removeExport_data

public boolean removeExport_data(Export_data vExport_data)

Method removeExport_data.

Parameters:

vExport_data -

Returns:

true if the object was removed from the collection.

removeExport_dataAt

public Export_data removeExport_dataAt(int index)

Method removeExport_dataAt.

Parameters:

index -

Returns:

the element removed from the collection

setDef

public void setDef(int index,
                   Def vDef)
            throws IndexOutOfBoundsException

Parameters:

index -

vDef -

Throws:

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

setDef

public void setDef(Def[] vDefArray)

Parameters:

vDefArray -

setDef

public void setDef(List<Def> vDefList)

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

Parameters:

vDefList - the Vector to copy.

setDefCollection

public void setDefCollection(List<Def> defList)

Deprecated.

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

Parameters:

defList - the Vector to set.

setExport_data

public void setExport_data(int index,
                           Export_data vExport_data)
                    throws IndexOutOfBoundsException

Parameters:

index -

vExport_data -

Throws:

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

setExport_data

public void setExport_data(Export_data[] vExport_dataArray)

Parameters:

vExport_dataArray -

setExport_data

public void setExport_data(List<Export_data> vExport_dataList)

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

Parameters:

vExport_dataList - the Vector to copy.

setExport_dataCollection

public void setExport_dataCollection(List<Export_data> export_dataList)

Deprecated.

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

Parameters:

export_dataList - the Vector to set.

unmarshal

public static Datasources 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.Datasources

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