Package cern.nxcals.api.backport.domain.core.timeseriesdata

Interface TimeseriesData

All Superinterfaces:

java.lang.Cloneable, java.lang.Comparable<TimeseriesData>

All Known Implementing Classes:

SparkTimeseriesData

public interface TimeseriesData
extends java.lang.Cloneable, java.lang.Comparable<TimeseriesData>

Method Summary

Modifier and Type	Method	Description
boolean	after(TimeseriesData timeseriesData)
TimeseriesData	alignToTimestamp(java.sql.Timestamp timestamp)
boolean	before(TimeseriesData timeseriesData)
int	compareValueTo(TimeseriesData data)
int[]	dimensions()	Gets the data dimensions of time series data.
java.lang.String	getDestination()	Gets the Varchar value associated with the time series data.
double	getDoubleValue()	Gets the Numeric value associated with the time series data.
double	getDoubleValueAtIndex(int index)	Gets numeric value from the vectornumeric value at the given index.
double[]	getDoubleValues()	Gets the Vector of Numeric values associated with the time series data.
java.lang.String	getFormattedStamp(LoggingTimeZone timeZone)
long	getLongValue()	Gets the Numeric value associated with the time series data.
long	getLongValueAtIndex(int index)	Gets numeric value from the vectornumeric value at the given index.
long[]	getLongValues()	Gets the Vector of Numeric values associated with the time series data.
double[][]	getMatrixDoubleValues()
long[][]	getMatrixLongValues()
java.lang.String	getName()
java.lang.String	getNumericStatus()	Gets the Status associated with the time series data.
java.math.BigDecimal	getNumericValue()	Deprecated. Use getDoubleValue instead
java.math.BigDecimal	getNumericValueAtVectorIndex(int index)	Deprecated. use getDoubleValueAtIndex instead
java.sql.Timestamp	getStamp()	Gets the timestamp of the timeseries data.
java.lang.String	getStringValueAtIndex(int index)
java.lang.String[]	getStringValues()
java.lang.String	getVarcharValue()	Gets the Varchar value associated with the time series data.
VariableDataType	getVariableDataType()
int[]	getVectorIndexes()
int[]	getVectorNumericIndexes()	Deprecated. Use getVectorIndexes instead
java.math.BigDecimal[]	getVectorNumericValues()	Deprecated. use getDoubleValues() instead
boolean	isNullValue()	Checks whether the value is null
boolean	isNullValue(int index)	Checks whether the value is null for a given index (vector numeric types)
java.lang.Boolean	isSubSet()	Indicates if this Timeseries Data is a subset of the actual logged vectornumerioc value as a result of filtering by index or value.
void	print(LoggingTimeZone timezone)
java.lang.String	toStringValue()	Represents the value in a string
java.lang.String	toStringValue(int index)	Gets the string of a value for a given index for a vector numeric type
java.lang.Class<?>	type()	Gets the data type of time series data.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

type

java.lang.Class<?> type()

Gets the data type of time series data.

Returns:

the data type of time series data.

dimensions

int[] dimensions()

Gets the data dimensions of time series data.

Returns:

the data dimensions of time series data.

getVariableDataType

VariableDataType getVariableDataType()

See Also:

TimeseriesDataSet.getVariableDataType()

getNumericStatus

java.lang.String getNumericStatus()
                           throws java.lang.NoSuchMethodException

Gets the Status associated with the time series data.

Returns:

the Status associated with the time series data.

Throws:

java.lang.NoSuchMethodException - - if an attempt is made to retrieve the Status of time series data that does not have a status associated with it i.e. it is not of the relevant datatype.

getNumericValue

@Deprecated
java.math.BigDecimal getNumericValue()
                              throws java.lang.NoSuchMethodException

Deprecated.

Use getDoubleValue instead

Gets the Numeric value associated with the time series data.

Returns:

the Numeric value associated with the time series data.

Throws:

java.lang.NoSuchMethodException - - if an attempt is made to retrieve the Numeric value of time series data that does not have a Numeric Value associated with it i.e. it is not of the relevant datatype.

getDoubleValue

double getDoubleValue()
               throws java.lang.NoSuchMethodException

Gets the Numeric value associated with the time series data.

Returns:

the Numeric value associated with the time series data.

Throws:

java.lang.NoSuchMethodException - - if an attempt is made to retrieve the Numeric value of time series data that does not have a Numeric Value associated with it i.e. it is not of the relevant datatype.

java.lang.ArithmeticException - - In case the implementation is in a long and can't be converted to double, because of precision loss

getLongValue

long getLongValue()
           throws java.lang.NoSuchMethodException

Gets the Numeric value associated with the time series data.

Returns:

the Numeric value associated with the time series data.

Throws:

java.lang.NoSuchMethodException - - if an attempt is made to retrieve the Numeric value of time series data that does not have a Numeric Value associated with it i.e. it is not of the relevant datatype.

java.lang.ArithmeticException - - In case the implementation is in a double and can't be converted to long, because of precision loss

getStamp

java.sql.Timestamp getStamp()

Gets the timestamp of the timeseries data.

Returns:

- the timestamp of the timeseries data.

after

boolean after(TimeseriesData timeseriesData)

before

boolean before(TimeseriesData timeseriesData)

getVarcharValue

java.lang.String getVarcharValue()
                          throws java.lang.NoSuchMethodException

Gets the Varchar value associated with the time series data.

Returns:

the Varchar value associated with the time series data.

Throws:

java.lang.NoSuchMethodException - - if an attempt is made to retrieve the Varchar value of time series data that does not have a Varchar value associated with it i.e. it is not of the relevant datatype.

getDestination

java.lang.String getDestination()
                         throws java.lang.NoSuchMethodException

Gets the Varchar value associated with the time series data.

Returns:

