Package org.yamcs.parameterarchive

Class ParameterArchive

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.AbstractYamcsService

org.yamcs.parameterarchive.ParameterArchive

All Implemented Interfaces:

com.google.common.util.concurrent.Service, YamcsService

public class ParameterArchive
extends AbstractYamcsService

The parameter archive stores data in partitions -> intervals -> segments. A partition covers one year and each partition has its own RocksDB database An interval covers 2^23 millisec =~ 139 minutes An segment covers at most maxSegmentSize values for one parameter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParameterArchive.Partition

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field	Description
static long	INTERVAL_MASK
static int	NUMBITS_MASK
static boolean	STORE_RAW_VALUES
static int	TIMESTAMP_MASK

Fields inherited from class org.yamcs.AbstractYamcsService

config, log, serviceName, yamcsInstance

Constructor Summary

Constructors

Constructor	Description
ParameterArchive()

Method Summary

Modifier and Type	Method	Description
ParameterArchive.Partition	createAndGetPartition(long segStart)	get partition for segment, creating it if it doesn't exist
List<ParameterArchive.Partition>	deletePartitions(long start, long stop)	Delete all partitions that overlap with [start, stop) segment.
protected void	doStart()
protected void	doStop()
static long	getIntervalDuration()	duration in milliseconds of one segment
static long	getIntervalEnd(long instant)	returns the end of the interval where the instant fits
static long	getIntervalStart(long instant)	returns the intervalStart where this instant could fit.
org.rocksdb.RocksIterator	getIterator(ParameterArchive.Partition p)
ParameterGroupIdDb	getParameterGroupIdDb()
ParameterIdDb	getParameterIdDb()
TimePartitionSchema	getPartitioningSchema()
List<ParameterArchive.Partition>	getPartitions(long start, long stop, boolean ascending)	a copy of the partitions from start to stop inclusive
Spec	getSpec()	Returns the valid configuration options for this service.
Tablespace	getTablespace()
SortedTimeSegment	getTimeSegment(ParameterArchive.Partition p, long segmentStart, int parameterGroupId)
void	init(String yamcsInstance, String serviceName, YConfiguration config)	Initialize this service.
void	printKeys(PrintStream out)
Future<?>	reprocess(long start, long stop)
void	writeToArchive(long segStart, Collection<PGSegment> pgList)
void	writeToArchive(PGSegment pgs)

Methods inherited from class org.yamcs.AbstractYamcsService

getConfig, getYamcsInstance

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Methods inherited from interface org.yamcs.YamcsService

init

Field Detail

STORE_RAW_VALUES

public static final boolean STORE_RAW_VALUES

See Also:

Constant Field Values

NUMBITS_MASK

public static final int NUMBITS_MASK

See Also:

Constant Field Values

TIMESTAMP_MASK

public static final int TIMESTAMP_MASK

See Also:

Constant Field Values

INTERVAL_MASK

public static final long INTERVAL_MASK

See Also:

Constant Field Values

Constructor Detail

ParameterArchive

public ParameterArchive()

Method Detail

getSpec

public Spec getSpec()

Description copied from interface: YamcsService

Returns the valid configuration options for this service.

Returns:

the argument specification, or null if the args should not be validated.

init

public void init(String yamcsInstance,
                 String serviceName,
                 YConfiguration config)
          throws InitException

Description copied from interface: YamcsService

Initialize this service. This is called before the service is started. All operations should finish fast.

Specified by:

init in interface YamcsService

Overrides:

init in class AbstractYamcsService

Parameters:

yamcsInstance - The yamcs instance, or null if this is a global service.

serviceName - The service name.

config - The configured arguments for this service. If YamcsService.getSpec() is implemented then this contains the arguments after being validated (including any defaults).

Throws:

InitException - When something goes wrong during the execution of this method.

getPartitioningSchema

public TimePartitionSchema getPartitioningSchema()

getParameterIdDb

public ParameterIdDb getParameterIdDb()

getParameterGroupIdDb

public ParameterGroupIdDb getParameterGroupIdDb()

writeToArchive

public void writeToArchive(PGSegment pgs)
                    throws org.rocksdb.RocksDBException,
                           IOException

Throws:

org.rocksdb.RocksDBException

IOException

writeToArchive

public void writeToArchive(long segStart,
                           Collection<PGSegment> pgList)
                    throws org.rocksdb.RocksDBException,
                           IOException

Throws:

org.rocksdb.RocksDBException

IOException

createAndGetPartition

public ParameterArchive.Partition createAndGetPartition(long segStart)
                                                 throws org.rocksdb.RocksDBException

get partition for segment, creating it if it doesn't exist

Parameters:

segStart -

Throws:

org.rocksdb.RocksDBException

reprocess

public Future<?> reprocess(long start,
                           long stop)

getPartitions

public List<ParameterArchive.Partition> getPartitions(long start,
                                                      long stop,
                                                      boolean ascending)

a copy of the partitions from start to stop inclusive

Parameters:

start -

stop -

Returns:

a sorted list of partitions

doStart

protected void doStart()

Specified by:

doStart in class com.google.common.util.concurrent.AbstractService

doStop

protected void doStop()

Specified by:

doStop in class com.google.common.util.concurrent.AbstractService

printKeys

public void printKeys(PrintStream out)
               throws DecodingException,
                      org.rocksdb.RocksDBException,
                      IOException

Throws:

DecodingException

org.rocksdb.RocksDBException

IOException

deletePartitions

public List<ParameterArchive.Partition> deletePartitions(long start,
                                                         long stop)
                                                  throws org.rocksdb.RocksDBException

Delete all partitions that overlap with [start, stop) segment.

Parameters:

start -

stop -

Returns:

all the partitions removed

Throws:

org.rocksdb.RocksDBException

getIterator

public org.rocksdb.RocksIterator getIterator(ParameterArchive.Partition p)
                                      throws org.rocksdb.RocksDBException,
                                             IOException

Throws:

org.rocksdb.RocksDBException

IOException

getTimeSegment

public SortedTimeSegment getTimeSegment(ParameterArchive.Partition p,
                                        long segmentStart,
                                        int parameterGroupId)
                                 throws org.rocksdb.RocksDBException,
                                        IOException

Throws:

org.rocksdb.RocksDBException

IOException

getIntervalStart

public static long getIntervalStart(long instant)

returns the intervalStart where this instant could fit.

Parameters:

instant -

Returns:

getIntervalEnd

public static long getIntervalEnd(long instant)

returns the end of the interval where the instant fits

Parameters:

instant -

Returns:

getIntervalDuration

public static long getIntervalDuration()

duration in milliseconds of one segment

Returns:

getTablespace

public Tablespace getTablespace()