Kieker 1.12

kieker.common.record.misc
Class KiekerMetadataRecord

java.lang.Object
  extended by kieker.common.record.AbstractMonitoringRecord
      extended by kieker.common.record.misc.KiekerMetadataRecord
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<IMonitoringRecord>, IMonitoringRecord, IMonitoringRecord.BinaryFactory, IMonitoringRecord.Factory

public class KiekerMetadataRecord
extends AbstractMonitoringRecord
implements IMonitoringRecord.Factory, IMonitoringRecord.BinaryFactory

Since:
1.7
Author:
Jan Waller
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface kieker.common.record.IMonitoringRecord
IMonitoringRecord.BinaryFactory, IMonitoringRecord.Factory
 
Field Summary
static java.lang.String CONTROLLER_NAME
           
static boolean DEBUG_MODE
           
static int EXPERIMENT_ID
           
static java.lang.String HOSTNAME
           
static java.lang.String NO_CONTROLLERNAME
           
static java.lang.String NO_HOSTNAME
           
static java.lang.String NO_TIMESOURCE
           
static java.lang.String NO_TIMEUNIT
           
static long NUMBER_OF_RECORDS
           
static int SIZE
          Descriptive definition of the serialization size of the record.
static long TIME_OFFSET
           
static java.lang.String TIME_UNIT
           
static java.lang.Class<?>[] TYPES
           
static java.lang.String VERSION
           
 
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
  KiekerMetadataRecord(java.nio.ByteBuffer buffer, IRegistry<java.lang.String> stringRegistry)
          This constructor converts the given array into a record.
  KiekerMetadataRecord(java.lang.Object[] values)
          This constructor converts the given array into a record.
protected KiekerMetadataRecord(java.lang.Object[] values, java.lang.Class<?>[] valueTypes)
          This constructor uses the given array to initialize the fields of this record.
  KiekerMetadataRecord(java.lang.String version, java.lang.String controllerName, java.lang.String hostname, int experimentId, boolean debugMode, long timeOffset, java.lang.String timeUnit, long numberOfRecords)
          Creates a new instance of this class using the given parameters.
 
Method Summary
 java.lang.String getControllerName()
           
 int getExperimentId()
           
 java.lang.String getHostname()
           
 long getNumberOfRecords()
           
 int getSize()
          This method should deliver the size of a binary representation of this record.
 long getTimeOffset()
           
 java.lang.String getTimeUnit()
           
 java.lang.Class<?>[] getValueTypes()
          This method should deliver an array with the classes of the single values for the record.
 java.lang.String getVersion()
           
 void initFromArray(java.lang.Object[] values)
          Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.
 void initFromBytes(java.nio.ByteBuffer buffer, IRegistry<java.lang.String> stringRegistry)
          Deprecated. This record uses the IMonitoringRecord.BinaryFactory mechanism. Hence, this method is not implemented.
 boolean isDebugMode()
           
 void registerStrings(IRegistry<java.lang.String> stringRegistry)
          Registers the string attributes of the record at the given stringRegistry.
 java.lang.Object[] toArray()
          This method should deliver an array containing the content of the record.
 void writeBytes(java.nio.ByteBuffer buffer, IRegistry<java.lang.String> stringRegistry)
          This method should deliver an byte array containing the content of the record.
 
Methods inherited from class kieker.common.record.AbstractMonitoringRecord
checkArray, classForName, compareTo, createFromArray, createFromArray, createFromByteBuffer, createFromByteBuffer, createFromStringArray, equals, fromStringArrayToTypedArray, getLoggingTimestamp, hashCode, setLoggingTimestamp, toString, typesForClass
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SIZE

public static final int SIZE
Descriptive definition of the serialization size of the record.

See Also:
Constant Field Values

TYPES

public static final java.lang.Class<?>[] TYPES

NO_CONTROLLERNAME

public static final java.lang.String NO_CONTROLLERNAME
See Also:
Constant Field Values

NO_HOSTNAME

public static final java.lang.String NO_HOSTNAME
See Also:
Constant Field Values

NO_TIMESOURCE

public static final java.lang.String NO_TIMESOURCE
See Also:
Constant Field Values

NO_TIMEUNIT

public static final java.lang.String NO_TIMEUNIT
See Also:
Constant Field Values

VERSION

public static final java.lang.String VERSION
See Also:
Constant Field Values

CONTROLLER_NAME

public static final java.lang.String CONTROLLER_NAME
See Also:
Constant Field Values

HOSTNAME

public static final java.lang.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 java.lang.String TIME_UNIT
See Also:
Constant Field Values

NUMBER_OF_RECORDS

public static final long NUMBER_OF_RECORDS
See Also:
Constant Field Values
Constructor Detail

KiekerMetadataRecord

public KiekerMetadataRecord(java.lang.String version,
                            java.lang.String controllerName,
                            java.lang.String hostname,
                            int experimentId,
                            boolean debugMode,
                            long timeOffset,
                            java.lang.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(java.lang.Object[] values)
This constructor converts the given array into a record. It is recommended to use the array which is the result of a call to toArray().

Parameters:
values - The values for the record.

KiekerMetadataRecord

protected KiekerMetadataRecord(java.lang.Object[] values,
                               java.lang.Class<?>[] valueTypes)
This constructor uses the given array to initialize the fields of this record.

Parameters:
values - The values for the record.
valueTypes - The types of the elements in the first array.

KiekerMetadataRecord

public KiekerMetadataRecord(java.nio.ByteBuffer buffer,
                            IRegistry<java.lang.String> stringRegistry)
                     throws java.nio.BufferUnderflowException
This constructor converts the given array into a record.

Parameters:
buffer - The bytes for the record.
Throws:
java.nio.BufferUnderflowException - if buffer not sufficient
Method Detail

toArray

public java.lang.Object[] toArray()
This method should deliver an array containing the content of the record. It should be possible to convert this array later into a record again.

Specified by:
toArray in interface IMonitoringRecord
Returns:
An array with the values of the record.

registerStrings

public void registerStrings(IRegistry<java.lang.String> stringRegistry)
Registers the string attributes of the record at the given stringRegistry.

Specified by:
registerStrings in interface IMonitoringRecord
Overrides:
registerStrings in class AbstractMonitoringRecord

writeBytes

public void writeBytes(java.nio.ByteBuffer buffer,
                       IRegistry<java.lang.String> stringRegistry)
                throws java.nio.BufferOverflowException
This method should deliver an byte array containing the content of the record. It should be possible to convert this array later into a record again.

Specified by:
writeBytes in interface IMonitoringRecord
Parameters:
buffer - The used ByteBuffer with sufficient capacity
stringRegistry - Usually the associated MonitoringController
Throws:
java.nio.BufferOverflowException - if buffer not sufficient

getValueTypes

public java.lang.Class<?>[] getValueTypes()
This method should deliver an array with the classes of the single values for the record.

Specified by:
getValueTypes in interface IMonitoringRecord
Returns:
The types of the values. This returned array should be treated readonly.
See Also:
IMonitoringRecord.toArray()

getSize

public int getSize()
This method should deliver the size of a binary representation of this record.

Specified by:
getSize in interface IMonitoringRecord
Returns:
The size.

initFromArray

@Deprecated
public void initFromArray(java.lang.Object[] values)
Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.

This method should initialize the record based on the given values. The array should be one of those resulting from a call to IMonitoringRecord.toArray().

Specified by:
initFromArray in interface IMonitoringRecord
Parameters:
values - The values for the record.

initFromBytes

@Deprecated
public void initFromBytes(java.nio.ByteBuffer buffer,
                                     IRegistry<java.lang.String> stringRegistry)
                   throws java.nio.BufferUnderflowException
Deprecated. This record uses the IMonitoringRecord.BinaryFactory mechanism. Hence, this method is not implemented.

This method should initialize the record based on the given values. The array should be one of those resulting from a call to IMonitoringRecord.writeBytes(ByteBuffer, IRegistry).

Specified by:
initFromBytes in interface IMonitoringRecord
Parameters:
buffer - The bytes for the record.
stringRegistry - The Registry storing the strings.
Throws:
java.nio.BufferUnderflowException - if buffer not sufficient

getVersion

public final java.lang.String getVersion()

getControllerName

public final java.lang.String getControllerName()

getHostname

public final java.lang.String getHostname()

getExperimentId

public final int getExperimentId()

isDebugMode

public final boolean isDebugMode()

getTimeOffset

public final long getTimeOffset()

getTimeUnit

public final java.lang.String getTimeUnit()

getNumberOfRecords

public final long getNumberOfRecords()

Kieker 1.12

Copyright 2015 Kieker Project, http://kieker-monitoring.net