org.opennms.netmgt.collection.api

Class AbstractPersister

java.lang.Object

org.opennms.netmgt.collection.support.AbstractCollectionSetVisitor

org.opennms.netmgt.collection.api.AbstractPersister

All Implemented Interfaces:

CollectionSetVisitor, Persister

Direct Known Subclasses:

AbstractEvaluatePersister, BasePersister, NewtsPersister, TcpBasePersister, TimeseriesPersister

public abstract class AbstractPersister
extends AbstractCollectionSetVisitor
implements Persister

Common persister code that performs the following: 1) Determines which attributes should be persisted. A stack is used to keep track of the "persist" flag for resources and groups as they are visited. 2) Delegates the persistence of numeric attributes via PersistOperationBuilder. Subclasses must call setBuilder(org.opennms.netmgt.collection.api.PersistOperationBuilder) with an implementation before any attributes are visited. 3) Delegates the persistence of string attributes via calls to persistStringAttribute(org.opennms.netmgt.model.ResourcePath, java.lang.String, java.lang.String).

Author:

jwhite

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPersister(ServiceParameters params, RrdRepository repository) Constructor for BasePersister.

Method Summary

Modifier and Type	Method and Description
void	commitBuilder() commitBuilder
void	completeAttribute(CollectionAttribute attribute) completeAttribute
void	completeGroup(AttributeGroup group) completeGroup
void	completeResource(CollectionResource resource) completeResource
RrdRepository	getRepository() getRepository
boolean	isIgnorePersist() isIgnorePersist
void	persistNumericAttribute(CollectionAttribute attribute) persistNumericAttribute
void	persistStringAttribute(CollectionAttribute attribute) persistStringAttribute
protected abstract void	persistStringAttribute(ResourcePath path, String key, String value)
boolean	popShouldPersist() popShouldPersist
protected void	pushShouldPersist(AttributeGroup group) pushShouldPersist
void	pushShouldPersist(CollectionAttribute attribute) pushShouldPersist
void	pushShouldPersist(CollectionResource resource) Push CollectionResource instances directly onto the stack without checking top() since they are the top-level resources.
protected void	setBuilder(PersistOperationBuilder builder)
void	setIgnorePersist(boolean ignore) setIgnorePersist
void	setRepository(RrdRepository repository) setRepository
protected boolean	shouldPersist() shouldPersist
void	storeAttribute(CollectionAttribute attribute) storeAttribute
void	visitAttribute(CollectionAttribute attribute) visitAttribute
void	visitGroup(AttributeGroup group) visitGroup
void	visitResource(CollectionResource resource) visitResource

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

completeCollectionSet, visitCollectionSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.netmgt.collection.api.CollectionSetVisitor

completeCollectionSet, visitCollectionSet

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

AbstractPersister

protected AbstractPersister(ServiceParameters params,
                            RrdRepository repository)

Constructor for BasePersister.

Parameters:

params - a ServiceParameters object.

repository - a RrdRepository object.

Method Detail

persistStringAttribute

protected abstract void persistStringAttribute(ResourcePath path,
                                               String key,
                                               String value)
                                        throws PersistException

Throws:

PersistException

commitBuilder

public void commitBuilder()

commitBuilder

completeAttribute

public void completeAttribute(CollectionAttribute attribute)

completeAttribute

Specified by:

completeAttribute in interface CollectionSetVisitor

Overrides:

completeAttribute in class AbstractCollectionSetVisitor

Parameters:

attribute - a org.opennms.netmgt.collection.api.collectd.CollectionAttribute object.

completeGroup

public void completeGroup(AttributeGroup group)

completeGroup

Specified by:

completeGroup in interface CollectionSetVisitor

Overrides:

completeGroup in class AbstractCollectionSetVisitor

Parameters:

group - a org.opennms.netmgt.collectd.AttributeGroup object.

completeResource

public void completeResource(CollectionResource resource)

completeResource

Specified by:

completeResource in interface CollectionSetVisitor

Overrides:

completeResource in class AbstractCollectionSetVisitor

Parameters:

resource - a CollectionResource object.

getRepository

public RrdRepository getRepository()

getRepository

Returns:

a RrdRepository object.

setRepository

public void setRepository(RrdRepository repository)

setRepository

Parameters:

repository - a RrdRepository object.

persistNumericAttribute

public void persistNumericAttribute(CollectionAttribute attribute)

persistNumericAttribute

Specified by:

persistNumericAttribute in interface Persister

Parameters:

attribute - a CollectionAttribute object.

persistStringAttribute

public void persistStringAttribute(CollectionAttribute attribute)

persistStringAttribute

Specified by:

persistStringAttribute in interface Persister

Parameters:

attribute - a CollectionAttribute object.

popShouldPersist

public boolean popShouldPersist()

popShouldPersist

Returns:

a boolean.

pushShouldPersist

public void pushShouldPersist(CollectionAttribute attribute)

pushShouldPersist

Parameters:

attribute - a CollectionAttribute object.

pushShouldPersist

protected void pushShouldPersist(AttributeGroup group)

pushShouldPersist

Parameters:

group - a AttributeGroup object.

pushShouldPersist

public void pushShouldPersist(CollectionResource resource)

Push CollectionResource instances directly onto the stack without checking top() since they are the top-level resources.

Parameters:

resource - a CollectionResource object.

shouldPersist

protected boolean shouldPersist()

shouldPersist

Returns:

a boolean.

storeAttribute

public void storeAttribute(CollectionAttribute attribute)

storeAttribute

Parameters:

attribute - a CollectionAttribute object.

visitAttribute

public void visitAttribute(CollectionAttribute attribute)

visitAttribute

Specified by:

visitAttribute in interface CollectionSetVisitor

Overrides:

visitAttribute in class AbstractCollectionSetVisitor

Parameters:

attribute - a org.opennms.netmgt.collection.api.collectd.CollectionAttribute object.

visitGroup

public void visitGroup(AttributeGroup group)

visitGroup

Specified by:

visitGroup in interface CollectionSetVisitor

Overrides:

visitGroup in class AbstractCollectionSetVisitor

Parameters:

group - a org.opennms.netmgt.collectd.AttributeGroup object.

visitResource

public void visitResource(CollectionResource resource)

visitResource

Specified by:

visitResource in interface CollectionSetVisitor

Overrides:

visitResource in class AbstractCollectionSetVisitor

Parameters:

resource - a CollectionResource object.

isIgnorePersist

public boolean isIgnorePersist()

isIgnorePersist

Returns:

a boolean.

setIgnorePersist

public void setIgnorePersist(boolean ignore)

setIgnorePersist

Parameters:

ignore - a boolean.

setBuilder

protected void setBuilder(PersistOperationBuilder builder)