the Varchar value associated with the time series data.

Throws:

java.lang.NoSuchMethodException - - if an attempt is made to retrieve the destination value of time series data that does not have a destination value associated with it i.e. it is not of the fundamental datatype.

getVectorNumericValues

@Deprecated
java.math.BigDecimal[] getVectorNumericValues()
                                       throws java.lang.NoSuchMethodException

Deprecated.

use getDoubleValues() instead

Gets the Vector of Numeric values associated with the time series data.

Returns:

the Vector of Numeric values associated with the time series data.

Throws:

java.lang.NoSuchMethodException - - if an attempt is made to retrieve the Vector of Numeric values of the time series data that does not have a Vector of Numeric values associated with it i.e. it is not of the relevant datatype.

getDoubleValues

double[] getDoubleValues()
                  throws java.lang.NoSuchMethodException

Gets the Vector of Numeric values associated with the time series data.

Returns:

the Vector of Numeric values associated with the time series data.

Throws:

java.lang.NoSuchMethodException - - if an attempt is made to retrieve the Vector of Numeric values of the time series data that does not have a Vector of Numeric values associated with it i.e. it is not of the relevant datatype.

java.lang.ArithmeticException - - In case the implementation is in long and can't be converted to double, because of precision loss

getLongValues

long[] getLongValues()
              throws java.lang.NoSuchMethodException

Gets the Vector of Numeric values associated with the time series data.

Returns:

the Vector of Numeric values associated with the time series data.

Throws:

java.lang.NoSuchMethodException - - if an attempt is made to retrieve the Vector of Numeric values of the time series data that does not have a Vector of Numeric values associated with it i.e. it is not of the relevant datatype.

java.lang.ArithmeticException - - In case the implementation is in a double and can't be converted to long, because of precision loss

getMatrixDoubleValues

double[][] getMatrixDoubleValues()
                          throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

getMatrixLongValues

long[][] getMatrixLongValues()
                      throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

getFormattedStamp

java.lang.String getFormattedStamp(LoggingTimeZone timeZone)

Parameters:

timeZone - - the timezone which should be used to format the timestamp of this data

Returns:

- a String representing the timestamp of this data, formatted according to the given timezone

print

void print(LoggingTimeZone timezone)

getNumericValueAtVectorIndex

@Deprecated
java.math.BigDecimal getNumericValueAtVectorIndex(int index)
                                           throws java.lang.NoSuchMethodException

Deprecated.

use getDoubleValueAtIndex instead

Gets numeric value from the vectornumeric value at the given index.

Returns:

the numeric value from the vectornumeric value at the given index or null if there is no value at the given index.

Throws:

java.lang.NoSuchMethodException

getDoubleValueAtIndex

double getDoubleValueAtIndex(int index)
                      throws java.lang.NoSuchMethodException

Gets numeric value from the vectornumeric value at the given index.

Returns:

the numeric value from the vectornumeric value at the given index or null if there is no value at the given index.

Throws:

java.lang.ArithmeticException - - In case the implementation is in long and can't be converted to double, because of precision loss

java.lang.IndexOutOfBoundsException - - In case the index is not valid

java.lang.NoSuchMethodException

getLongValueAtIndex

long getLongValueAtIndex(int index)
                  throws java.lang.NoSuchMethodException

Gets numeric value from the vectornumeric value at the given index.

Returns:

the numeric value from the vectornumeric value at the given index or null if there is no value at the given index.

Throws:

java.lang.ArithmeticException - - In case the implementation is in a double and can't be converted to long, because of precision loss

java.lang.IndexOutOfBoundsException - - In case the index is not valid

java.lang.NoSuchMethodException

isSubSet

java.lang.Boolean isSubSet()
                    throws java.lang.NoSuchMethodException

Indicates if this Timeseries Data is a subset of the actual logged vectornumerioc value as a result of filtering by index or value.

Returns:

true if this Timeseries Data is a subset of the actual logged vectornumerioc value.

Throws:

java.lang.NoSuchMethodException

getVectorNumericIndexes

@Deprecated
int[] getVectorNumericIndexes()
                       throws java.lang.NoSuchMethodException

Deprecated.

Use getVectorIndexes instead

Gets the array of vectornumeric element indexes. This is useful in the case that this vectornumeric data is a subset of the actual logged vectornumerioc value (as a result of filtering by index or value).

Returns:

the array of vectornumeric element indexes.

Throws:

java.lang.NoSuchMethodException

getVectorIndexes

int[] getVectorIndexes()
                throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

getStringValues

java.lang.String[] getStringValues()
                            throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

getStringValueAtIndex

java.lang.String getStringValueAtIndex(int index)
                                throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

toStringValue

java.lang.String toStringValue()
                        throws java.lang.NoSuchMethodException

Represents the value in a string

Returns:

The value in a string

Throws:

java.lang.NoSuchMethodException

isNullValue

boolean isNullValue()
             throws java.lang.NoSuchMethodException

Checks whether the value is null

Returns:

Throws:

java.lang.NoSuchMethodException

toStringValue

java.lang.String toStringValue(int index)
                        throws java.lang.NoSuchMethodException

Gets the string of a value for a given index for a vector numeric type

Parameters:

index -

Returns:

Throws:

java.lang.NoSuchMethodException

isNullValue

boolean isNullValue(int index)
             throws java.lang.NoSuchMethodException

Checks whether the value is null for a given index (vector numeric types)

Returns:

Throws:

java.lang.NoSuchMethodException

alignToTimestamp

TimeseriesData alignToTimestamp(java.sql.Timestamp timestamp)
                         throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

compareValueTo

int compareValueTo(TimeseriesData data)
            throws java.lang.NoSuchMethodException

Throws:

java.lang.NoSuchMethodException

getName

java.lang.String getName()