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, IMonitoringRecord.Factory

public final class KiekerMetadataRecord
extends AbstractMonitoringRecord
implements IMonitoringRecord.Factory

This records collects metadata for the monitoring session.

Since:

1.7

Author:

Jan Waller

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.common.record.IMonitoringRecord

IMonitoringRecord.Factory

Field Summary

static String	NO_CONTROLLERNAME Constant to be used if no value available.
static String	NO_HOSTNAME Constant to be used if no value available.
static String	NO_TIMESOURCE Constant to be used if no value available.
static String	NO_TIMEUNIT Constant to be used if no value available.

Constructor Summary

KiekerMetadataRecord(Object[] values)
Creates a new instance of this class using the given parameter.

KiekerMetadataRecord(String version, String controllerName, String hostname, int experimentId, boolean debugMode, long timeOffset, String timeUnit, long numberOfRecords)
Creates a new instance of this class.

Method Summary

String	getControllerName()
int	getExperimentId()
String	getHostname()
long	getNumberOfRecords()
long	getTimeOffset()
String	getTimeUnit()
Class<?>[]	getValueTypes() This method should deliver an array with the classes of the single values for the record.
String	getVersion()
void	initFromArray(Object[] values) Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.
boolean	isDebugMode()
Object[]	toArray() This method should deliver an array containing the content of the record.
String	toFormattedString() Converts the current record into a formatted string.

Methods inherited from class kieker.common.record.AbstractMonitoringRecord

checkArray, classForName, compareTo, createFromArray, createFromStringArray, equals, fromStringArrayToTypedArray, getLoggingTimestamp, hashCode, setLoggingTimestamp, toString, typesForClass

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_CONTROLLERNAME

public static final String NO_CONTROLLERNAME

Constant to be used if no value available.

See Also:

Constant Field Values

NO_HOSTNAME

public static final String NO_HOSTNAME

Constant to be used if no value available.

See Also:

Constant Field Values

NO_TIMESOURCE

public static final String NO_TIMESOURCE

Constant to be used if no value available.

See Also:

Constant Field Values

NO_TIMEUNIT

public static final String NO_TIMEUNIT

Constant to be used if no value available.

See Also:

Constant Field Values

Constructor Detail

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.

Parameters:

version - The Kieker version (can be null).

controllerName - The name of the controller (can be null).

hostname - The name of the host (can be null).

experimentId - The experiment ID.

timeUnit - The time unit (can be null).

timeSource - The timesource (can be null).

debugMode - Whether debug mode is enabled or not.

numberOfRecords - The number of records.

KiekerMetadataRecord

public KiekerMetadataRecord(Object[] values)

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

Parameters:

values - The array containing the values for the fields of this class. This should normally be the array resulting in a call to toArray().

Method Detail

toArray

public 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.

getValueTypes

public 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.

See Also:

IMonitoringRecord.toArray()

initFromArray

@Deprecated
public void initFromArray(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.

getVersion

public String getVersion()

getControllerName

public String getControllerName()

getHostname

public String getHostname()

getExperimentId

public int getExperimentId()

isDebugMode

public boolean isDebugMode()

getTimeOffset

public long getTimeOffset()

getTimeUnit

public String getTimeUnit()

getNumberOfRecords

public long getNumberOfRecords()

toFormattedString

public String toFormattedString()

Converts the current record into a formatted string.

Returns:

A formatted string representation of this record.