org.opennms.netmgt.config.kscReports

Class Report

java.lang.Object

org.opennms.netmgt.config.kscReports.Report

All Implemented Interfaces:

Serializable

public class Report
extends Object
implements Serializable

Class Report.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Report()

Method Summary

Methods

Modifier and Type	Method and Description
void	addGraph(Graph vGraph)
void	addGraph(int index, Graph vGraph)
void	deleteGraphs_per_line()
void	deleteId()
void	deleteShow_graphtype_button()
void	deleteShow_timespan_button()
Enumeration<Graph>	enumerateGraph() Method enumerateGraph.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Graph[]	getGraph() Method getGraph.Returns the contents of the collection in an Array.
Graph	getGraph(int index) Method getGraph.
List<Graph>	getGraphCollection() Method getGraphCollection.Returns a reference to '_graphList'.
int	getGraphCount() Method getGraphCount.
int	getGraphs_per_line() Returns the value of field 'graphs_per_line'.
int	getId() Returns the value of field 'id'.
boolean	getShow_graphtype_button() Returns the value of field 'show_graphtype_button'.
boolean	getShow_timespan_button() Returns the value of field 'show_timespan_button'.
String	getTitle() Returns the value of field 'title'.
boolean	hasGraphs_per_line() Method hasGraphs_per_line.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasId() Method hasId.
boolean	hasShow_graphtype_button() Method hasShow_graphtype_button.
boolean	hasShow_timespan_button() Method hasShow_timespan_button.
boolean	isShow_graphtype_button() Returns the value of field 'show_graphtype_button'.
boolean	isShow_timespan_button() Returns the value of field 'show_timespan_button'.
boolean	isValid() Method isValid.
Iterator<Graph>	iterateGraph() Method iterateGraph.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllGraph()
boolean	removeGraph(Graph vGraph) Method removeGraph.
Graph	removeGraphAt(int index) Method removeGraphAt.
void	setGraph(Graph[] vGraphArray)
void	setGraph(int index, Graph vGraph)
void	setGraph(List<Graph> vGraphList) Sets the value of '_graphList' by copying the given Vector.
void	setGraphCollection(List<Graph> graphList) Deprecated.
void	setGraphs_per_line(int graphs_per_line) Sets the value of field 'graphs_per_line'.
void	setId(int id) Sets the value of field 'id'.
void	setShow_graphtype_button(boolean show_graphtype_button) Sets the value of field 'show_graphtype_button'.
void	setShow_timespan_button(boolean show_timespan_button) Sets the value of field 'show_timespan_button'.
void	setTitle(String title) Sets the value of field 'title'.
static Report	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

Report

public Report()

Method Detail

addGraph

public void addGraph(Graph vGraph)
              throws IndexOutOfBoundsException

Parameters:

vGraph -

Throws:

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

addGraph

public void addGraph(int index,
            Graph vGraph)
              throws IndexOutOfBoundsException

Parameters:

index -

vGraph -

Throws:

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

deleteGraphs_per_line

public void deleteGraphs_per_line()

deleteId

public void deleteId()

deleteShow_graphtype_button

public void deleteShow_graphtype_button()

deleteShow_timespan_button

public void deleteShow_timespan_button()

enumerateGraph

public Enumeration<Graph> enumerateGraph()

Method enumerateGraph.

Returns:

an Enumeration over all possible elements of this collection

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.

getGraph

public Graph getGraph(int index)
               throws IndexOutOfBoundsException

Method getGraph.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.kscReports.Graph at the given index

Throws:

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

getGraph

public Graph[] getGraph()

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

getGraphCollection

public List<Graph> getGraphCollection()

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

Returns:

a reference to the Vector backing this class

getGraphCount

public int getGraphCount()

Method getGraphCount.

Returns:

the size of this collection

getGraphs_per_line

public int getGraphs_per_line()

Returns the value of field 'graphs_per_line'.

Returns:

the value of field 'Graphs_per_line'.

getId

public int getId()

Returns the value of field 'id'.

Returns:

the value of field 'Id'.

getShow_graphtype_button

public boolean getShow_graphtype_button()

Returns the value of field 'show_graphtype_button'.

Returns:

the value of field 'Show_graphtype_button'.

getShow_timespan_button

public boolean getShow_timespan_button()

Returns the value of field 'show_timespan_button'.

Returns:

the value of field 'Show_timespan_button'.

getTitle

public String getTitle()

Returns the value of field 'title'.

Returns:

the value of field 'Title'.

hasGraphs_per_line

public boolean hasGraphs_per_line()

Method hasGraphs_per_line.

Returns:

true if at least one Graphs_per_line has been added

hasId

public boolean hasId()

Method hasId.

Returns:

true if at least one Id has been added

hasShow_graphtype_button

public boolean hasShow_graphtype_button()

Method hasShow_graphtype_button.

Returns:

true if at least one Show_graphtype_button has been added

hasShow_timespan_button

public boolean hasShow_timespan_button()

Method hasShow_timespan_button.

Returns:

true if at least one Show_timespan_button has been added

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.

isShow_graphtype_button

public boolean isShow_graphtype_button()

Returns the value of field 'show_graphtype_button'.

Returns:

the value of field 'Show_graphtype_button'.

isShow_timespan_button

public boolean isShow_timespan_button()

Returns the value of field 'show_timespan_button'.

Returns:

the value of field 'Show_timespan_button'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateGraph

public Iterator<Graph> iterateGraph()

Method iterateGraph.

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

public void removeAllGraph()

removeGraph

public boolean removeGraph(Graph vGraph)

Method removeGraph.

Parameters:

vGraph -

Returns:

true if the object was removed from the collection.

removeGraphAt

public Graph removeGraphAt(int index)

Method removeGraphAt.

Parameters:

index -

Returns:

the element removed from the collection

setGraph

public void setGraph(int index,
            Graph vGraph)
              throws IndexOutOfBoundsException

Parameters:

index -

vGraph -

Throws:

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

setGraph

public void setGraph(Graph[] vGraphArray)

Parameters:

vGraphArray -

setGraph

public void setGraph(List<Graph> vGraphList)

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

Parameters:

vGraphList - the Vector to copy.

setGraphCollection

public void setGraphCollection(List<Graph> graphList)

Deprecated.

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

Parameters:

graphList - the Vector to set.

setGraphs_per_line

public void setGraphs_per_line(int graphs_per_line)

Sets the value of field 'graphs_per_line'.

Parameters:

graphs_per_line - the value of field 'graphs_per_line'.

setId

public void setId(int id)

Sets the value of field 'id'.

Parameters:

id - the value of field 'id'.

setShow_graphtype_button

public void setShow_graphtype_button(boolean show_graphtype_button)

Sets the value of field 'show_graphtype_button'.

Parameters:

show_graphtype_button - the value of field 'show_graphtype_button'.

setShow_timespan_button

public void setShow_timespan_button(boolean show_timespan_button)

Sets the value of field 'show_timespan_button'.

Parameters:

show_timespan_button - the value of field 'show_timespan_button'.

setTitle

public void setTitle(String title)

Sets the value of field 'title'.

Parameters:

title - the value of field 'title'.

unmarshal

public static Report 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.kscReports.Report

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