org.opennms.netmgt.collection.support

Class SingleResourceCollectionSet

java.lang.Object

org.opennms.netmgt.collection.support.AbstractCollectionSet

org.opennms.netmgt.collection.support.SingleResourceCollectionSet

All Implemented Interfaces:

CollectionSet, CollectionVisitable

public class SingleResourceCollectionSet
extends AbstractCollectionSet

This is a simple CollectionSet that is used to encapsulate the collection of a single resource. The status is initially set to CollectionConstants#COLLECTION_FAILED. It is up to the collector to set it to a different value upon collection completion.

Constructor Summary

Constructors

Constructor and Description
SingleResourceCollectionSet(CollectionResource resource, Date timestamp)

Method Summary

Methods

Modifier and Type	Method and Description
CollectionResource	getCollectionResource()
Date	getCollectionTimestamp() Returns the timestamp of when this data collection was taken.
int	getStatus() getStatus
void	setStatus(int status)
void	visit(CollectionSetVisitor visitor) Provide a way to visit all the values in the CollectionSet, for any appropriate purposes (persisting, thresholding, or others) The expectation is that calling this method will ultimately call visitResource, visitGroup and visitAttribute (as appropriate)

Methods inherited from class org.opennms.netmgt.collection.support.AbstractCollectionSet

ignorePersist

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleResourceCollectionSet

public SingleResourceCollectionSet(CollectionResource resource,
                           Date timestamp)

Method Detail

getStatus

public final int getStatus()

Description copied from interface: CollectionSet

getStatus

Returns:

an int (one of the ServiceCollector.COLLECTION_ values)

setStatus

public final void setStatus(int status)

getCollectionResource

public final CollectionResource getCollectionResource()

visit

public final void visit(CollectionSetVisitor visitor)

Description copied from interface: CollectionVisitable

Provide a way to visit all the values in the CollectionSet, for any appropriate purposes (persisting, thresholding, or others) The expectation is that calling this method will ultimately call visitResource, visitGroup and visitAttribute (as appropriate)

Parameters:

visitor - a CollectionSetVisitor object.

getCollectionTimestamp

public final Date getCollectionTimestamp()

Description copied from interface: CollectionSet

Returns the timestamp of when this data collection was taken. Used by thresholding.

Returns: