org.opennms.newts.api

Interface SampleRepository

public interface SampleRepository

Method Summary

Modifier and Type	Method and Description
void	delete(Context context, Resource resource) Delete stored samples.
void	insert(Collection<Sample> samples) Write (store) samples.
void	insert(Collection<Sample> samples, boolean calculateTimeToLive) Write (store) samples.
Results<Sample>	select(Context context, Resource resource, com.google.common.base.Optional<Timestamp> start, com.google.common.base.Optional<Timestamp> end) Read stored samples.
Results<Measurement>	select(Context context, Resource resource, com.google.common.base.Optional<Timestamp> start, com.google.common.base.Optional<Timestamp> end, ResultDescriptor descriptor, com.google.common.base.Optional<Duration> resolution) Query measurements.
Results<Measurement>	select(Context context, Resource resource, com.google.common.base.Optional<Timestamp> start, com.google.common.base.Optional<Timestamp> end, ResultDescriptor descriptor, com.google.common.base.Optional<Duration> resolution, SampleSelectCallback callback) Query measurements.

Method Detail

select

Results<Measurement> select(Context context,
                            Resource resource,
                            com.google.common.base.Optional<Timestamp> start,
                            com.google.common.base.Optional<Timestamp> end,
                            ResultDescriptor descriptor,
                            com.google.common.base.Optional<Duration> resolution)

Query measurements.

Parameters:

context - context to query

resource - name of the sampled resource

start - query start time (defaults to 24 hours less than end, if absent)

end - query end time (defaults to current time if absent)

descriptor - aggregation descriptor

resolution - temporal resolution of results (defaults to a value resulting in 1-10 measurements, if absent)

Returns:

query results

select

Results<Measurement> select(Context context,
                            Resource resource,
                            com.google.common.base.Optional<Timestamp> start,
                            com.google.common.base.Optional<Timestamp> end,
                            ResultDescriptor descriptor,
                            com.google.common.base.Optional<Duration> resolution,
                            SampleSelectCallback callback)

Query measurements.

Parameters:

context - context to query

resource - name of the sampled resource

start - query start time (defaults to 24 hours less than end, if absent)

end - query end time (defaults to current time if absent)

descriptor - aggregation descriptor

resolution - temporal resolution of results (defaults to a value resulting in 1-10 measurements, if absent)

callback - callback

Returns:

query results

select

Results<Sample> select(Context context,
                       Resource resource,
                       com.google.common.base.Optional<Timestamp> start,
                       com.google.common.base.Optional<Timestamp> end)

Read stored samples.

Parameters:

context - context to query

resource - name of the sampled resource

start - query start time (defaults to 24 hours less than end, if absent)

end - query end time (defaults to current time if absent)

Returns:

query results

insert

void insert(Collection<Sample> samples)

Write (store) samples.

Parameters:

samples - samples to insert

insert

void insert(Collection<Sample> samples,
            boolean calculateTimeToLive)

Write (store) samples.

Parameters:

samples - samples to insert

calculateTimeToLive - true if the effective TTL should be calculated using the sample timestamps

delete

void delete(Context context,
            Resource resource)

Delete stored samples.

Parameters:

context - context to delete from

resource - name of the resource to delete from