Package kieker.common.record.misc

Class KiekerMetadataRecord

java.lang.Object

kieker.common.record.AbstractMonitoringRecord

kieker.common.record.misc.KiekerMetadataRecord

All Implemented Interfaces:

Serializable, Comparable<IMonitoringRecord>, IMonitoringRecord

public class KiekerMetadataRecord
extends AbstractMonitoringRecord

Since:

1.7

Author:

Jan Waller API compatibility: Kieker 1.15.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTROLLER_NAME
static final boolean	DEBUG_MODE
static final int	EXPERIMENT_ID
static final String	HOSTNAME
static final String	NO_CONTROLLERNAME	user-defined constants.
static final String	NO_HOSTNAME
static final String	NO_TIMESOURCE
static final String	NO_TIMEUNIT
static final long	NUMBER_OF_RECORDS
static final int	SIZE	Descriptive definition of the serialization size of the record.
static final long	TIME_OFFSET
static final String	TIME_UNIT
static final Class<?>[]	TYPES
static final String[]	VALUE_NAMES	property name array.
static final String	VERSION	default constants.

Fields inherited from class kieker.common.record.AbstractMonitoringRecord

TYPE_SIZE_BOOLEAN, TYPE_SIZE_BYTE, TYPE_SIZE_CHARACTER, TYPE_SIZE_DOUBLE, TYPE_SIZE_FLOAT, TYPE_SIZE_INT, TYPE_SIZE_LONG, TYPE_SIZE_SHORT, TYPE_SIZE_STRING

Constructor Summary

Constructors

Constructor	Description
KiekerMetadataRecord(String version, String controllerName, String hostname, int experimentId, boolean debugMode, long timeOffset, String timeUnit, long numberOfRecords)	Creates a new instance of this class using the given parameters.
KiekerMetadataRecord(IValueDeserializer deserializer)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Performs a null-check, a this-check, and a class-check.
final String	getControllerName()
final int	getExperimentId()
final String	getHostname()
final long	getNumberOfRecords()
int	getSize()	This method should deliver the size of a binary representation of this record.
final long	getTimeOffset()
final String	getTimeUnit()
String[]	getValueNames()	This method delivers an array containing the value names of the record.
Class<?>[]	getValueTypes()	This method delivers an array with the classes of the single values for the record.
final String	getVersion()
int	hashCode()
final boolean	isDebugMode()
void	serialize(IValueSerializer serializer)	This method serializes this record using the given serializer.
String	toString()	Creates a string representation of this record. This method should not be used for serialization purposes since this is not the purpose of Object's toString method.

Methods inherited from class kieker.common.record.AbstractMonitoringRecord

checkArray, classForName, compareTo, createFromDeserializer, fromStringArrayToTypedArray2, getLoggingTimestamp, isNotEqual, isNotEqual, setLoggingTimestamp, typesForClass

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SIZE

public static final int SIZE

Descriptive definition of the serialization size of the record.

See Also:

• Constant Field Values

TYPES

public static final Class<?>[] TYPES

NO_CONTROLLERNAME

public static final String NO_CONTROLLERNAME

user-defined constants.

See Also:

• Constant Field Values

NO_HOSTNAME

public static final String NO_HOSTNAME

See Also:

• Constant Field Values

NO_TIMESOURCE

public static final String NO_TIMESOURCE

See Also:

• Constant Field Values

NO_TIMEUNIT

public static final String NO_TIMEUNIT

See Also:

• Constant Field Values

VALUE_NAMES

public static final String[] VALUE_NAMES

property name array.

VERSION

public static final String VERSION

default constants.

CONTROLLER_NAME

public static final String CONTROLLER_NAME

See Also:

• Constant Field Values

HOSTNAME

public static final String HOSTNAME

See Also:

• Constant Field Values

EXPERIMENT_ID

public static final int EXPERIMENT_ID

See Also:

• Constant Field Values

DEBUG_MODE

public static final boolean DEBUG_MODE

See Also:

• Constant Field Values

TIME_OFFSET

public static final long TIME_OFFSET

See Also:

• Constant Field Values

TIME_UNIT

public static final String TIME_UNIT

See Also:

• Constant Field Values

NUMBER_OF_RECORDS

public static final long NUMBER_OF_RECORDS

See Also:

• Constant Field Values

Constructor Details

KiekerMetadataRecord

public KiekerMetadataRecord(String version,
 String controllerName,
 String hostname,
 int experimentId,
 boolean debugMode,
 long timeOffset,
 String timeUnit,
 long numberOfRecords)

Creates a new instance of this class using the given parameters.

Parameters:

version - version

controllerName - controllerName

hostname - hostname

experimentId - experimentId

debugMode - debugMode

timeOffset - timeOffset

timeUnit - timeUnit

numberOfRecords - numberOfRecords

KiekerMetadataRecord

public KiekerMetadataRecord(IValueDeserializer deserializer)
                     throws RecordInstantiationException

Parameters:

deserializer - The deserializer to use

Throws:

RecordInstantiationException - when the record could not be deserialized

Method Details

serialize

public void serialize(IValueSerializer serializer)
               throws BufferOverflowException

This method serializes this record using the given serializer.

Parameters:

serializer - The serializer to serialize the record with. *

Throws:

BufferOverflowException - If the underlying buffer has insufficient capacity to store this record

getValueTypes

public Class<?>[] getValueTypes()

This method delivers an array with the classes of the single values for the record.

Returns:

The types of the values. This returned array should be treated readonly.

getValueNames

public String[] getValueNames()

This method delivers an array containing the value names of the record.

Returns:

The types of the values. This returned array should be treated readonly.

getSize

public int getSize()

This method should deliver the size of a binary representation of this record.

Returns:

The size.

equals

public boolean equals(Object obj)

Performs a null-check, a this-check, and a class-check. Moreover, it checks each attribute for equality.

Overrides:

equals in class AbstractMonitoringRecord

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMonitoringRecord

getVersion

public final String getVersion()

getControllerName

public final String getControllerName()

getHostname

public final String getHostname()

getExperimentId

public final int getExperimentId()

isDebugMode

public final boolean isDebugMode()

getTimeOffset

public final long getTimeOffset()

getTimeUnit

public final String getTimeUnit()

getNumberOfRecords

public final long getNumberOfRecords()

toString

public String toString()

Creates a string representation of this record.

This method should not be used for serialization purposes since this is not the purpose of Object's toString method.

Specified by:

toString in interface IMonitoringRecord

Overrides:

toString in class Object

Returns:

A (human readable) string of this record.